Chilkat Online Tools

PureBasic / Cognite API v1 / Filter all events

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": {
    ;     "startTime": {
    ;       "max": 96423541,
    ;       "min": 708508
    ;     },
    ;     "endTime": {
    ;       "isNull": false
    ;     },
    ;     "activeAtTime": {
    ;       "max": 42601793,
    ;       "min": 6545191
    ;     },
    ;     "metadata": {},
    ;     "assetIds": [
    ;       5846331094676668,
    ;       3408965310215146
    ;     ],
    ;     "assetExternalIds": [
    ;       "deserunt aliquip Ut occaecat in",
    ;       "non o"
    ;     ],
    ;     "rootAssetIds": [
    ;       {
    ;         "externalId": "veniam commodo minim Duis ut"
    ;       },
    ;       {
    ;         "id": 2472341704760768
    ;       }
    ;     ],
    ;     "assetSubtreeIds": [
    ;       {
    ;         "id": 6194248735806298
    ;       },
    ;       {
    ;         "externalId": "adipisicing"
    ;       }
    ;     ],
    ;     "dataSetIds": [
    ;       {
    ;         "externalId": "commodo nisi"
    ;       },
    ;       {
    ;         "id": 4778982098206896
    ;       }
    ;     ],
    ;     "source": "incididunt",
    ;     "type": "in occaecat",
    ;     "subtype": "dolore minim ipsum",
    ;     "createdTime": {
    ;       "max": 75538890,
    ;       "min": 51111895
    ;     },
    ;     "lastUpdatedTime": {
    ;       "max": 31243942,
    ;       "min": 56817666
    ;     },
    ;     "externalIdPrefix": "cillum"
    ;   },
    ;   "limit": 100,
    ;   "sort": [
    ;   ],
    ;   "cursor": "laborum officia ullamco e",
    ;   "partition": "elit velit"
    ; }

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

    CkJsonObject::ckUpdateInt(json,"filter.startTime.max",96423541)
    CkJsonObject::ckUpdateInt(json,"filter.startTime.min",708508)
    CkJsonObject::ckUpdateBool(json,"filter.endTime.isNull",0)
    CkJsonObject::ckUpdateInt(json,"filter.activeAtTime.max",42601793)
    CkJsonObject::ckUpdateInt(json,"filter.activeAtTime.min",6545191)
    CkJsonObject::ckUpdateNewObject(json,"filter.metadata")
    CkJsonObject::ckUpdateInt(json,"filter.assetIds[0]",5846331094676668)
    CkJsonObject::ckUpdateInt(json,"filter.assetIds[1]",3408965310215146)
    CkJsonObject::ckUpdateString(json,"filter.assetExternalIds[0]","deserunt aliquip Ut occaecat in")
    CkJsonObject::ckUpdateString(json,"filter.assetExternalIds[1]","non o")
    CkJsonObject::ckUpdateString(json,"filter.rootAssetIds[0].externalId","veniam commodo minim Duis ut")
    CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[1].id",123)
    CkJsonObject::ckUpdateInt(json,"filter.assetSubtreeIds[0].id",123)
    CkJsonObject::ckUpdateString(json,"filter.assetSubtreeIds[1].externalId","adipisicing")
    CkJsonObject::ckUpdateString(json,"filter.dataSetIds[0].externalId","commodo nisi")
    CkJsonObject::ckUpdateInt(json,"filter.dataSetIds[1].id",123)
    CkJsonObject::ckUpdateString(json,"filter.source","incididunt")
    CkJsonObject::ckUpdateString(json,"filter.type","in occaecat")
    CkJsonObject::ckUpdateString(json,"filter.subtype","dolore minim ipsum")
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.max",75538890)
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.min",51111895)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.max",31243942)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.min",56817666)
    CkJsonObject::ckUpdateString(json,"filter.externalIdPrefix","cillum")
    CkJsonObject::ckUpdateInt(json,"limit",100)
    CkJsonObject::ckUpdateNewArray(json,"sort")
    CkJsonObject::ckUpdateString(json,"cursor","laborum officia ullamco e")
    CkJsonObject::ckUpdateString(json,"partition","elit velit")

    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}}/events/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": {
        "startTime": {
            "max": 96423541,
            "min": 708508
        },
        "endTime": {
            "isNull": false
        },
        "activeAtTime": {
            "max": 42601793,
            "min": 6545191
        },
        "metadata": {},
        "assetIds": [
            5846331094676668,
            3408965310215146
        ],
        "assetExternalIds": [
            "deserunt aliquip Ut occaecat in",
            "non o"
        ],
        "rootAssetIds": [
            {
                "externalId": "veniam commodo minim Duis ut"
            },
            {
                "id": 2472341704760768
            }
        ],
        "assetSubtreeIds": [
            {
                "id": 6194248735806298
            },
            {
                "externalId": "adipisicing"
            }
        ],
        "dataSetIds": [
            {
                "externalId": "commodo nisi"
            },
            {
                "id": 4778982098206896
            }
        ],
        "source": "incididunt",
        "type": "in occaecat",
        "subtype": "dolore minim ipsum",
        "createdTime": {
            "max": 75538890,
            "min": 51111895
        },
        "lastUpdatedTime": {
            "max": 31243942,
            "min": 56817666
        },
        "externalIdPrefix": "cillum"
    },
    "limit": 100,
    "sort": [],
    "cursor": "laborum officia ullamco e",
    "partition": "elit velit"
}'
https://domain.com/api/v1/projects/{{project}}/events/list

Postman Collection Item JSON

{
  "id": "advancedListEvents",
  "name": "Filter all events",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "events",
        "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": "Retrieve a list of all events in the same project. This operation supports pagination by cursor. Criteria can be applied to select a subset of events.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"startTime\": {\n            \"max\": 96423541,\n            \"min\": 708508\n        },\n        \"endTime\": {\n            \"isNull\": false\n        },\n        \"activeAtTime\": {\n            \"max\": 42601793,\n            \"min\": 6545191\n        },\n        \"metadata\": {},\n        \"assetIds\": [\n            5846331094676668,\n            3408965310215146\n        ],\n        \"assetExternalIds\": [\n            \"deserunt aliquip Ut occaecat in\",\n            \"non o\"\n        ],\n        \"rootAssetIds\": [\n            {\n                \"externalId\": \"veniam commodo minim Duis ut\"\n            },\n            {\n                \"id\": 2472341704760768\n            }\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 6194248735806298\n            },\n            {\n                \"externalId\": \"adipisicing\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"commodo nisi\"\n            },\n            {\n                \"id\": 4778982098206896\n            }\n        ],\n        \"source\": \"incididunt\",\n        \"type\": \"in occaecat\",\n        \"subtype\": \"dolore minim ipsum\",\n        \"createdTime\": {\n            \"max\": 75538890,\n            \"min\": 51111895\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 31243942,\n            \"min\": 56817666\n        },\n        \"externalIdPrefix\": \"cillum\"\n    },\n    \"limit\": 100,\n    \"sort\": [],\n    \"cursor\": \"laborum officia ullamco e\",\n    \"partition\": \"elit velit\"\n}"
    }
  }
}