Returns a map of the direct children of a piece of Content. Content can have multiple types of children. For example, a Page can have children that are also Pages, but it can also have Comments and Attachments.
The types of the children returned is specified by the expand query parameter in the request. This parameter can include expands for multiple child types. If no types are included in the expand parameter, the map returned will just list the child types that are available to be expanded for the content referenced by the id path parameter.
string
Requiredstring
string
string
integer
Returned if the children are successfully retrieved. The response body contains a JSON map representing multiple ordered collections of content children, keyed by content type.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/content/{id}/child' \
--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 children of a piece of Content, limited to a single child type.The types of the children returned is specified by the "type" path parameter in the request.
string
Requiredstring
Requiredstring
string
string
integer
Returns a JSON map representing multiple ordered collections of content children, keyed by content type
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/content/{id}/child/{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
{
"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 comments of a piece of Content. Example request URI(s):
http://example.com/confluence/rest/api/content/1234/child/commenthttp://example.com/confluence/rest/api/content/1234/child/comment?expand=body.viewhttp://example.com/confluence/rest/api/content/1234/child/comment?start=20&limit=10http://example.com/confluence/rest/api/content/1234/child/comment?location=footer&location=inline&location=resolvedhttp://example.com/confluence/rest/api/content/1234/child/comment?expand=extensions.inlineProperties,extensions.resolutionstring
Requiredstring
string
string
string
string
integer
Returns a JSON map representing multiple ordered collections of content children, keyed by content type
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/content/{id}/child/comment' \
--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"
}Rate this page: