List Relationships of an Archived Item
get
/content/management/api/v1.1/archive/items/{id}/relationships
Lists all relationships for a given archived item.
Request
Path Parameters
-
id: string
id of the item.
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 : Relationships
Type:
object
Relationships
Show Source
-
referencedBy(optional):
array referencedBy
Referenced by ids
-
referencedBySitePlan(optional):
object Siteplanreference
Site plan reference
-
referencedBySites(optional):
array referencedBySites
Referenced by sites
-
references(optional):
array references
Reference ids
Nested Schema : referencedBy
Type:
array
Referenced by ids
Show Source
-
Array of:
object References
References
Nested Schema : Siteplanreference
Type:
object
Site plan reference
Show Source
-
id(optional):
string
id of the site plan.
-
links(optional):
array links
Nested Schema : referencedBySites
Type:
array
Referenced by sites
Show Source
-
Array of:
object ReferencedBySites
ReferencedBySites
Nested Schema : references
Type:
array
Reference ids
Show Source
-
Array of:
object References
References
Nested Schema : References
Type:
object
References
Show Source
-
id(optional):
string
id of the item.
-
links(optional):
array links
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
Nested Schema : ItemReferenceInfo
Type:
object
ItemReferenceInfo
Show Source
-
isAccessible(optional):
boolean
Whether the item is accessible.
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.
Nested Schema : ReferencedBySites
Type:
object
ReferencedBySites
Show Source
-
component(optional):
string
Component of the item
-
pageId(optional):
string
Page the item added to
-
site(optional):
string
Site the item added to
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.