Chilkat Online Tools

Foxpro / Cognite API v1 / Filter labels

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

* 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": {
*     "name": "exercitation esse id",
*     "externalIdPrefix": "elit",
*     "dataSetIds": [
*       {
*         "externalId": "cillum in do"
*       },
*       {
*         "externalId": "in exercitation"
*       }
*     ]
*   },
*   "cursor": "incididunt quis ad veniam in",
*   "limit": 100
* }

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("filter.name","exercitation esse id")
loJson.UpdateString("filter.externalIdPrefix","elit")
loJson.UpdateString("filter.dataSetIds[0].externalId","cillum in do")
loJson.UpdateString("filter.dataSetIds[1].externalId","in exercitation")
loJson.UpdateString("cursor","incididunt quis ad veniam in")
loJson.UpdateInt("limit",100)

loHttp.SetRequestHeader("content-type","application/json")
loHttp.SetRequestHeader("api-key","{{api-key}}")

loResp = loHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/labels/list","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "name": "exercitation esse id",
        "externalIdPrefix": "elit",
        "dataSetIds": [
            {
                "externalId": "cillum in do"
            },
            {
                "externalId": "in exercitation"
            }
        ]
    },
    "cursor": "incididunt quis ad veniam in",
    "limit": 100
}'
https://domain.com/api/v1/projects/{{project}}/labels/list

Postman Collection Item JSON

{
  "id": "listLabels",
  "name": "Filter labels",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "labels",
        "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 label definitions.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"exercitation esse id\",\n        \"externalIdPrefix\": \"elit\",\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"cillum in do\"\n            },\n            {\n                \"externalId\": \"in exercitation\"\n            }\n        ]\n    },\n    \"cursor\": \"incididunt quis ad veniam in\",\n    \"limit\": 100\n}"
    }
  }
}