Delete Relation

This call deletes a relation.

URL

/dataModel/relation/{id}

Method

DELETE

Headers

Required:

Authorization: Bearer <token>

Note <token> is the token that is returned by the Authentication call.

Example:

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0Njc5ODQ5MTcsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.Ph8WHtzvpvfuH1j0CtwHqyBhX1uLlfhr0eQQ7m0_gT0

Request type

None

Response type

JSON

URL Parameters

Path Parameters

Required:

{id}: [ucmdb_id]

Data Types:

[ucmdb_id]

The string that represents the UCMDB ID of a relation.

Payload

None

Success response

Code: 200

Response:

{
     "addedCis": "list of [ucmdb_id]"
     "removedCis": "list of [ucmdb_id]",
     "updatedCis": "list of [ucmdb_id]",
     "ignoredCis": "list of [ucmdb_id]"
}

Data Types:

[ucmdb_id]

The string that represents the UCMDB ID of a relation.

Example:

Code: 200

Content:

{
    "addedCis": "[]",
    "removedCis": "[
        464106e644e5d86daea003a2cbbc648f
    ]",
    "updatedCis": "[]",
    "ignoredCis": "[]"
}

Error response

Status: 404 or 400

Content:

{
  error: [string]
} 

Example:

Code: 404

Content:

{
   error: The following error has occurred:  Relation with specified ID was not found. Please consult logs for more details
}

Note

The user that the token belongs to must have the required permissions for deleting the data inside UCMDB through the SDK.