Sync signals

Required capabilities: subscribeSignalsAcl:READ

Retrieve signals for a sink incrementally. Unlike the list endpoint, the returned cursor is persistent and can be stored and reused later to fetch only signals that arrived after the previous sync. The response always includes a nextCursor, and moreData indicates whether more signals are immediately available.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
header Parameters
cdf-version
string

cdf version header. Use this to specify the requested CDF release.

Example: alpha
Request Body schema: application/json
required

Sync request for signals.

required
EmailSinkId (object) or UserSinkId (object) or CurrentUserSinkId (object) (RefSinkId)
cursor
string

Cursor returned by a previous sync request. Omit to start syncing from the beginning. Unlike list cursors, sync cursors are persistent and may be stored and reused later.

limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of signals to return.

Responses
200

A list of signals, a cursor for the next sync, and a flag indicating whether more data is available.

400

The response for a bad request.

422

Validation Error

post/processes/signals/sync
Request samples
application/json
{
  • "sink": {
    • "type": "email",
    • "externalId": "my.known.id"
    },
  • "cursor": "string",
  • "limit": 100
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string",
  • "moreData": true
}
➔ Next to Update sinks