Overview
Get the relations from the given asset to other assets.
HTTP method |
GET |
|
|---|---|---|
URI template variables |
- |
|
Query parameters |
lang |
Return only the labels for the language 'de'. If not given the labels for all languages will be returned. |
offset, limit |
Query parameters for paging. See paging for details. |
|
relationTypes |
Return only relations of the specified relation type(s) (comma separated list). If not given relations of all types will be returned. |
|
sort |
New in MC | Cloud UX 2023.12 Defines the sort order for the relations. See below for details. |
|
insist |
New in MC | Cloud UX 2023.12 Asks the service to return an optional but requestable property:
|
|
Request body |
- |
|
HTTP response |
200 OK |
|
Response body |
The relations to other assets. |
|
Available in |
Description
Query parameter "sort"
Defines the sort order for the relations. The value is a comma-separated list of sort criteria. Each sort criterion consists of an optional direction prefix and a sort property. If the sort query parameter is missing or not given, the CTC service applies a system-specific default order.
Direction prefix
"+" or none |
ascending order |
"-" |
descending order |
Sort property
"label" |
Localized label of the relation type. |
"relationType" |
The ID of the relation type. |
"default" |
The system-specific default order for the relation type. |
"id" |
The ID of the related asset. |
An attribute name |
The name of a common attribute or of an attribute in the aa:attributes resource of the related asset. |
Examples
-
sort=label,relationType,name,id: sorts primarily by localized label of the relation type, then by relation type ID, then by the common attribute "name" of the related asset, then by the ID of the related asset, all in ascending order.
-
sort=-label,relationType: sorts primarily by localized label in descending order, then by relation type ID in ascending order.