Clear Internal Queue
Use this API to clear all internal Salesforce Connector events for corresponding tenant and profile.
Request:
DELETE {SFDCConnectorURL}/configuration/{tenant}/{profile}/clearQueue/{direction}?deleteInProcessEvents=false
The following table lists the parameters required for making this API request:
Parameter | Required | Description | |
---|---|---|---|
Headers | Authorization |
Yes | Access Token in format "Bearer
(see details in
Authentication API) |
Content-Type |
Yes | Must be "
|
|
Path | tenantId | Yes | The name of the tenant for which the internal queue must be cleared. |
Path | profile | Yes | The profile for which the internal queue must be cleared. |
Path | direction | Yes | The direction for which the internal queue must be cleared. The value can be syncToSalesforce or syncToReltio . At present, this parameter supports only syncToSalesforce as you can use the Package to sync to Reltio. |
Query | deleteInProcessEvents | No | You can specify whether the events that are already in the processing state must be removed or not. The parameter can be set to true or false . The default value is false . |
Response:
If the request is successful, the response information contains the code as "Success: 200", with errors or warnings, as applicable. If the request is not formed properly, the response information contains "Error: 400 Bad Request".
Success: 200 status:
{
{
"status": "User USER Complete EventStore clear for tenant+profile",
"result": {
"ConnectorEvents": {
"fieldCount": 0,
"affectedRows": 0,
"insertId": 0,
"serverStatus": 2,
"warningCount": 0,
"message": "",
"protocol41": true,
"changedRows": 0
}
}
}
Error: 400 Bad Request, {
"errors": [],
"warnings": []
}