Chilkat Online Tools

PureBasic / Cognite API v1 / Filter 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": "velit reprehenderit id deserunt",
    ;     "externalIdPrefix": "nostrud incididunt sint aliquip",
    ;     "metadata": {},
    ;     "assetIds": [
    ;       5295434090357810,
    ;       2310505827163538
    ;     ],
    ;     "rootAssetIds": [
    ;       6293934114666394,
    ;       1520557351372486
    ;     ],
    ;     "assetSubtreeIds": [
    ;       {
    ;         "externalId": "aute irure exercitation id officia"
    ;       },
    ;       {
    ;         "id": 2979756892505052
    ;       }
    ;     ],
    ;     "createdTime": {
    ;       "max": 67205762,
    ;       "min": 42063152
    ;     },
    ;     "lastUpdatedTime": {
    ;       "max": 48288157,
    ;       "min": 93771532
    ;     },
    ;     "dataSetIds": [
    ;       {
    ;         "id": 4906538857069064
    ;       },
    ;       {
    ;         "externalId": "irure"
    ;       }
    ;     ]
    ;   },
    ;   "limit": 100,
    ;   "cursor": "laborum non ipsum",
    ;   "partition": "magna consectetu"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"filter.name","velit reprehenderit id deserunt")
    CkJsonObject::ckUpdateString(json,"filter.externalIdPrefix","nostrud incididunt sint aliquip")
    CkJsonObject::ckUpdateNewObject(json,"filter.metadata")
    CkJsonObject::ckUpdateInt(json,"filter.assetIds[0]",5295434090357810)
    CkJsonObject::ckUpdateInt(json,"filter.assetIds[1]",2310505827163538)
    CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[0]",6293934114666394)
    CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[1]",1520557351372486)
    CkJsonObject::ckUpdateString(json,"filter.assetSubtreeIds[0].externalId","aute irure exercitation id officia")
    CkJsonObject::ckUpdateInt(json,"filter.assetSubtreeIds[1].id",123)
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.max",67205762)
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.min",42063152)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.max",48288157)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.min",93771532)
    CkJsonObject::ckUpdateInt(json,"filter.dataSetIds[0].id",123)
    CkJsonObject::ckUpdateString(json,"filter.dataSetIds[1].externalId","irure")
    CkJsonObject::ckUpdateInt(json,"limit",100)
    CkJsonObject::ckUpdateString(json,"cursor","laborum non ipsum")
    CkJsonObject::ckUpdateString(json,"partition","magna consectetu")

    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/list","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": "velit reprehenderit id deserunt",
        "externalIdPrefix": "nostrud incididunt sint aliquip",
        "metadata": {},
        "assetIds": [
            5295434090357810,
            2310505827163538
        ],
        "rootAssetIds": [
            6293934114666394,
            1520557351372486
        ],
        "assetSubtreeIds": [
            {
                "externalId": "aute irure exercitation id officia"
            },
            {
                "id": 2979756892505052
            }
        ],
        "createdTime": {
            "max": 67205762,
            "min": 42063152
        },
        "lastUpdatedTime": {
            "max": 48288157,
            "min": 93771532
        },
        "dataSetIds": [
            {
                "id": 4906538857069064
            },
            {
                "externalId": "irure"
            }
        ]
    },
    "limit": 100,
    "cursor": "laborum non ipsum",
    "partition": "magna consectetu"
}'
https://domain.com/api/v1/projects/{{project}}/sequences/list

Postman Collection Item JSON

{
  "id": "advancedListSequences",
  "name": "Filter sequences",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "sequences",
        "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": "Retrieves a list of sequences matching the given criteria.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"velit reprehenderit id deserunt\",\n        \"externalIdPrefix\": \"nostrud incididunt sint aliquip\",\n        \"metadata\": {},\n        \"assetIds\": [\n            5295434090357810,\n            2310505827163538\n        ],\n        \"rootAssetIds\": [\n            6293934114666394,\n            1520557351372486\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"externalId\": \"aute irure exercitation id officia\"\n            },\n            {\n                \"id\": 2979756892505052\n            }\n        ],\n        \"createdTime\": {\n            \"max\": 67205762,\n            \"min\": 42063152\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 48288157,\n            \"min\": 93771532\n        },\n        \"dataSetIds\": [\n            {\n                \"id\": 4906538857069064\n            },\n            {\n                \"externalId\": \"irure\"\n            }\n        ]\n    },\n    \"limit\": 100,\n    \"cursor\": \"laborum non ipsum\",\n    \"partition\": \"magna consectetu\"\n}"
    }
  }
}