get /tasks
Gets the list of specified tasks.
Returns the list of tasks. If the appId parameter is specified, only tasks related to that app are returned.
Query parameters
- offset (optional)
- The number of entries to skip. Default is 0.
- limit (optional)
- The maximum number of entries to return. Default is 50.
- sort (optional)
A field to be used to sort the tasks. Currently the only supported field value is "created". It can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created.
Usage example: /tasks?sort=+created
- appId (optional)
- The ID of the app to filter on.
- type (optional)
The task type to filter on. Available values: ["publish","import"]. Default is publish.
Usage example: /tasks?type=publish
Return type
Example data
Content-Type: application/json
{
"data" : {
"totalItems" : 0,
"offset" : 6,
"limit" : 1,
"items" : [ {
"created" : "2000-01-23T04:56:07.000+00:00",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastExecution" : "2000-01-23T04:56:07.000+00:00",
"appId" : "appId",
"name" : "name",
"description" : "description",
"id" : "00000000-0000-0000-0000-000000000000",
"type" : "type",
"enabled" : true
}, {
"created" : "2000-01-23T04:56:07.000+00:00",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"lastExecution" : "2000-01-23T04:56:07.000+00:00",
"appId" : "appId",
"name" : "name",
"description" : "description",
"id" : "00000000-0000-0000-0000-000000000000",
"type" : "type",
"enabled" : true
} ]
}
}
Responses
- 200
- Success. A paginated list of tasks is returned.
- 400
- One of the following errors has occurred:There is an invalid parameter in the query string.The specified ID is not a valid GUID.