Filter Simulation Runs
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": {
"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"
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list"
payload = {
"filter": {
"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"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
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'}]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list"
payload := strings.NewReader("{\n \"filter\": {\n \"simulatorIntegrationExternalIds\": [\n \"<string>\"\n ],\n \"simulatorExternalIds\": [\n \"<string>\"\n ],\n \"modelExternalIds\": [\n \"<string>\"\n ],\n \"routineExternalIds\": [\n \"<string>\"\n ],\n \"routineRevisionExternalIds\": [\n \"<string>\"\n ],\n \"modelRevisionExternalIds\": [\n \"<string>\"\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"simulationTime\": {\n \"max\": 1,\n \"min\": 1\n }\n },\n \"limit\": 1000,\n \"cursor\": \"<string>\",\n \"sort\": [\n {\n \"order\": \"asc\",\n \"property\": \"createdTime\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"simulatorIntegrationExternalIds\": [\n \"<string>\"\n ],\n \"simulatorExternalIds\": [\n \"<string>\"\n ],\n \"modelExternalIds\": [\n \"<string>\"\n ],\n \"routineExternalIds\": [\n \"<string>\"\n ],\n \"routineRevisionExternalIds\": [\n \"<string>\"\n ],\n \"modelRevisionExternalIds\": [\n \"<string>\"\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"simulationTime\": {\n \"max\": 1,\n \"min\": 1\n }\n },\n \"limit\": 1000,\n \"cursor\": \"<string>\",\n \"sort\": [\n {\n \"order\": \"asc\",\n \"property\": \"createdTime\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"simulatorIntegrationExternalIds\": [\n \"<string>\"\n ],\n \"simulatorExternalIds\": [\n \"<string>\"\n ],\n \"modelExternalIds\": [\n \"<string>\"\n ],\n \"routineExternalIds\": [\n \"<string>\"\n ],\n \"routineRevisionExternalIds\": [\n \"<string>\"\n ],\n \"modelRevisionExternalIds\": [\n \"<string>\"\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"simulationTime\": {\n \"max\": 1,\n \"min\": 1\n }\n },\n \"limit\": 1000,\n \"cursor\": \"<string>\",\n \"sort\": [\n {\n \"order\": \"asc\",\n \"property\": \"createdTime\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"dataSetId": 123,
"id": 123,
"simulatorExternalId": "<string>",
"modelExternalId": "<string>",
"modelRevisionExternalId": "<string>",
"routineExternalId": "<string>",
"routineRevisionExternalId": "<string>",
"userId": "<string>",
"logId": 123,
"createdTime": 123,
"lastUpdatedTime": 123,
"simulatorIntegrationExternalId": "<string>",
"runTime": 123,
"simulationTime": 123,
"leasedUntilTime": 123,
"statusMessage": "<string>"
}
],
"nextCursor": "<string>"
}{
"error": {
"message": "<string>",
"code": 123
}
}{
"error": {
"message": "<string>",
"code": 123
}
}{
"error": {
"message": "<string>",
"code": 123
}
}Filter Simulation Runs
Retrieves a list of simulation runs that match the given criteria.
POST
/
simulators
/
runs
/
list
Filter Simulation Runs
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": {
"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"
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list"
payload = {
"filter": {
"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"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
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'}]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list"
payload := strings.NewReader("{\n \"filter\": {\n \"simulatorIntegrationExternalIds\": [\n \"<string>\"\n ],\n \"simulatorExternalIds\": [\n \"<string>\"\n ],\n \"modelExternalIds\": [\n \"<string>\"\n ],\n \"routineExternalIds\": [\n \"<string>\"\n ],\n \"routineRevisionExternalIds\": [\n \"<string>\"\n ],\n \"modelRevisionExternalIds\": [\n \"<string>\"\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"simulationTime\": {\n \"max\": 1,\n \"min\": 1\n }\n },\n \"limit\": 1000,\n \"cursor\": \"<string>\",\n \"sort\": [\n {\n \"order\": \"asc\",\n \"property\": \"createdTime\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"simulatorIntegrationExternalIds\": [\n \"<string>\"\n ],\n \"simulatorExternalIds\": [\n \"<string>\"\n ],\n \"modelExternalIds\": [\n \"<string>\"\n ],\n \"routineExternalIds\": [\n \"<string>\"\n ],\n \"routineRevisionExternalIds\": [\n \"<string>\"\n ],\n \"modelRevisionExternalIds\": [\n \"<string>\"\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"simulationTime\": {\n \"max\": 1,\n \"min\": 1\n }\n },\n \"limit\": 1000,\n \"cursor\": \"<string>\",\n \"sort\": [\n {\n \"order\": \"asc\",\n \"property\": \"createdTime\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/simulators/runs/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"simulatorIntegrationExternalIds\": [\n \"<string>\"\n ],\n \"simulatorExternalIds\": [\n \"<string>\"\n ],\n \"modelExternalIds\": [\n \"<string>\"\n ],\n \"routineExternalIds\": [\n \"<string>\"\n ],\n \"routineRevisionExternalIds\": [\n \"<string>\"\n ],\n \"modelRevisionExternalIds\": [\n \"<string>\"\n ],\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"simulationTime\": {\n \"max\": 1,\n \"min\": 1\n }\n },\n \"limit\": 1000,\n \"cursor\": \"<string>\",\n \"sort\": [\n {\n \"order\": \"asc\",\n \"property\": \"createdTime\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"dataSetId": 123,
"id": 123,
"simulatorExternalId": "<string>",
"modelExternalId": "<string>",
"modelRevisionExternalId": "<string>",
"routineExternalId": "<string>",
"routineRevisionExternalId": "<string>",
"userId": "<string>",
"logId": 123,
"createdTime": 123,
"lastUpdatedTime": 123,
"simulatorIntegrationExternalId": "<string>",
"runTime": 123,
"simulationTime": 123,
"leasedUntilTime": 123,
"statusMessage": "<string>"
}
],
"nextCursor": "<string>"
}{
"error": {
"message": "<string>",
"code": 123
}
}{
"error": {
"message": "<string>",
"code": 123
}
}{
"error": {
"message": "<string>",
"code": 123
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
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.
Body
application/json
Show child attributes
Show child attributes
Required range:
1 <= x <= 1000Cursor for pagination
Only supports sorting by one property at a time
- SortByCreatedTime
- SortBySimulationTime
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I