PureBasic / Cognite API v1 / Search sequences
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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": {
; "name": "commodo non nulla aute",
; "externalIdPrefix": "commodo qui cupidatat",
; "metadata": {},
; "assetIds": [
; 4769293985777598,
; 5785768360784284
; ],
; "rootAssetIds": [
; 1096264439313816,
; 4922424346728832
; ],
; "assetSubtreeIds": [
; {
; "externalId": "exercitation pariatur id in"
; },
; {
; "id": 22443661565144
; }
; ],
; "createdTime": {
; "max": 14384577,
; "min": 60974975
; },
; "lastUpdatedTime": {
; "max": 83207483,
; "min": 43920599
; },
; "dataSetIds": [
; {
; "externalId": "voluptate e"
; },
; {
; "externalId": "laboris"
; }
; ]
; },
; "search": {
; "name": "non culpa irure velit consequat",
; "description": "id eiusmod",
; "query": "ad"
; },
; "limit": 100
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"filter.name","commodo non nulla aute")
CkJsonObject::ckUpdateString(json,"filter.externalIdPrefix","commodo qui cupidatat")
CkJsonObject::ckUpdateNewObject(json,"filter.metadata")
CkJsonObject::ckUpdateInt(json,"filter.assetIds[0]",4769293985777598)
CkJsonObject::ckUpdateInt(json,"filter.assetIds[1]",5785768360784284)
CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[0]",1096264439313816)
CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[1]",4922424346728832)
CkJsonObject::ckUpdateString(json,"filter.assetSubtreeIds[0].externalId","exercitation pariatur id in")
CkJsonObject::ckUpdateInt(json,"filter.assetSubtreeIds[1].id",123)
CkJsonObject::ckUpdateInt(json,"filter.createdTime.max",14384577)
CkJsonObject::ckUpdateInt(json,"filter.createdTime.min",60974975)
CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.max",83207483)
CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.min",43920599)
CkJsonObject::ckUpdateString(json,"filter.dataSetIds[0].externalId","voluptate e")
CkJsonObject::ckUpdateString(json,"filter.dataSetIds[1].externalId","laboris")
CkJsonObject::ckUpdateString(json,"search.name","non culpa irure velit consequat")
CkJsonObject::ckUpdateString(json,"search.description","id eiusmod")
CkJsonObject::ckUpdateString(json,"search.query","ad")
CkJsonObject::ckUpdateInt(json,"limit",100)
CkHttp::ckSetRequestHeader(http,"content-type","application/json")
CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/projects/{{project}}/sequences/search","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"filter": {
"name": "commodo non nulla aute",
"externalIdPrefix": "commodo qui cupidatat",
"metadata": {},
"assetIds": [
4769293985777598,
5785768360784284
],
"rootAssetIds": [
1096264439313816,
4922424346728832
],
"assetSubtreeIds": [
{
"externalId": "exercitation pariatur id in"
},
{
"id": 22443661565144
}
],
"createdTime": {
"max": 14384577,
"min": 60974975
},
"lastUpdatedTime": {
"max": 83207483,
"min": 43920599
},
"dataSetIds": [
{
"externalId": "voluptate e"
},
{
"externalId": "laboris"
}
]
},
"search": {
"name": "non culpa irure velit consequat",
"description": "id eiusmod",
"query": "ad"
},
"limit": 100
}'
https://domain.com/api/v1/projects/{{project}}/sequences/search
Postman Collection Item JSON
{
"id": "searchSequences",
"name": "Search sequences",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"sequences",
"search"
],
"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": "Retrieves a list of sequences matching the given criteria. This operation does not support pagination.",
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"name\": \"commodo non nulla aute\",\n \"externalIdPrefix\": \"commodo qui cupidatat\",\n \"metadata\": {},\n \"assetIds\": [\n 4769293985777598,\n 5785768360784284\n ],\n \"rootAssetIds\": [\n 1096264439313816,\n 4922424346728832\n ],\n \"assetSubtreeIds\": [\n {\n \"externalId\": \"exercitation pariatur id in\"\n },\n {\n \"id\": 22443661565144\n }\n ],\n \"createdTime\": {\n \"max\": 14384577,\n \"min\": 60974975\n },\n \"lastUpdatedTime\": {\n \"max\": 83207483,\n \"min\": 43920599\n },\n \"dataSetIds\": [\n {\n \"externalId\": \"voluptate e\"\n },\n {\n \"externalId\": \"laboris\"\n }\n ]\n },\n \"search\": {\n \"name\": \"non culpa irure velit consequat\",\n \"description\": \"id eiusmod\",\n \"query\": \"ad\"\n },\n \"limit\": 100\n}"
}
}
}