Server
Confluence Data Center / / REST API
GET

Get task by ID

Returns information about a long-running task.

Request

Path parameters

id

string

Required

Query parameters

expand

string

Responses

returns a full JSON representation of a long task.

application/json

LongTaskStatus
GET/rest/api/longtask/{id}
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/longtask/{id}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 { "id": "<string>", "name": { "translation": "<string>", "key": "<string>", "args": [ {} ] }, "elapsedTime": 123456, "percentageComplete": 50, "successful": true, "messages": [ { "translation": "<string>", "key": "<string>", "args": [ {} ] } ], "_links": { "base": "<string>", "context": "<string>", "self": "<string>" }, "_expandable": { "attribute": "<string>" } }
GET

Get tasks

Returns information about all tracked long-running tasks.

Request

Query parameters

expand

string

limit

string

start

string

Responses

returns a full JSON representation of a list of long tasks.

application/json

object
GET/rest/api/longtask
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/longtask' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 { "results": [ { "id": "<string>", "name": { "translation": "<string>", "key": "<string>", "args": [ {} ] }, "elapsedTime": 123456, "percentageComplete": 50, "successful": true, "messages": [ { "translation": "<string>", "key": "<string>", "args": [ {} ] } ], "_links": { "base": "<string>", "context": "<string>", "self": "<string>" }, "_expandable": { "attribute": "<string>" } } ], "totalCount": 2154, "start": 25, "limit": 25, "size": 25, "_links": { "base": "http://localhost:8085/confluence", "context": "confluence", "self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25", "next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50", "prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0" } }

Rate this page: