Chilkat Online Tools

PowerBuilder / Cognite API v1 / Filter labels

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

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

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

loo_Resp = loo_Http.PostJson3("https://domain.com/api/v1/projects/{{project}}/labels/list","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_Json

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