Link relation relations:relation-types

Overview

Get the available relation types for the asset.

HTTP method	GET
URL template parameters	-
Query parameters	lang	Return only the labels for the language 'de'. If not given the labels for all languages will be returned.
sort	Defines the sort order for the relation types. See below for details.
Request body	-
HTTP response	200 OK
Response body		relations:relation-types
Available in		aa:asset Theoretically also in loc:item, but that is currently not supported by any system type.

HTTP method

GET

URL template parameters

Query parameters

lang

Return only the labels for the language 'de'. If not given the labels for all languages will be returned.

sort

Defines the sort order for the relation types. See below for details.

Request body

HTTP response

200 OK

Response body

relations:relation-types

Available in

aa:asset

Theoretically also in loc:item, but that is currently not supported by any system type.

Description

Query parameter "sort"

Defines the sort order for the relation types. 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"

Applies a system-specific default order.

Examples:

sort=label,+relationType: sorts primarily by localized label, then by relation type ID, both in ascending order.
sort=-label,relationType: sorts primarily by localized label in descending order, then by relation type ID in ascending order.