Jump to

• Request
• Response
• Examples

List Relationships of an Item

get

/content/management/api/v1.1/items/{id}/relationships

Lists all relationships for a given 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ItemSubResourceRelationships

Type: object

Item SubResource.

Show Source

• data(optional): object Relationships
  Relationships
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/Relationships"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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

{
    "type":"object",
    "properties":{
        "references":{
            "type":"array",
            "description":"Reference ids",
            "items":{
                "$ref":"#/definitions/References"
            }
        },
        "referencedBy":{
            "type":"array",
            "description":"Referenced by ids",
            "items":{
                "$ref":"#/definitions/References"
            }
        },
        "referencedBySites":{
            "type":"array",
            "description":"Referenced by sites",
            "items":{
                "$ref":"#/definitions/ReferencedBySites"
            }
        },
        "referencedBySitePlan":{
            "$ref":"#/definitions/Siteplanreference"
        }
    },
    "description":"Relationships"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : referencedBy

Type: array

Referenced by ids

Show Source

• Array of: object References
  References

{
    "type":"array",
    "description":"Referenced by ids",
    "items":{
        "$ref":"#/definitions/References"
    }
}

Nested Schema : Siteplanreference

Type: object

Site plan reference

Show Source

• id(optional): string
  id of the site plan.
• links(optional): array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the site plan."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Site plan reference"
}

Nested Schema : referencedBySites

Type: array

Referenced by sites

Show Source

• Array of: object ReferencedBySites
  ReferencedBySites

{
    "type":"array",
    "description":"Referenced by sites",
    "items":{
        "$ref":"#/definitions/ReferencedBySites"
    }
}

Nested Schema : references

Type: array

Reference ids

Show Source

• Array of: object References
  References

{
    "type":"array",
    "description":"Reference ids",
    "items":{
        "$ref":"#/definitions/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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "reference":{
            "description":"Access information of the Referenced Item.",
            "$ref":"#/definitions/ItemReferenceInfo"
        }
    },
    "description":"References"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ItemReferenceInfo

Type: object

ItemReferenceInfo

Show Source

• isAccessible(optional): boolean
  Whether the item is accessible.

{
    "type":"object",
    "properties":{
        "isAccessible":{
            "type":"boolean",
            "description":"Whether the item is accessible."
        }
    },
    "description":"ItemReferenceInfo"
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

{
    "type":"object",
    "properties":{
        "site":{
            "type":"string",
            "description":"Site the item added to"
        },
        "pageId":{
            "type":"string",
            "description":"Page the item added to"
        },
        "component":{
            "type":"string",
            "description":"Component of the item"
        }
    },
    "description":"ReferencedBySites"
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top

Examples

The following example shows how to get relationships of an item by submitting a GET request using cURL.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/items/{id}/relationships'

Example 1

This lists all relationships of item id: CORED98388F2AA724E27844821414B0B0447. This is a sample response when Granular Permissions feature is not enabled.

/content/management/api/v1.1/items/CORED98388F2AA724E27844821414B0B0447/relationships

Response Body

{
    "data": {
    "references": [
      {
        "id": "CORECE0B9A793CD54F26AF0853BBB5F49745",
        "links": [
      {
        "href": "https://host:port/content/management/api/v1.1/items/CORECE0B9A793CD54F26AF0853BBB5F49745",
        "rel": "self",
        "method": "GET",
        "mediaType": "application/json"
    }
        ]
    }
    ],
    "referencedBy": [
      {
        "id": "CORECE0B9A793CD54F26AF0853BBB5F49745",
        "links": [
      {
        "href": "https://host:port/content/management/api/v1.1/items/CORECE0B9A793CD54F26AF0853BBB5F49745",
        "rel": "self",
        "method": "GET",
        "mediaType": "application/json"
    }
        ]
    }
    ]
    },
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/items/CORED98388F2AA724E27844821414B0B0447/relationships",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }

Example 2

This lists all relationships of item id: CORE4FDEB4C45AF34766B8CB88D25BD92D90. This is a sample response when Granular Permissions feature is enabled and user has view permission on all references and referenced by items.

/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/relationships

Response Body

{
	    "data": {
	        "references": [
	            {
	                "id": "CONT90C026CB999E470CAEAFE0F76BB55036",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONT90C026CB999E470CAEAFE0F76BB55036",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CORE878A5BEE021849D2A183CF94E64F1D9B",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE878A5BEE021849D2A183CF94E64F1D9B",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CONTBAEF8D6E7C44433FB553BB53D1D0B531",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONTBAEF8D6E7C44433FB553BB53D1D0B531",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "COREA0B53F00198F4771962526DDF83416C5",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/COREA0B53F00198F4771962526DDF83416C5",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            }
	        ],
	        "referencedBy": [
	            {
	                "id": "CORE558B93EAE0114E749E0C7550DD0635C4",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE558B93EAE0114E749E0C7550DD0635C4",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CORE1A9DFBE412D04E039FDDED1AAF4D64EC",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE1A9DFBE412D04E039FDDED1AAF4D64EC",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            }
	        ],
	        "referencedBySites": []
	    },
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/relationships",
	            "rel": "self",
	            "method": "GET",
	            "mediaType": "application/json"
	        }
	    ]
      }

Example 3

This lists all relationships of item id: CORE4FDEB4C45AF34766B8CB88D25BD92D90. This is a sample response when Granular Permissions feature is enabled but user doesn't have view permission on all references and referenced by items.

/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/relationships

Response Body

{
	    "data": {
	        "references": [
	            {
	                "id": "CONT90C026CB999E470CAEAFE0F76BB55036",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONT90C026CB999E470CAEAFE0F76BB55036",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CORE878A5BEE021849D2A183CF94E64F1D9B",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE878A5BEE021849D2A183CF94E64F1D9B",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CONTBAEF8D6E7C44433FB553BB53D1D0B531",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONTBAEF8D6E7C44433FB553BB53D1D0B531",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "COREA0B53F00198F4771962526DDF83416C5",
	                "reference": {
	                    "isAccessible": false
	                }
	            }
	        ],
	        "referencedBy": [
	            {
	                "id": "CORE558B93EAE0114E749E0C7550DD0635C4",
	                "reference": {
	                    "isAccessible": false
	                }
	            },
	            {
	                "id": "CORE1A9DFBE412D04E039FDDED1AAF4D64EC",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE1A9DFBE412D04E039FDDED1AAF4D64EC",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            }
	        ],
	        "referencedBySites": []
	    },
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/relationships",
	            "rel": "self",
	            "method": "GET",
	            "mediaType": "application/json"
	        }
	    ]
      }
    }
  ]
}

Back to Top