Returns all ancestors for a given whiteboard by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.
This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get whiteboard by id.
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the whiteboard and its corresponding space
read:content.metadata:confluenceConnect app scope required: READ
integer
Requiredinteger
Returned if the requested ancestors are returned.
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}/ancestors`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
{
"results": [
{
"id": "<string>",
"type": "page"
}
]
}Returns all ancestors for a given database by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.
This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get database by id.
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the database and its corresponding space
read:content.metadata:confluenceConnect app scope required: READ
integer
Requiredinteger
Returned if the requested ancestors are returned.
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}/ancestors`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
{
"results": [
{
"id": "<string>",
"type": "page"
}
]
}Returns all ancestors for a given Smart Link in the content tree by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.
This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get Smart Link in the content tree by id.
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the Smart Link in the content tree and its corresponding space
read:content.metadata:confluenceConnect app scope required: READ
integer
Requiredinteger
Returned if the requested ancestors are returned.
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}/ancestors`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
{
"results": [
{
"id": "<string>",
"type": "page"
}
]
}Returns all ancestors for a given folder by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.
This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get folder by id.
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the folder and its corresponding space
read:content.metadata:confluenceConnect app scope required: READ
integer
Requiredinteger
Returned if the requested ancestors are returned.
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}/ancestors`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
{
"results": [
{
"id": "<string>",
"type": "page"
}
]
}Returns all ancestors for a given page by ID in top-to-bottom order (that is, the highest ancestor 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 ID of first ancestor in the response payload.
This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get page by id.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
read:content.metadata:confluenceConnect app scope required: READ
integer
Requiredinteger
Returned if the requested ancestors are returned.
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}/ancestors`, {
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
{
"results": [
{
"id": "<string>",
"type": "page"
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Rate this page: