Skip to main content
POST
Python SDK

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Scopes

https://{cluster}.cognitedata.com/.default
oidc-token
https://{cluster}.cognitedata.com/.default
oauth2-client-credentials
https://api.cognitedata.com/.default
oauth2-open-industrial-data
https://{cluster}.cognitedata.com/.default
oauth2-auth-code

Body

application/json

Change filter specification

with
object
required
select
object
required
cursors
object

Cursors returned from the previous sync request. These cursors match the result set expressions you specified in the with clause for the sync.

parameters
object

Parameters to return

includeTyping
boolean
default:false

Should we return property type information as part of the result?

allowExpiredCursorsAndAcceptMissedDeletes
boolean
default:false

Sync cursors will expire after 3 days. This is because soft-deleted instances are cleaned up after this grace period, so a client using a cursor older than that risks missing deletes. If this option is set to true, the API will allow the use of expired cursors.

allowPartialResponse
boolean
default:false

By default, every returned batch is full until the sync cursor is caught up to the latest instances (except between phases in two-phase sync). If this flag is true, allow returning non-full batches, or even empty batches, before the cursor is caught up. This can help to avoid timeouts if the cursor falls behind. Consult cursorCaughtUp in the sync response for information as to whether there is actually more data available by following the sync cursor immediately.

debug
object

Return query debug notices.

Response

Matching nodes and edges

items
object
required
nextCursor
object
required
typing
object

Property type information for selected result expressions.

debug
object

Contains debug notices if debug flag is set in the query.

cursorCaughtUp
object

For each result expression, flags whether the sync cursor is caught up.