New: build custom CDF applications with Cognite Flows. Documentation · What's new.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/revisions/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"routineExternalIds": [
"<string>"
],
"allVersions": false,
"modelExternalIds": [
"<string>"
],
"simulatorIntegrationExternalIds": [
"<string>"
],
"simulatorExternalIds": [
"<string>"
],
"createdTime": {
"max": 1,
"min": 1
},
"kind": "long"
},
"limit": 10,
"cursor": "<string>",
"sort": [
{
"order": "asc",
"property": "createdTime"
}
],
"includeAllFields": false
}
'{
"items": [
{
"dataSetId": 123,
"id": 123,
"externalId": "<string>",
"simulatorExternalId": "<string>",
"routineExternalId": "<string>",
"modelExternalId": "<string>",
"createdByUserId": "<string>",
"versionNumber": 123,
"createdTime": 123,
"configuration": {
"schedule": {
"enabled": false
},
"dataSampling": {
"enabled": false
},
"logicalCheck": [
{
"enabled": true,
"timeseriesExternalId": "<string>",
"aggregate": "average",
"operator": "eq",
"value": 123
}
],
"steadyStateDetection": [
{
"enabled": true,
"aggregate": "average",
"minSectionSize": 123,
"varThreshold": 123,
"slopeThreshold": 123,
"timeseriesExternalId": "<string>"
}
],
"inputs": [],
"outputs": []
},
"script": [
{
"order": 5,
"steps": [
{
"order": 5000,
"stepType": "Get",
"arguments": {
"referenceId": "<string>"
},
"description": "<string>"
}
],
"description": "<string>"
}
],
"simulatorIntegrationExternalId": "<string>",
"kind": "long"
}
],
"nextCursor": "<string>"
}Retrieves a list of simulator routine revisions that match the given criteria.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/routines/revisions/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"routineExternalIds": [
"<string>"
],
"allVersions": false,
"modelExternalIds": [
"<string>"
],
"simulatorIntegrationExternalIds": [
"<string>"
],
"simulatorExternalIds": [
"<string>"
],
"createdTime": {
"max": 1,
"min": 1
},
"kind": "long"
},
"limit": 10,
"cursor": "<string>",
"sort": [
{
"order": "asc",
"property": "createdTime"
}
],
"includeAllFields": false
}
'{
"items": [
{
"dataSetId": 123,
"id": 123,
"externalId": "<string>",
"simulatorExternalId": "<string>",
"routineExternalId": "<string>",
"modelExternalId": "<string>",
"createdByUserId": "<string>",
"versionNumber": 123,
"createdTime": 123,
"configuration": {
"schedule": {
"enabled": false
},
"dataSampling": {
"enabled": false
},
"logicalCheck": [
{
"enabled": true,
"timeseriesExternalId": "<string>",
"aggregate": "average",
"operator": "eq",
"value": 123
}
],
"steadyStateDetection": [
{
"enabled": true,
"aggregate": "average",
"minSectionSize": 123,
"varThreshold": 123,
"slopeThreshold": 123,
"timeseriesExternalId": "<string>"
}
],
"inputs": [],
"outputs": []
},
"script": [
{
"order": 5,
"steps": [
{
"order": 5000,
"stepType": "Get",
"arguments": {
"referenceId": "<string>"
},
"description": "<string>"
}
],
"description": "<string>"
}
],
"simulatorIntegrationExternalId": "<string>",
"kind": "long"
}
],
"nextCursor": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
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.
Show child attributes
1 <= x <= 20Cursor for pagination
Only supports sorting by one property at a time
Show child attributes
If all fields should be included in the response. Defaults to false which does not include script, configuration.inputs and configuration.outputs in the response. If true - all fields are returned, but routines with kind 'long' will be excluded from the results.
Was this page helpful?