TaskService
Deprecated: (Deprecated)
Manages tasks on the XL Deploy Server.
| GET | /task/current | Returns the active tasks of the logged in user. |
| GET | /task/current/all | Returns all active tasks for all users. |
| GET | /task/export | Searches for tasks with detailed step information. |
| GET | /task/query | Searches for archived tasks without step information. |
| GET | /task/{taskid} | Returns a task by ID. |
| DELETE | /task/{taskid} | Cancels a stopped task. |
| POST | /task/{taskid}/abort | Aborts an active task. |
| POST | /task/{taskid}/archive | Archive an executed task. |
| POST | /task/{taskid}/assign/{owner} | Assigns a task to a different user. |
| POST | /task/{taskid}/pause/{stepId} | Add a pause step at the specified position. |
| POST | /task/{taskid}/schedule | Schedules a task. |
| POST | /task/{taskid}/skip | Indicates that one or more steps should be skipped. |
| POST | /task/{taskid}/start | Starts a task. |
| GET | /task/{taskid}/step | Returns a task containing step information. |
| GET | /task/{taskid}/step/{stepId} | Retrieves information about a step. |
| POST | /task/{taskid}/stop | Gracefully stops an active task. |
| POST | /task/{taskid}/takeover/{owner} | Takeover a task from the owner. |
| POST | /task/{taskid}/unskip | Indicates that one or more steps should no longer be skipped, but executed. |
GET /task/current
Returns the active tasks of the logged in user.
- Response body
- TaskState - a list of tasks.
- Content type: application/xml
GET /task/current/all
Returns all active tasks for all users.
- Response body
- TaskState - a list of tasks.
- Content type: application/xml
GET /task/export
Searches for tasks with detailed step information.
- Permissions
-
report#view
- Parameters
-
Query begindate LocalDate The first day we want to see tasks from, or {@code null} for no such limit. Query enddate LocalDate The last day we want to see tasks from, or {@code null} for no such limit.
- Response body
- TaskWithSteps - a list of tasks with step information.
- Content type: application/xml
GET /task/query
Searches for archived tasks without step information.
- Permissions
-
report#view
- Parameters
-
Query begindate LocalDate The first day we want to see tasks from, or {@code null} for no such limit. Query enddate LocalDate The last day we want to see tasks from, or {@code null} for no such limit.
- Response body
- TaskState - a list of tasks.
- Content type: application/xml
GET /task/{taskid}
Returns a task by ID.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task
- Response body
- TaskState - the task.
- Content type: application/xml
DELETE /task/{taskid}
Cancels a stopped task.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task
- Response body
- Empty
POST /task/{taskid}/abort
Aborts an active task.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task
- Response body
- Empty
POST /task/{taskid}/archive
Archive an executed task.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task
- Response body
- Empty
POST /task/{taskid}/assign/{owner}
Assigns a task to a different user.
- Permissions
-
task#assign
- Parameters
-
Path taskid String the ID of the task Path owner String the name of the user that will be the new owner of the task.
- Response body
- TaskState - the task.
- Content type: application/xml
POST /task/{taskid}/pause/{stepId}
Add a pause step at the specified position.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task Path stepId int the position of the step in the step list.
- Response body
- TaskWithSteps - a task with full step information.
- Content type: application/xml
POST /task/{taskid}/schedule
Schedules a task.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task Query time DateTime the local time (including the local timezone) when the task should be started by the server.
- Response body
- Empty
POST /task/{taskid}/skip
Indicates that one or more steps should be skipped.
- Permissions
-
task#skip_step
- Parameters
-
Path taskid String the ID of the task Request body application/xml Integer the IDs of the steps to skip
- Response body
- TaskWithSteps - a task with full step information.
- Content type: application/xml
POST /task/{taskid}/start
Starts a task.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task
- Response body
- Empty
GET /task/{taskid}/step
Returns a task containing step information.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task
- Response body
- TaskWithSteps - a task with full step information.
- Content type: application/xml
GET /task/{taskid}/step/{stepId}
Retrieves information about a step. If the step has not been modified since {@code ifModifiedSince}, a response with status code of 304 (Not Modified), otherwise returns a
response with a status code of 200 (OK) and XML containing a StepState.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task Path stepId int the ordinal number of the step, starting from 1 Header If-Modified-Since DateTime the if-modified-since date in RFC 1123 (RFC 822 with 4-digit years) date format.
- Response body
- StepState - a stepStep
- Content type: application/xml
POST /task/{taskid}/stop
Gracefully stops an active task.
- Permissions
-
Available- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task
- Response body
- Empty
POST /task/{taskid}/takeover/{owner}
Takeover a task from the owner.
- Permissions
-
task#takeover
- Parameters
-
Path taskid String the ID of the task to take over Path owner String the current owner of the task
- Response body
- TaskState - the task you took over.
- Content type: application/xml
POST /task/{taskid}/unskip
Indicates that one or more steps should no longer be skipped, but executed.
- Permissions
-
task#skip_step
- Parameters
-
Path taskid String the ID of the task Request body application/xml Integer the IDs of the steps to unskip
- Response body
- TaskWithSteps - a task with full step information.
- Content type: application/xml