Chilkat Online Tools

lianja / Cognite API v1 / Delete relationships

Back to Collection Items

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

loHttp = createobject("CkHttp")

// 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": "eu"
//     },
//     {
//       "externalId": "ut Lorem quis veniam consequat"
//     }
//   ],
//   "ignoreUnknownIds": false
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("items[0].externalId","eu")
loJson.UpdateString("items[1].externalId","ut Lorem quis veniam consequat")
loJson.UpdateBool("ignoreUnknownIds",.F.)

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

loResp = loHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/relationships/delete","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "eu"
        },
        {
            "externalId": "ut Lorem quis veniam consequat"
        }
    ],
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/relationships/delete

Postman Collection Item JSON

{
  "id": "deleteRelationships",
  "name": "Delete relationships",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "relationships",
        "delete"
      ],
      "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": "Delete the relationships between resources identified by the external IDs in the request. You can delete a maximum of 1000 relationships per request.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"eu\"\n        },\n        {\n            \"externalId\": \"ut Lorem quis veniam consequat\"\n        }\n    ],\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}