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
string
Requiredstring
Returns a JSON map representing multiple ordered collections of content descendants,keyed by content type.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/content/{id}/descendant' \
--header 'Accept: application/json'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
113
114
115
{
"pageRequest": {
"cursor": {
"reverse": true,
"cursorType": "SPACE"
},
"start": 2154,
"limit": 2154
},
"nextCursor": {
"reverse": true,
"cursorType": "SPACE"
},
"prevCursor": {
"reverse": true,
"cursorType": "SPACE"
},
"results": [
{
"id": "123456",
"type": "page",
"status": "current",
"title": "My Page",
"links": {
"webui": "https://www.example.com/display/SPACEKEY/My+Page"
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {},
"description": {},
"homepage": {},
"links": {},
"type": "global",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {}
},
"history": {
"previousVersion": {},
"nextVersion": {},
"lastUpdated": {},
"latest": true,
"createdBy": {},
"createdDate": "2020-01-01T00:00:00Z",
"contributors": {},
"lastUpdatedRef": {},
"nextVersionRef": {},
"previousVersionRef": {},
"contentParentRef": {}
},
"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": []
}
},
"historyRef": {
"expanded": true,
"idProperties": {}
},
"spaceRef": {
"expanded": true,
"idProperties": {}
},
"containerRef": {
"expanded": true,
"idProperties": {}
},
"versionRef": {
"expanded": true,
"idProperties": {}
}
}
],
"start": 25,
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0"
}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
string
Requiredstring
Requiredstring
string
string
Returns a JSON map representing multiple ordered collections of content descendants, keyed by content type.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/content/{id}/descendant/{type}' \
--header 'Accept: application/json'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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
{
"id": "123456",
"type": "page",
"status": "current",
"title": "My Page",
"links": {
"webui": "https://www.example.com/display/SPACEKEY/My+Page"
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {
"expanded": true,
"idProperties": {}
},
"description": {},
"homepage": {
"expanded": true,
"idProperties": {}
},
"links": {},
"type": "global",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {
"expanded": true,
"idProperties": {}
}
},
"history": {
"previousVersion": {
"expanded": true,
"idProperties": {}
},
"nextVersion": {
"expanded": true,
"idProperties": {}
},
"lastUpdated": {
"expanded": true,
"idProperties": {}
},
"latest": true,
"createdBy": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"createdDate": "2020-01-01T00:00:00Z",
"contributors": {
"expanded": true,
"idProperties": {}
},
"lastUpdatedRef": {
"expanded": true,
"idProperties": {}
},
"nextVersionRef": {
"expanded": true,
"idProperties": {}
},
"previousVersionRef": {
"expanded": true,
"idProperties": {}
},
"contentParentRef": {
"expanded": true,
"idProperties": {}
}
},
"version": {
"by": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"when": "2020-01-01T00:00:00Z",
"message": "A message",
"number": 1,
"minorEdit": true,
"hidden": true,
"syncRev": "123456",
"content": {
"expanded": true,
"idProperties": {}
},
"contentRef": {
"expanded": true,
"idProperties": {}
}
},
"ancestors": [],
"position": 1,
"operations": [
{
"operation": "read",
"targetType": "page"
}
],
"children": {},
"descendants": {},
"body": {},
"metadata": {
"key": "value"
},
"extensions": {
"key": "value"
},
"restrictions": {
"use": {
"operation": "use",
"restrictions": []
}
},
"historyRef": {
"expanded": true,
"idProperties": {}
},
"spaceRef": {
"expanded": true,
"idProperties": {}
},
"containerRef": {
"expanded": true,
"idProperties": {}
},
"versionRef": {
"expanded": true,
"idProperties": {}
}
}Rate this page: