List Errors for a Synapse
Lists errors based on the request parameter errorType. There are two types of errors supported: syncError and synapseError. The samples here are for errorType = syncError. For errorType = synapseError, the only request parameter allowed is errorType and it will return a subset of data with just synapse and error information. All records will be returned and there is no need for a cursor.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the API is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Query Parameters
| Name | Type | Required | Notes |
| endTime | string |
End of the range of records to return |
|
| startTime | string |
Start of the range of records to return |
|
| errorType | string |
Type of error records to return Allowed values:
syncError|synapseError
|
|
| cursorToken | string |
Use the value from last response to get the next set of records |
|
| limit | integer |
Limit the number of the records to be returned |
|
| operation | string |
Type of error records to return Allowed values:
Create|Update|Delete|Disconnect|Merge
|
|
| synapseName | string |
Return only records with this synapse name |
|
| syncariEntityName | string |
Return only records with this syncari entity name |
|
| syncariRecordId |
string |
Return the single record with this record id |
Example
Request Sample
curl --request POST --url https://api.syncari.com/api/v1/instances \
--header 'Accept: application/json' \
--header 'Authorization: FTON46895FBIl' \
--header 'Content-Type: application/json' \
--header 'clientRequestId: 123456789' \
--header 'syncariId: VBKIUF'
Response Sample
{
"success": true,
"requestId": "5506204008",
"timestamp": "2022-08-05T06:50:54.367984Z",
"cursorToken": "MQ==",
"result": [
{
"errorType": "syncError",
"synapseId": "62d59b11f826460001fc8860",
"synapseName": "salesforce",
"syncariEntityName": "Account__c1",
"externalEntityName": "Account",
"syncariRecordId": "62e046877ddb3f00012148d5",
"operation": "update",
"error": "HD MS 2: bad value for restricted picklist field: [football, rugby]",
"errorDetail": "HD MS 2: bad value for restricted picklist field: [football, rugby]",
"occurredAt": "2022-07-26T19:54:51Z"
}
]
}