TCL / Cognite API v1 / Filter relationships
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "filter": {
# "sourceExternalIds": [
# "culpa esse veniam nisi",
# "commodo repr"
# ],
# "sourceTypes": [
# "timeSeries",
# "sequence"
# ],
# "targetExternalIds": [
# "exercitation",
# "enim culpa"
# ],
# "targetTypes": [
# "sequence",
# "timeSeries"
# ],
# "dataSetIds": [
# {
# "id": 6853944784929184
# },
# {
# "externalId": "aliquip non"
# }
# ],
# "startTime": {
# "max": 15446345,
# "min": 52529591
# },
# "endTime": {
# "max": 94684273,
# "min": 31959617
# },
# "confidence": {
# "min": 62943472.11126715,
# "max": 33071678.92549883
# },
# "lastUpdatedTime": {
# "max": 64148230,
# "min": 15602664
# },
# "createdTime": {
# "max": 99622074,
# "min": 32696551
# },
# "activeAtTime": {
# "max": 99890540,
# "min": 14084932
# },
# "labels": {
# "containsAny": [
# {
# "externalId": "et Lorem cupidatat amet"
# },
# {
# "externalId": "aliqua"
# }
# ]
# },
# "sourcesOrTargets": [
# {
# "type": "sequence",
# "externalId": "consequat id"
# }
# ]
# },
# "limit": 100,
# "cursor": "non do Excepteur dolor",
# "fetchResources": false,
# "partition": "laborum id ad cupidatat et"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "filter.sourceExternalIds[0]" "culpa esse veniam nisi"
CkJsonObject_UpdateString $json "filter.sourceExternalIds[1]" "commodo repr"
CkJsonObject_UpdateString $json "filter.sourceTypes[0]" "timeSeries"
CkJsonObject_UpdateString $json "filter.sourceTypes[1]" "sequence"
CkJsonObject_UpdateString $json "filter.targetExternalIds[0]" "exercitation"
CkJsonObject_UpdateString $json "filter.targetExternalIds[1]" "enim culpa"
CkJsonObject_UpdateString $json "filter.targetTypes[0]" "sequence"
CkJsonObject_UpdateString $json "filter.targetTypes[1]" "timeSeries"
CkJsonObject_UpdateInt $json "filter.dataSetIds[0].id" 123
CkJsonObject_UpdateString $json "filter.dataSetIds[1].externalId" "aliquip non"
CkJsonObject_UpdateInt $json "filter.startTime.max" 15446345
CkJsonObject_UpdateInt $json "filter.startTime.min" 52529591
CkJsonObject_UpdateInt $json "filter.endTime.max" 94684273
CkJsonObject_UpdateInt $json "filter.endTime.min" 31959617
CkJsonObject_UpdateNumber $json "filter.confidence.min" "62943472.11126715"
CkJsonObject_UpdateNumber $json "filter.confidence.max" "33071678.92549883"
CkJsonObject_UpdateInt $json "filter.lastUpdatedTime.max" 64148230
CkJsonObject_UpdateInt $json "filter.lastUpdatedTime.min" 15602664
CkJsonObject_UpdateInt $json "filter.createdTime.max" 99622074
CkJsonObject_UpdateInt $json "filter.createdTime.min" 32696551
CkJsonObject_UpdateInt $json "filter.activeAtTime.max" 99890540
CkJsonObject_UpdateInt $json "filter.activeAtTime.min" 14084932
CkJsonObject_UpdateString $json "filter.labels.containsAny[0].externalId" "et Lorem cupidatat amet"
CkJsonObject_UpdateString $json "filter.labels.containsAny[1].externalId" "aliqua"
CkJsonObject_UpdateString $json "filter.sourcesOrTargets[0].type" "sequence"
CkJsonObject_UpdateString $json "filter.sourcesOrTargets[0].externalId" "consequat id"
CkJsonObject_UpdateInt $json "limit" 100
CkJsonObject_UpdateString $json "cursor" "non do Excepteur dolor"
CkJsonObject_UpdateBool $json "fetchResources" 0
CkJsonObject_UpdateString $json "partition" "laborum id ad cupidatat et"
CkHttp_SetRequestHeader $http "content-type" "application/json"
CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/v1/projects/{{project}}/relationships/list" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"filter": {
"sourceExternalIds": [
"culpa esse veniam nisi",
"commodo repr"
],
"sourceTypes": [
"timeSeries",
"sequence"
],
"targetExternalIds": [
"exercitation",
"enim culpa"
],
"targetTypes": [
"sequence",
"timeSeries"
],
"dataSetIds": [
{
"id": 6853944784929184
},
{
"externalId": "aliquip non"
}
],
"startTime": {
"max": 15446345,
"min": 52529591
},
"endTime": {
"max": 94684273,
"min": 31959617
},
"confidence": {
"min": 62943472.11126715,
"max": 33071678.92549883
},
"lastUpdatedTime": {
"max": 64148230,
"min": 15602664
},
"createdTime": {
"max": 99622074,
"min": 32696551
},
"activeAtTime": {
"max": 99890540,
"min": 14084932
},
"labels": {
"containsAny": [
{
"externalId": "et Lorem cupidatat amet"
},
{
"externalId": "aliqua"
}
]
},
"sourcesOrTargets": [
{
"type": "sequence",
"externalId": "consequat id"
}
]
},
"limit": 100,
"cursor": "non do Excepteur dolor",
"fetchResources": false,
"partition": "laborum id ad cupidatat et"
}'
https://domain.com/api/v1/projects/{{project}}/relationships/list
Postman Collection Item JSON
{
"id": "listRelationships",
"name": "Filter relationships",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"relationships",
"list"
],
"query": [
],
"variable": [
]
},
"method": "POST",
"header": [
{
"key": "api-key",
"value": "{{api-key}}",
"description": "An admin can create API keys in the Cognite console."
},
{
"key": "content-type",
"value": "application/json"
}
],
"description": "Lists relationships matching the query filter in the request. You can retrieve a maximum of 1000 relationships per request.",
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"sourceExternalIds\": [\n \"culpa esse veniam nisi\",\n \"commodo repr\"\n ],\n \"sourceTypes\": [\n \"timeSeries\",\n \"sequence\"\n ],\n \"targetExternalIds\": [\n \"exercitation\",\n \"enim culpa\"\n ],\n \"targetTypes\": [\n \"sequence\",\n \"timeSeries\"\n ],\n \"dataSetIds\": [\n {\n \"id\": 6853944784929184\n },\n {\n \"externalId\": \"aliquip non\"\n }\n ],\n \"startTime\": {\n \"max\": 15446345,\n \"min\": 52529591\n },\n \"endTime\": {\n \"max\": 94684273,\n \"min\": 31959617\n },\n \"confidence\": {\n \"min\": 62943472.11126715,\n \"max\": 33071678.92549883\n },\n \"lastUpdatedTime\": {\n \"max\": 64148230,\n \"min\": 15602664\n },\n \"createdTime\": {\n \"max\": 99622074,\n \"min\": 32696551\n },\n \"activeAtTime\": {\n \"max\": 99890540,\n \"min\": 14084932\n },\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"et Lorem cupidatat amet\"\n },\n {\n \"externalId\": \"aliqua\"\n }\n ]\n },\n \"sourcesOrTargets\": [\n {\n \"type\": \"sequence\",\n \"externalId\": \"consequat id\"\n }\n ]\n },\n \"limit\": 100,\n \"cursor\": \"non do Excepteur dolor\",\n \"fetchResources\": false,\n \"partition\": \"laborum id ad cupidatat et\"\n}"
}
}
}
