tasks

get

Get tasks

Returns all tasks. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only tasks that the user has permission to view will be returned.

GET /tasks

Flag	Type	Required	Description
--assigned-to	string	No	Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified.
--blogpost-id	string	No	Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.
--body-format	string	No	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
--completed-at-from	string	No	Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
--completed-at-to	string	No	Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
--completed-by	string	No	Filters on the Account ID of the user who completed this task. Multiple IDs can be specified.
--created-at-from	string	No	Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
--created-at-to	string	No	Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
--created-by	string	No	Filters on the Account ID of the user who created this task. Multiple IDs can be specified.
--cursor	string	No	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
--due-at-from	string	No	Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
--due-at-to	string	No	Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
--include-blank-tasks	string	No	Specifies whether to include blank tasks in the response. Defaults to true.
--limit	string	No	Maximum number of tasks per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
--page-id	string	No	Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.
--space-id	string	No	Filters on the space ID of the task. Multiple IDs can be specified.
--status	string	No	Filters on the status of the task.
--task-id	string	No	Filters on task ID. Multiple IDs can be specified.

Example:

cf tasks get

get-by-id

Get task by id

Returns a specific task.

Permissions required: Permission to view the containing page or blog post and its corresponding space.

GET /tasks/{id}

Flag	Type	Required	Description
--body-format	string	No	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
--id	string	Yes	The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results.

Example:

cf tasks get-by-id --id <id>

update

Update task

Update a task by id. This endpoint currently only supports updating task status.

Permissions required: Permission to edit the containing page or blog post and view its corresponding space.

PUT /tasks/{id}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--body-format	string	No	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
--id	string	Yes	The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results.

Example:

cf tasks update --id <id>