Chilkat Online Tools

PureBasic / Cognite API v1 / Filter data sets

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": {
    ;     "metadata": {},
    ;     "createdTime": {
    ;       "max": 86900022,
    ;       "min": 66884903
    ;     },
    ;     "lastUpdatedTime": {
    ;       "max": 89375182,
    ;       "min": 70845959
    ;     },
    ;     "externalIdPrefix": "nisi in",
    ;     "writeProtected": false
    ;   },
    ;   "limit": 100,
    ;   "cursor": "quis"
    ; }

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

    CkJsonObject::ckUpdateNewObject(json,"filter.metadata")
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.max",86900022)
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.min",66884903)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.max",89375182)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.min",70845959)
    CkJsonObject::ckUpdateString(json,"filter.externalIdPrefix","nisi in")
    CkJsonObject::ckUpdateBool(json,"filter.writeProtected",0)
    CkJsonObject::ckUpdateInt(json,"limit",100)
    CkJsonObject::ckUpdateString(json,"cursor","quis")

    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}}/datasets/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": {
        "metadata": {},
        "createdTime": {
            "max": 86900022,
            "min": 66884903
        },
        "lastUpdatedTime": {
            "max": 89375182,
            "min": 70845959
        },
        "externalIdPrefix": "nisi in",
        "writeProtected": false
    },
    "limit": 100,
    "cursor": "quis"
}'
https://domain.com/api/v1/projects/{{project}}/datasets/list

Postman Collection Item JSON

{
  "id": "listDataSets",
  "name": "Filter data sets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "datasets",
        "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": "Use advanced filtering options to find data sets.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"metadata\": {},\n        \"createdTime\": {\n            \"max\": 86900022,\n            \"min\": 66884903\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 89375182,\n            \"min\": 70845959\n        },\n        \"externalIdPrefix\": \"nisi in\",\n        \"writeProtected\": false\n    },\n    \"limit\": 100,\n    \"cursor\": \"quis\"\n}"
    }
  }
}