Sync Integration History

Required capabilities: integrationsAcl:READ

Retrieve task history and errors for a specific integration. This endpoint will always return a cursor. If moreData is false, you should wait a bit before calling this endpoint again.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
externalId
required
string (Integration External Id)

Return task histories and errors belonging to a specific integration.

taskName
string (TaskName)

Return task histories and errors belonging to a specific task.

includeErrors
boolean (IncludeErrors)

If true, include errors in the response. One of this and includeTaskHistory must be true.

includeTaskUpdates
boolean (IncludeTaskUpdates)

If true, include task history in the response. One of this and includeErrors must be true.

startTime
integer (StartTime)

The earliest date by which to filter the task history.

limit
integer [ 1 .. 100 ]
Default: 100

Limits the number of results to be returned. The maximum results returned by the server is 100 even if you specify a higher limit.

cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
Responses
200

List of task histories and errors, with a cursor.

400

The response for a bad request.

422

Request validation failed.

get/integrations/sync
Request samples 
Response samples 
application/json
{
  • "nextCursor": "string",
  • "moreData": true,
  • "history": [
    • {
      }
    ],
  • "errors": [
    • {
      }
    ]
}
➔ Next to Update Integrations