Set Relationship Using PUT

Set Relationship Using PUT

This API exposes replace semantics. Therefore, all the existing relationships of the specified relationshipType will be removed and replaced with the resources specified as part of the request body.

  • If at least a few of the Resource that are part of relatedIds list are valid resources then the operation is performed.
  • If there are few Resource that are part of relatedIds list that will result in a cyclical relationship, then the operation is aborted.

NOTE: Setting relationship is not synchronous. As a result, the set 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
PUT
https://{api_host}/api/resources/{id}/relationships/{relationshipType}
COPY
Path Parameters
string
id
Required

The UUID of the source resource

string
relationshipType
Required

The type of relationship of the objects; Uses the RelationshipType.representation value

Possible values are : parents, children,
Request Body

UUID of resources to set as related to this resource

uuid-values of type(s) application/json
Required 
{
    "uuids": [
        "string"
    ]
}
array of string
uuids
Optional

Represents a list of UUID(s)

Authentication
This operation uses the following authentication methods.
Responses
204

The relationship is set successfully

Operation doesn't return any data structure

404

All of the Resource that are part of the relatedIds list are invalid/non-existent

Operation doesn't return any data structure

On This Page
Resource Operations
POST
Add Properties Using POST
POST
Add Properties Using Push Adapter Kind Using POST
POST
Add Relationship Using POST
POST
Add Stats Using POST
POST
Add Stats Using Push Adapter Kind Using POST
DELETE
Delete Relationship Using DELETE
DELETE
Delete Resource Using DELETE
GET
Get DT Stats Of Resource Using GET
GET
Get Latest Stats Using GET
GET
Get Relationships Using GET
GET
Get Relationship Using GET
GET
Get Resource Properties Using GET
GET
Get Resource Using GET
GET
Get Stat Keys Using GET
POST
Get Stats For Resource Using POST
GET
Get Stats Of Resource Using GET
GET
Get Top N Stats Of Resource Using GET
PUT
Mark Resource As Being Maintained Using PUT
PUT
Set Relationship Using PUT
PUT
Start Monitoring Resource Using PUT
PUT
Stop Monitoring Resource Using PUT
DELETE
Unmark Resource As Being Maintained Using DELETE
PUT
Update Geo Location Of Resource Using PUT