Chilkat Online Tools

SQL Server / Cognite API v1 / Retrieve transformations

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
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.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.

    -- {
    --   "withJobDetails": false,
    --   "items": [
    --     {
    --       "id": 27339583
    --     },
    --     {
    --       "id": -73417155
    --     }
    --   ],
    --   "ignoreUnknownIds": true
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'withJobDetails', 0
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'items[0].id', 27339583
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'items[1].id', -73417155
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ignoreUnknownIds', 1

    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}}/transformations/byids', '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 '{
    "withJobDetails": false,
    "items": [
        {
            "id": 27339583
        },
        {
            "id": -73417155
        }
    ],
    "ignoreUnknownIds": true
}'
https://domain.com/api/v1/projects/{{project}}/transformations/byids

Postman Collection Item JSON

{
  "id": "getTransformationsByIds",
  "name": "Retrieve transformations",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "transformations",
        "byids"
      ],
      "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 maximum of 1000 transformations by ids and externalIds per request.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"withJobDetails\": false,\n    \"items\": [\n        {\n            \"id\": 27339583\n        },\n        {\n            \"id\": -73417155\n        }\n    ],\n    \"ignoreUnknownIds\": true\n}"
    }
  }
}