Delete List of Interactions by URIs

The Delete Interactions API deletes the interactions by Uniform Resource Identifier (URI) as specified in the body of the request.

The maximum number of URI in one batch is 150.

Request

POST /{TenantId}/interactions/_deleteByUris

To delete specific interactions listed by URIs, use the parameters listed in Table 1: Parameters to Delete Specified Interactions List by URIs.

Table 1. Parameters to Delete Specified Interactions List by URIs
Parameter Type	Parameter Name	Required	Details
Headers	Authorization	Yes	Provides information about authentication access token in `Bearer` <`accessToken`> format. For more information, see Authentication API.
Query	mode	No	Use this parameter to specify a type of delete operations. It can be set to `hard` or `soft`. The default value is `soft`.
Body	-	Yes	This parameter is a JSON array of interaction URIs. The maximum number of interaction URI is 150.

Response

A JSON object that represents the result of operation.

For more information, see Table 2: Operation Result.

Table 2. Operation Result
Name	Details	Type
status	Possible values: success error	String
details	Optional: If the status displays an `error`, it includes the error messages for the delete operation, that has failed.	JSON Array of Strings

The following examples explain the JSON object representing the operation result.

Examples

Example: Success

{  
         "status": "success" 
         }

Example: Error

{  
          "status": "error", 
          "details": [ 
              "Code: INTERNAL_SERVER_ERROR; Unable to read the object:
            [interactions/Reltio+888458313626]" 
    ]
}

Example: Request


    POST {TenantURL}/interactions/_deleteByUris
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512

[
    "interactions/Reltio+888458313626",
    "interactions/Reltio+896502267803",
    "interactions/Reltio+896502759323"
]

Example: Response


{
    "status": "success"
}

Accelerate the Value of Data

Delete List of Interactions by URIs

Request

Response

Footer