Chilkat Online Tools

SQL Server / Cognite API v1 / Filter labels

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.name', 'exercitation esse id'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.externalIdPrefix', 'elit'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.dataSetIds[0].externalId', 'cillum in do'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.dataSetIds[1].externalId', 'in exercitation'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'cursor', 'incididunt quis ad veniam in'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'limit', 100

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'content-type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'api-key', '{{api-key}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/api/v1/projects/{{project}}/labels/list', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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