Check in

Required capabilities: integrationsAcl:USE

Check in with the integrations service. This endpoint is called periodically by extractors to signal that they are still alive, and report any events that may have happened since the last check in.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Extractor status update.

externalId
required
string (IntegrationsExternalId) [ 1 .. 255 ] characters

The external ID provided by the client. Must be unique for the resource type.

Array of objects (TaskUpdate)

A list of task updates.

Array of objects (ErrorWithTask)

A list of errors that occurred since the last checkin.

Responses
200

Response with updates for the extractor.

400

Response for a failed request

422

Request validation failed.

post/integrations/checkin
Request samples
application/json
{
  • "externalId": "my.integrations.id",
  • "taskEvents": [
    • {
      }
    ],
  • "errors": [
    • {
      }
    ]
}
Response samples
application/json
{
  • "externalId": "my.integrations.id",
  • "lastConfigRevision": 0
}
➔ Next to Create config revision.