Chilkat Online Tools

VBScript / Cognite API v1 / Retrieve relationships

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

' 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 CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("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 CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("items[0].externalId","in eiusmod nulla")
success = json.UpdateString("items[1].externalId","consectetur eu Excepteur voluptate")
success = json.UpdateBool("ignoreUnknownIds",0)
success = json.UpdateBool("fetchResources",0)

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

' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/relationships/byids","application/json",json)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine(resp.StatusCode)
outFile.WriteLine(resp.BodyStr)


outFile.Close

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