TaskBlockService
Manages tasks with blocks on the XL Deploy Server.
GET | /tasks/v2/current | Returns the active tasks of the logged in user. |
GET | /tasks/v2/current/all | Returns all active tasks for all users. |
GET | /tasks/v2/export | Searches for tasks with detailed step information. |
GET | /tasks/v2/query | Searches for archived tasks without step information. |
GET | /tasks/v2/{taskid} | Returns a task by ID. |
DELETE | /tasks/v2/{taskid} | Cancels a stopped task. |
POST | /tasks/v2/{taskid}/abort | Aborts an active task. |
POST | /tasks/v2/{taskid}/add-pause/{stepPath} | Add a pause step at the specified position. |
POST | /tasks/v2/{taskid}/archive | Archive an executed task. |
POST | /tasks/v2/{taskid}/assign/{owner} | Assigns a task to a different user. |
GET | /tasks/v2/{taskid}/block/{blockPath} | Returns a block by ID. |
GET | /tasks/v2/{taskid}/block/{blockPath}/step | Returns a block with steps by ID. |
POST | /tasks/v2/{taskid}/schedule | Schedules a task. |
POST | /tasks/v2/{taskid}/skip | Indicates that one or more steps should be skipped. |
POST | /tasks/v2/{taskid}/start | Starts a task. |
GET | /tasks/v2/{taskid}/step/{stepPath} | Retrieves information about a step. |
POST | /tasks/v2/{taskid}/stop | Gracefully stops an active task. |
POST | /tasks/v2/{taskid}/takeover/{owner} | Takeover a task from the owner. |
POST | /tasks/v2/{taskid}/unskip | Indicates that one or more steps should no longer be skipped, but executed. |
GET /tasks/v2/current
Returns the active tasks of the logged in user.
- Response body
- List of TaskWithBlock - a list of tasks with blocks.
- Content type: application/xml
GET /tasks/v2/current/all
Returns all active tasks for all users. Only allowed for admin.
- Response body
- List of TaskWithBlock - a list of tasks with blocks.
- Content type: application/xml
GET /tasks/v2/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 null
for no such limit.Query enddate LocalDate The last day we want to see tasks from, or null
for no such limit.
- Response body
- List of TaskWithBlock - a list of tasks with step information.
- Content type: application/xml
GET /tasks/v2/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 null
for no such limit.Query enddate LocalDate The last day we want to see tasks from, or null
for no such limit.
- Response body
- List of TaskWithBlock - a list of tasks.
- Content type: application/xml
GET /tasks/v2/{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
- TaskWithBlock - the task with blocks.
- Content type: application/xml
DELETE /tasks/v2/{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 /tasks/v2/{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 /tasks/v2/{taskid}/add-pause/{stepPath}
Add a pause step at the specified position.
- Permissions
-
Available
- only to admin and owner of the task
- Response body
- StepBlockState - a task with full step information.
- Content type: application/xml
POST /tasks/v2/{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 /tasks/v2/{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
- TaskWithBlock - the task.
- Content type: application/xml
GET /tasks/v2/{taskid}/block/{blockPath}
Returns a block by ID.
- Permissions
-
Available
- only to admin and owner of the task
- Response body
- BlockState - the block.
- Content type: application/xml
GET /tasks/v2/{taskid}/block/{blockPath}/step
Returns a block with steps by ID.
- Permissions
-
Available
- only to admin and owner of the task
- Response body
- StepBlockState - the block with steps.
- Content type: application/xml
POST /tasks/v2/{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 /tasks/v2/{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 List of String the paths of the steps to skip
- Response body
- TaskWithBlock - a task
- Content type: application/xml
POST /tasks/v2/{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 /tasks/v2/{taskid}/step/{stepPath}
Retrieves information about a step. The call returns a response with status code of 304 (Not Modified) if the step has not been modified since
ifModifiedSince
,
otherwise returns a status code of 200 (OK) and the XML containing a StepState.- Permissions
-
Available
- only to admin and owner of the task
- Parameters
-
Path taskid String the ID of the task Path stepPath String the path of the step in the block tree. Header If-Modified-Since DateTime the if-modified-since date in RFC 1123 (RFC 822 with 4-digit years) date format.
- Response body
- StepState
- XML containing a StepState if the step has not been modified since
ifModifiedSince
- Content type: application/xml
POST /tasks/v2/{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 /tasks/v2/{taskid}/takeover/{owner}
Takeover a task from the owner. This will re-assign the task to your logged in user.
This is the reverse of the #assign(String, String)
method, which allows you to re-assign
a task.
- 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
- TaskWithBlock - the task you took over.
- Content type: application/xml
POST /tasks/v2/{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 List of String the paths of the steps to unskip
- Response body
- TaskWithBlock - a task
- Content type: application/xml