Chilkat Online Tools

phpAx / Cognite API v1 / Retrieve relationships

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('items[0].externalId','in eiusmod nulla');
$json->UpdateString('items[1].externalId','consectetur eu Excepteur voluptate');
$json->UpdateBool('ignoreUnknownIds',0);
$json->UpdateBool('fetchResources',0);

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

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/api/v1/projects/{{project}}/relationships/byids','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

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