Delete Relationship

Delete (remove) a Resource as RelationshipType of a specific Resource

NOTE: Removing a relationship is not synchronous. As a
result, the delete operation may not happen immediately. It is recommended
to query the relationships of the specific Resource back to ensure that the
operation was indeed successful.

Request

URI

DELETE

https://{api_host}/suite-api/api/resources/{id}/relationships/{relationshipType}/{relatedId}

COPY

Path Parameters

string

Required

The UUID of the resource

string

relationshipType

Required

Type of the Relationship that needs to be removed

string

relatedId

Required

The UUID of the resource to remove from relationship

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

204

The relationship is deleted successfully

Operation doesn't return any data structure

404

Either of the Resource that are part of the path parameters are invalid/non-existent

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/suite-api/api/resources/{id}/relationships/{relationshipType}/{relatedId}

On This Page

Description

Request

Path Parameters

Authentication

Response

204 Response Body

Errors

Resource Operations

GET

Get Relationship

PUT