Create a relationship between Assets.

Create a bidirectional relationship between a primary Asset and one or more secondary Assets. Asset relationships allow a user to quickly navigate from one Asset to another related Asset.

The user attempting to create a relationship using Asset must be granted the Relationship Security Template permission on the Asset.

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
id
required
string

Asset object ID

header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body is a JSON object that provides information about relationships to create.

Array of objects (RelationshipCreateRequest_secondaryIds)
Responses
200

The response is an array that contains a status(success/failed) for each relationship.

400

Invalid Asset Object ID or secondaryIds

401

Unauthorized. Missing Authorization or AccessToken or expired token

403

Forbidden. Missing X-API-key

post/asset/{id}/link
Request samples
application/json
{
  • "secondaryIds": [
    ]
}
Response samples
application/json
[
  • [
    ]
]