Chilkat Online Tools

Objective-C / Cognite API v1 / Retrieve transformations

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateBool: @"withJobDetails" value: NO];
[json UpdateInt: @"items[0].id" value: [NSNumber numberWithInt: 27339583]];
[json UpdateInt: @"items[1].id" value: [NSNumber numberWithInt: -73417155]];
[json UpdateBool: @"ignoreUnknownIds" value: YES];

[http SetRequestHeader: @"content-type" value: @"application/json"];
[http SetRequestHeader: @"api-key" value: @"{{api-key}}"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/api/v1/projects/{{project}}/transformations/byids" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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