List All relationships for a type
get
/content/management/api/v1.1/types/{name}/relationships
List all relationships associated to a type.
Request
Path Parameters
-
name: string
Type name identifier is case-sensitive and any special characters must be encoded
Query Parameters
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby
Response
Supported Media Types
- application/json
200 Response
OK.
Nested Schema : TypeRelationships
Type:
object
Type Relationships
Show Source
-
references(optional):
array references
Unique Items Required:
true
Reference type names/ids
Nested Schema : references
Type:
array
Unique Items Required:
true
Reference type names/ids
Show Source
-
Array of:
object TypeReferences
Type References bean
Nested Schema : TypeReferences
Type:
object
Type References bean
Show Source
-
id(optional):
string
id of the type
-
links(optional):
array links
-
name(optional):
string
name of the type
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
500 Response
Internal server error.