Get content descendants
GET {{baseUrl}}/api/content/:id/descendant?expand=<string>&expand=<string>
Returns a map of the descendants of a piece of content. This is similar to Get content children, except that this method returns child pages at all levels, rather than just the direct child pages.
A piece of content has different types of descendants, depending on its type:
page
: descendant ispage
,comment
,attachment
blogpost
: descendant iscomment
,attachment
attachment
: descendant iscomment
comment
: descendant isattachment
The map will always include all descendant types that are valid for the content. However, if the content has no instances of a descendant type, the map will contain an empty array for that descendant type.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
expand | string | A multi-value parameter indicating which properties of the children to | |
expand, where: |
-
attachment
returns all attachments for the content. -
comments
returns all comments for the content. -
page
returns all child pages of the content. | |expand
| string | | A multi-value parameter indicating which properties of the children to expand, where: -
attachment
returns all attachments for the content. -
comments
returns all comments for the content. -
page
returns all child pages of the content. |
RESPONSES
status: OK
{"_expandable":{"attachment":"in ut","comment":"dolor","page":"eu exercitation"},"_links":{},"attachment":{"results":[{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"}],"start":-75729038,"limit":34726306,"size":18934279,"_links":{}},"comment":{"results":[{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"}],"start":37994470,"limit":2587712,"size":-24049554,"_links":{}},"page":{"results":[{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"}],"start":66843073,"limit":57682154,"size":-4004438,"_links":{}}}