API reference (20230101-alpha)
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/raw/dbs/{dbName}/tables/{tableName}/cursors \
--header 'Authorization: Bearer <token>'{
"items": [
"<string>"
]
}Retrieve cursors for parallel reads
Required capabilities:
rawAcl:READ
Retrieve cursors based on the last updated time range. Normally this endpoint is used for reading in parallel.
Each cursor should be supplied as the ‘cursor’ query parameter on GET requests to Read Rows. Note that the ‘minLastUpdatedTime’ and the ‘maxLastUpdatedTime’ query parameter on Read Rows are ignored when a cursor is specified.
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/raw/dbs/{dbName}/tables/{tableName}/cursors \
--header 'Authorization: Bearer <token>'{
"items": [
"<string>"
]
}Authorizations
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.
Query Parameters
An exclusive filter, specified as the number of milliseconds that have elapsed since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
An inclusive filter, specified as the number of milliseconds that have elapsed since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of cursors to return, by default it's 10.
1 <= x <= 10000Response
Response with cursors
A list of cursors
Was this page helpful?