Chilkat Online Tools

DataFlex / Cognite API v1 / Filter data sets

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // 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"
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateNewObject Of hoJson "filter.metadata" To iSuccess
    Get ComUpdateInt Of hoJson "filter.createdTime.max" 86900022 To iSuccess
    Get ComUpdateInt Of hoJson "filter.createdTime.min" 66884903 To iSuccess
    Get ComUpdateInt Of hoJson "filter.lastUpdatedTime.max" 89375182 To iSuccess
    Get ComUpdateInt Of hoJson "filter.lastUpdatedTime.min" 70845959 To iSuccess
    Get ComUpdateString Of hoJson "filter.externalIdPrefix" "nisi in" To iSuccess
    Get ComUpdateBool Of hoJson "filter.writeProtected" False To iSuccess
    Get ComUpdateInt Of hoJson "limit" 100 To iSuccess
    Get ComUpdateString Of hoJson "cursor" "quis" To iSuccess

    Send ComSetRequestHeader To hoHttp "content-type" "application/json"
    Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://domain.com/api/v1/projects/{{project}}/datasets/list" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1
    Send Destroy of hoResp


End_Procedure

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}"
    }
  }
}