Deprecated, use Confluence's v2 API.
Returns inline tasks based on the search query.
Permissions required: Permission to access the Confluence site ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
read:confluence-content.allread:inlinetask:confluenceConnect app scope required: READ
integer
integer
string
string
string
string
string
integer
integer
integer
Returned if the query fetches zero or more results.
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/rest/api/inlinetasks/search`, {
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
23
24
{
"results": [
{
"globalId": 2154,
"id": 2154,
"contentId": 2154,
"status": "<string>",
"title": "<string>",
"description": "<string>",
"body": "<string>",
"creator": "<string>",
"assignee": "<string>",
"completeUser": "<string>",
"createDate": 2154,
"dueDate": 2154,
"updateDate": 2154,
"completeDate": 2154,
"_links": {}
}
],
"start": 2154,
"limit": 2154,
"size": 2154
}Deprecated, use Confluence's v2 API.
Returns inline task based on the global ID.
Permissions required: Permission to view the content associated with the task.
read:inlinetask:confluenceConnect app scope required: READ
string
RequiredReturned if the inline task was found given the global ID
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/rest/api/inlinetasks/{inlineTaskId}`, {
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
{
"globalId": 2154,
"id": 2154,
"contentId": 2154,
"status": "<string>",
"title": "<string>",
"description": "<string>",
"body": "<string>",
"creator": "<string>",
"assignee": "<string>",
"completeUser": "<string>",
"createDate": 2154,
"dueDate": 2154,
"updateDate": 2154,
"completeDate": 2154,
"_links": {}
}Updates an inline tasks status given its global ID
Permissions required: Permission to update the content associated with the task.
read:inlinetask:confluence, write:inlinetask:confluenceConnect app scope required: WRITE
string
RequiredThe updated task status.
string
RequiredReturned if the inline task was successfully updated.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"status": "complete"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/rest/api/inlinetasks/{inlineTaskId}`, {
method: 'PUT',
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
{
"globalId": 2154,
"id": 2154,
"contentId": 2154,
"status": "<string>",
"title": "<string>",
"description": "<string>",
"body": "<string>",
"creator": "<string>",
"assignee": "<string>",
"completeUser": "<string>",
"createDate": 2154,
"dueDate": 2154,
"updateDate": 2154,
"completeDate": 2154,
"_links": {}
}Rate this page: