{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
List All
Returns a list of all available tasks. The format of the result is JSON.
Note: The command requires the user to have the Administrative access to all Tasks
permission set.
GET /api/taskplanner/list/all
Requests a list of all available tasks.
RESPONSE Task Fields | Value Type | Description |
---|---|---|
id | string | The globally unique ID of the task |
name | string | The name of the task |
description | string | The description of the task |
owner | string | Displayname of the task's owner |
ownerId | number | ID of the task's owner |
Example Request
# Request GET /api/taskplanner/list/all HTTP/1.1 Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK Content-Type: application/json [ { "id": "3j6e0n7zb4qr6i9qx5ckwtxzp", "name": "Send monthly report to Mary", "description": "", "owner": "INETSOFTWARE\\Lucas", "ownerId": 65 }, { "id": "4w8yavnk046debwrwkcg4dbqh", "name": "Daily Backup", "description": "Performs backup of user settings", "owner": "INETSOFTWARE\\Admin", "ownerId": 12 }, { "id": "8icdcmt0l203ut3dwu1paud1z", "name": "Weekly Backup", "description": "Performs full backup", "owner": "INETSOFTWARE\\Admin", "ownerId": 12 } ]
Application Example
# Browser access http://127.0.0.1:9000/api/taskplanner/list/all # Shell access using curl curl -LsH "Authorization: Bearer <access_token>" "http://127.0.0.1:9000/api/taskplanner/list/all" # Shell access using curl using username and password curl -Lsu username:password "http://127.0.0.1:9000/api/taskplanner/list/all"