Creates a whiteboard in the space.
Permissions required: Permission to view the corresponding space. Permission to create a whiteboard in the space.
write:whiteboard:confluenceConnect app scope required: WRITE
boolean
string
Requiredstring
string
string
string
Returned if the whiteboard was successfully created.
allOf [WhiteboardSingle, object]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"spaceId": "<string>",
"title": "<string>",
"parentId": "<string>",
"templateKey": "2x2-prioritization",
"locale": "de-DE"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/whiteboards`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
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
16
17
18
19
20
21
22
{
"id": "<string>",
"type": "<string>",
"status": "current",
"title": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 61,
"authorId": "<string>",
"ownerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"base": "<string>"
}
}Returns a specific whiteboard.
Permissions required: Permission to view the whiteboard and its corresponding space.
read:whiteboard:confluenceConnect app scope required: READ
integer
Requiredboolean
boolean
boolean
boolean
Returned if the requested whiteboard is returned.
allOf [WhiteboardSingle, object]
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}`, {
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
16
17
18
19
20
21
22
{
"id": "<string>",
"type": "<string>",
"status": "current",
"title": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 61,
"authorId": "<string>",
"ownerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"base": "<string>"
}
}Delete a whiteboard by id.
Deleting a whiteboard moves the whiteboard to the trash, where it can be restored later
Permissions required: Permission to view the whiteboard and its corresponding space. Permission to delete whiteboards in the space.
delete:whiteboard:confluenceConnect app scope required: DELETE
integer
RequiredReturned if the whiteboard was successfully deleted.
1
2
3
4
5
6
7
8
9
10
// 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}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: