Chilkat Online Tools

PureBasic / Cognite API v1 / Filter models

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": {
    ;     "featureType": "simple",
    ;     "classifier": "randomforest",
    ;     "originalId": 82740981,
    ;     "name": "ullamco laboris",
    ;     "description": "aliquip exercitation minim dolor esse"
    ;   },
    ;   "limit": 100
    ; }

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

    CkJsonObject::ckUpdateString(json,"filter.featureType","simple")
    CkJsonObject::ckUpdateString(json,"filter.classifier","randomforest")
    CkJsonObject::ckUpdateInt(json,"filter.originalId",82740981)
    CkJsonObject::ckUpdateString(json,"filter.name","ullamco laboris")
    CkJsonObject::ckUpdateString(json,"filter.description","aliquip exercitation minim dolor esse")
    CkJsonObject::ckUpdateInt(json,"limit",100)

    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}}/context/entitymatching/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": {
        "featureType": "simple",
        "classifier": "randomforest",
        "originalId": 82740981,
        "name": "ullamco laboris",
        "description": "aliquip exercitation minim dolor esse"
    },
    "limit": 100
}'
https://domain.com/api/v1/projects/{{project}}/context/entitymatching/list

Postman Collection Item JSON

{
  "id": "entityMatchingFilter",
  "name": "Filter models",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "context",
        "entitymatching",
        "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 filtering options to find entity matcher models.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"featureType\": \"simple\",\n        \"classifier\": \"randomforest\",\n        \"originalId\": 82740981,\n        \"name\": \"ullamco laboris\",\n        \"description\": \"aliquip exercitation minim dolor esse\"\n    },\n    \"limit\": 100\n}"
    }
  }
}