Chilkat Online Tools

PureBasic / Cognite API v1 / Filter transformations

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": {
    ;     "isPublic": true,
    ;     "nameRegex": "voluptate irure aute",
    ;     "queryRegex": "fugiat dolor",
    ;     "destinationType": "dolore velit irure dolor",
    ;     "conflictMode": "id officia labore nostrud dolor",
    ;     "hasBlockedError": false,
    ;     "cdfProjectName": "in Ut",
    ;     "createdTime": {
    ;       "min": 47433915,
    ;       "max": 13086787
    ;     },
    ;     "lastUpdatedTime": {
    ;       "min": 36390643,
    ;       "max": -75267076
    ;     }
    ;   },
    ;   "limit": -29037401,
    ;   "cursor": "aute magna"
    ; }

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

    CkJsonObject::ckUpdateBool(json,"filter.isPublic",1)
    CkJsonObject::ckUpdateString(json,"filter.nameRegex","voluptate irure aute")
    CkJsonObject::ckUpdateString(json,"filter.queryRegex","fugiat dolor")
    CkJsonObject::ckUpdateString(json,"filter.destinationType","dolore velit irure dolor")
    CkJsonObject::ckUpdateString(json,"filter.conflictMode","id officia labore nostrud dolor")
    CkJsonObject::ckUpdateBool(json,"filter.hasBlockedError",0)
    CkJsonObject::ckUpdateString(json,"filter.cdfProjectName","in Ut")
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.min",47433915)
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.max",13086787)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.min",36390643)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.max",-75267076)
    CkJsonObject::ckUpdateInt(json,"limit",-29037401)
    CkJsonObject::ckUpdateString(json,"cursor","aute magna")

    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}}/transformations/filter","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": {
        "isPublic": true,
        "nameRegex": "voluptate irure aute",
        "queryRegex": "fugiat dolor",
        "destinationType": "dolore velit irure dolor",
        "conflictMode": "id officia labore nostrud dolor",
        "hasBlockedError": false,
        "cdfProjectName": "in Ut",
        "createdTime": {
            "min": 47433915,
            "max": 13086787
        },
        "lastUpdatedTime": {
            "min": 36390643,
            "max": -75267076
        }
    },
    "limit": -29037401,
    "cursor": "aute magna"
}'
https://domain.com/api/v1/projects/{{project}}/transformations/filter

Postman Collection Item JSON

{
  "id": "filterTransformations",
  "name": "Filter transformations",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "transformations",
        "filter"
      ],
      "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": "Filter transformations. Use nextCursor to paginate through the results.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"isPublic\": true,\n        \"nameRegex\": \"voluptate irure aute\",\n        \"queryRegex\": \"fugiat dolor\",\n        \"destinationType\": \"dolore velit irure dolor\",\n        \"conflictMode\": \"id officia labore nostrud dolor\",\n        \"hasBlockedError\": false,\n        \"cdfProjectName\": \"in Ut\",\n        \"createdTime\": {\n            \"min\": 47433915,\n            \"max\": 13086787\n        },\n        \"lastUpdatedTime\": {\n            \"min\": 36390643,\n            \"max\": -75267076\n        }\n    },\n    \"limit\": -29037401,\n    \"cursor\": \"aute magna\"\n}"
    }
  }
}