curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 123
}
]
}
'{
"items": [
{
"dataSetId": 123,
"id": 123,
"simulatorExternalId": "<string>",
"simulatorIntegrationExternalId": "<string>",
"modelExternalId": "<string>",
"modelRevisionExternalId": "<string>",
"routineExternalId": "<string>",
"routineRevisionExternalId": "<string>",
"status": "ready",
"runType": "external",
"userId": "<string>",
"logId": 123,
"createdTime": 123,
"lastUpdatedTime": 123,
"runTime": 123,
"simulationTime": 123,
"statusMessage": "<string>"
}
]
}Retrieve a simulation run by ID.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 123
}
]
}
'{
"items": [
{
"dataSetId": 123,
"id": 123,
"simulatorExternalId": "<string>",
"simulatorIntegrationExternalId": "<string>",
"modelExternalId": "<string>",
"modelRevisionExternalId": "<string>",
"routineExternalId": "<string>",
"routineRevisionExternalId": "<string>",
"status": "ready",
"runType": "external",
"userId": "<string>",
"logId": 123,
"createdTime": 123,
"lastUpdatedTime": 123,
"runTime": 123,
"simulationTime": 123,
"statusMessage": "<string>"
}
]
}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.
A list with a single item
Show child attributes
Successful Response
Show child attributes
Was this page helpful?