Chilkat Online Tools

delphiDll / Cognite API v1 / Retrieve relationships

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "items": [
//     {
//       "externalId": "in eiusmod nulla"
//     },
//     {
//       "externalId": "consectetur eu Excepteur voluptate"
//     }
//   ],
//   "ignoreUnknownIds": false,
//   "fetchResources": false
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'items[0].externalId','in eiusmod nulla');
CkJsonObject_UpdateString(json,'items[1].externalId','consectetur eu Excepteur voluptate');
CkJsonObject_UpdateBool(json,'ignoreUnknownIds',False);
CkJsonObject_UpdateBool(json,'fetchResources',False);

CkHttp_SetRequestHeader(http,'content-type','application/json');
CkHttp_SetRequestHeader(http,'api-key','{{api-key}}');

resp := CkHttp_PostJson3(http,'https://domain.com/api/v1/projects/{{project}}/relationships/byids','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "in eiusmod nulla"
        },
        {
            "externalId": "consectetur eu Excepteur voluptate"
        }
    ],
    "ignoreUnknownIds": false,
    "fetchResources": false
}'
https://domain.com/api/v1/projects/{{project}}/relationships/byids

Postman Collection Item JSON

{
  "id": "byidsRelationships",
  "name": "Retrieve relationships",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "relationships",
        "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 relationships by external IDs. You can retrieve a maximum of 1000 relationships per request.\nThe order of the relationships in the response equals the order in the request.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"in eiusmod nulla\"\n        },\n        {\n            \"externalId\": \"consectetur eu Excepteur voluptate\"\n        }\n    ],\n    \"ignoreUnknownIds\": false,\n    \"fetchResources\": false\n}"
    }
  }
}