Chilkat Online Tools

Python / Cognite API v1 / Retrieve relationships

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.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
# }

json = chilkat2.JsonObject()
json.UpdateString("items[0].externalId","in eiusmod nulla")
json.UpdateString("items[1].externalId","consectetur eu Excepteur voluptate")
json.UpdateBool("ignoreUnknownIds",False)
json.UpdateBool("fetchResources",False)

http.SetRequestHeader("content-type","application/json")
http.SetRequestHeader("api-key","{{api-key}}")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/relationships/byids","application/json",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

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