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/runs/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"status": "queued",
"runType": "external",
"simulatorIntegrationExternalIds": [
"<string>"
],
"simulatorExternalIds": [
"<string>"
],
"modelExternalIds": [
"<string>"
],
"routineExternalIds": [
"<string>"
],
"routineRevisionExternalIds": [
"<string>"
],
"modelRevisionExternalIds": [
"<string>"
],
"createdTime": {
"max": 1,
"min": 1
},
"simulationTime": {
"max": 1,
"min": 1
}
},
"limit": 1000,
"cursor": "<string>",
"sort": [
{
"order": "asc",
"property": "createdTime"
}
]
}
'{
"items": [
{
"dataSetId": 123,
"id": 123,
"simulatorExternalId": "<string>",
"modelExternalId": "<string>",
"modelRevisionExternalId": "<string>",
"routineExternalId": "<string>",
"routineRevisionExternalId": "<string>",
"status": "queued",
"runType": "external",
"userId": "<string>",
"logId": 123,
"createdTime": 123,
"lastUpdatedTime": 123,
"simulatorIntegrationExternalId": "<string>",
"runTime": 123,
"simulationTime": 123,
"statusMessage": "<string>"
}
],
"nextCursor": "<string>"
}Retrieves a list of simulation runs that match the given criteria.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"status": "queued",
"runType": "external",
"simulatorIntegrationExternalIds": [
"<string>"
],
"simulatorExternalIds": [
"<string>"
],
"modelExternalIds": [
"<string>"
],
"routineExternalIds": [
"<string>"
],
"routineRevisionExternalIds": [
"<string>"
],
"modelRevisionExternalIds": [
"<string>"
],
"createdTime": {
"max": 1,
"min": 1
},
"simulationTime": {
"max": 1,
"min": 1
}
},
"limit": 1000,
"cursor": "<string>",
"sort": [
{
"order": "asc",
"property": "createdTime"
}
]
}
'{
"items": [
{
"dataSetId": 123,
"id": 123,
"simulatorExternalId": "<string>",
"modelExternalId": "<string>",
"modelRevisionExternalId": "<string>",
"routineExternalId": "<string>",
"routineRevisionExternalId": "<string>",
"status": "queued",
"runType": "external",
"userId": "<string>",
"logId": 123,
"createdTime": 123,
"lastUpdatedTime": 123,
"simulatorIntegrationExternalId": "<string>",
"runTime": 123,
"simulationTime": 123,
"statusMessage": "<string>"
}
],
"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 <= 1000Cursor for pagination
Only supports sorting by one property at a time
Show child attributes
Was this page helpful?