Rate this page:
GET /wiki/rest/api/inlinetasks/search
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.
Connect app scope required: READ
read:inlinetask:confluence
integer
The starting offset for the results.
0
, Format: int32
integer
The number of results to be returned.
20
, Format: int32
string
The space key of a space. Multiple space keys can be specified.
string
The page id of a page. Multiple page ids can be specified.
string
Account ID of a user to whom a task is assigned. Multiple users can be specified.
string
Account ID of a user to who created a task. Multiple users can be specified.
string
Account ID of a user who completed a task. Multiple users can be specified.
integer
Start of date range based on due dates (inclusive).
int64
integer
End of date range based on due dates (inclusive).
int64
integer
Start of date range based on create dates (inclusive).
int64
integer
End of date range based on create dates (inclusive).
int64
integer
Start of date range based on complete dates (inclusive).
int64
integer
End of date range based on complete dates (inclusive).
int64
string
The status of the task. (checked/unchecked)
Valid values: complete
, incomplete
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.asApp().requestConfluence(route`/wiki/rest/api/inlinetasks/search`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());
Returned if the query fetches zero or more results.
Content type | Value |
---|---|
application/json |
GET /wiki/rest/api/inlinetasks/{inlineTaskId}
Returns inline task based on the global ID.
Permissions required: Permission to view the content associated with the task.
Connect app scope required: READ
read:inlinetask:confluence
string
Global ID of the inline task
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.asApp().requestConfluence(route`/wiki/rest/api/inlinetasks/{inlineTaskId}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());
Returned if the inline task was found given the global ID
Content type | Value |
---|---|
application/json |
PUT /wiki/rest/api/inlinetasks/{inlineTaskId}
Updates an inline tasks status given its global ID
Permissions required: Permission to update the content associated with the task.
Connect app scope required: WRITE
read:inlinetask:confluence
, write:inlinetask:confluence
string
Global ID of the inline task to update
string
Valid values: complete
, incomplete
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.asApp().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());
Returned if the inline task was successfully updated.
Content type | Value |
---|---|
application/json |
Rate this page: