GET

Get Descendants

Returns a map of the descendants of a piece of Content. Content can have multiple types of descendants - for example a Page can have descendants that are also Pages, but it can also have Comments and Attachments.

The ContentType(s) of the descendants returned is specified by the expand query parameter in the request - this parameter can include expands for multiple descendant types. If no types are included in the expand parameter, the map returned will just list the descendant types that are available to be expanded for the Content referenced by the id path parameter.

Currently the only supported descendants are comment descendants of non-comment Content.

Example request URI(s):

http://example.com/confluence/rest/api/content/1234/descendant

http://example.com/confluence/rest/api/content/1234/descendant?expand=comment.body.VIEW

http://example.com/confluence/rest/api/content/1234/descendant?expand=comment

Request

Path parameters

id

string

Required

Query parameters

expand

string

Responses

Returns a JSON map representing multiple ordered collections of content descendants,keyed by content type.

application/json

object
GET/rest/api/content/{id}/descendant
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/content/{id}/descendant' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 { "results": [ { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": {}, "description": {}, "homepage": {}, "links": {}, "type": "global", "creator": {}, "creationDate": "2024-01-01T00:00:00Z", "lastModifier": {}, "lastModificationDate": "2024-01-01T00:00:00Z", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": {}, "permissions": {} }, "history": { "previousVersion": {}, "nextVersion": {}, "lastUpdated": {}, "latest": true, "createdBy": {}, "createdDate": "2020-01-01T00:00:00Z", "contributors": {}, "contentParentRef": {}, "lastUpdatedRef": {}, "nextVersionRef": {}, "previousVersionRef": {} }, "version": { "by": {}, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": {}, "contentRef": {} }, "ancestors": [], "position": 1, "operations": [ { "operation": "read", "targetType": "page" } ], "children": {}, "descendants": {}, "body": {}, "metadata": { "key": "value" }, "extensions": { "key": "value" }, "restrictions": { "use": { "operation": "use", "restrictions": [] } }, "relevantViewRestrictions": { "idProperties": {}, "expanded": true }, "versionRef": { "idProperties": {}, "expanded": true }, "containerRef": { "idProperties": {}, "expanded": true }, "historyRef": { "idProperties": {}, "expanded": true }, "spaceRef": { "idProperties": {}, "expanded": true } } ], "totalCount": 2154, "start": 25, "limit": 25, "size": 25, "_links": { "base": "http://localhost:8085/confluence", "context": "confluence", "self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25", "next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50", "prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0" } }
GET

Get descendants of type

Returns the direct descendants of a piece of Content. The ContentType(s) of the descendants returned is specified by the type path parameter in the request. Currently the only supported descendants are comment descendants of non-comment Content.

Example request URI(s):

http://example.com/confluence/rest/api/content/1234/descendant/comment

http://example.com/confluence/rest/api/content/1234/descendant/comment?expand=body.VIEW

http://example.com/confluence/rest/api/content/1234/descendant/comment?start=20&limit=10

Request

Path parameters

id

string

Required
type

string

Required

Query parameters

expand

string

limit

string

start

string

Responses

Returns a JSON map representing multiple ordered collections of content descendants, keyed by content type.

application/json

object
GET/rest/api/content/{id}/descendant/{type}
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/content/{id}/descendant/{type}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 { "results": [ { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": {}, "description": {}, "homepage": {}, "links": {}, "type": "global", "creator": {}, "creationDate": "2024-01-01T00:00:00Z", "lastModifier": {}, "lastModificationDate": "2024-01-01T00:00:00Z", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": {}, "permissions": {} }, "history": { "previousVersion": {}, "nextVersion": {}, "lastUpdated": {}, "latest": true, "createdBy": {}, "createdDate": "2020-01-01T00:00:00Z", "contributors": {}, "contentParentRef": {}, "lastUpdatedRef": {}, "nextVersionRef": {}, "previousVersionRef": {} }, "version": { "by": {}, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": {}, "contentRef": {} }, "ancestors": [], "position": 1, "operations": [ { "operation": "read", "targetType": "page" } ], "children": {}, "descendants": {}, "body": {}, "metadata": { "key": "value" }, "extensions": { "key": "value" }, "restrictions": { "use": { "operation": "use", "restrictions": [] } }, "relevantViewRestrictions": { "idProperties": {}, "expanded": true }, "versionRef": { "idProperties": {}, "expanded": true }, "containerRef": { "idProperties": {}, "expanded": true }, "historyRef": { "idProperties": {}, "expanded": true }, "spaceRef": { "idProperties": {}, "expanded": true } } ], "totalCount": 2154, "start": 25, "limit": 25, "size": 25, "_links": { "base": "http://localhost:8085/confluence", "context": "confluence", "self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25", "next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50", "prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0" } }

Rate this page: