Returns descendants in the content tree for a given whiteboard by ID in top-to-bottom order (that is, the highest descendant is the first
item in the response payload). The number of results is limited by the limit parameter and additional results (if available)
will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth
of descendants to be fetched.
The following types of content will be returned:
This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the whiteboard and its corresponding space
read:hierarchical-content:confluenceConnect app scope required: READ
integer
Requiredinteger
integer
string
Returned if the requested descendants are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/whiteboards/{id}/descendants`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"type": "<string>",
"childPosition": 55
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns descendants in the content tree for a given database by ID in top-to-bottom order (that is, the highest descendant is the first
item in the response payload). The number of results is limited by the limit parameter and additional results (if available)
will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth
of descendants to be fetched.
The following types of content will be returned:
This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the database and its corresponding space
read:hierarchical-content:confluenceConnect app scope required: READ
integer
Requiredinteger
integer
string
Returned if the requested descendants are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/databases/{id}/descendants`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"type": "<string>",
"childPosition": 55
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns descendants in the content tree for a given smart link by ID in top-to-bottom order (that is, the highest descendant is the first
item in the response payload). The number of results is limited by the limit parameter and additional results (if available)
will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth
of descendants to be fetched.
The following types of content will be returned:
This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the smart link and its corresponding space
read:hierarchical-content:confluenceConnect app scope required: READ
integer
Requiredinteger
integer
string
Returned if the requested descendants are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/embeds/{id}/descendants`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"type": "<string>",
"childPosition": 55
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns descendants in the content tree for a given folder by ID in top-to-bottom order (that is, the highest descendant is the first
item in the response payload). The number of results is limited by the limit parameter and additional results (if available)
will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth
of descendants to be fetched.
The following types of content will be returned:
This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the and its corresponding space
read:hierarchical-content:confluenceConnect app scope required: READ
integer
Requiredinteger
integer
string
Returned if the requested descendants are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/folders/{id}/descendants`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"type": "<string>",
"childPosition": 55
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns descendants in the content tree for a given page by ID in top-to-bottom order (that is, the highest descendant is the first
item in the response payload). The number of results is limited by the limit parameter and additional results (if available)
will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth
of descendants to be fetched.
The following types of content will be returned:
This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the page and its corresponding space
read:hierarchical-content:confluenceConnect app scope required: READ
integer
Requiredinteger
integer
string
Returned if the requested descendants are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{id}/descendants`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"type": "<string>",
"childPosition": 55
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Rate this page: