| Param Name | Description |
|---|---|
|
id Optional |
UUID of the task Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |
For every search it returns the list of tasks that satisfty the condition. The reason for supporting multiple searches is the UI that might be ending needing periodic updates on task status for various searches at the same time. This way, it is possible to get all the task statuses with one request.
| Param Name | Description |
|---|---|
|
searches Optional |
List of uuids to fetch info about Value: Must be an Array of nested elements |
|
searches[search_id] Optional |
Arbitraty value for client to identify the the request parts with results. It's passed in the results to be able to pair the requests and responses properly. Value: Must be String |
|
searches[type] Optional |
Value: Must be one of: user, resource, task. |
|
searches[task_id] Optional |
In case :type = 'task', find the task by the uuid Value: Must be String |
|
searches[user_id] Optional |
In case :type = 'user', find tasks for the user Value: Must be String |
|
searches[resource_type] Optional |
In case :type = 'resource', what resource type we're searching the tasks for Value: Must be String |
|
searches[resource_type] Optional |
In case :type = 'resource', what resource id we're searching the tasks for Value: Must be String |
|
searches[action_types] Optional |
Return just tasks of given action type, e.g. ["Actions::Katello::Repository::Synchronize"] Value: Must be one of: String. |
|
searches[active_only] Optional |
Value: Must be 'true' or 'false' |
|
searches[page] Optional |
Value: Must be String |
|
searches[per_page] Optional |
Value: Must be String |
| Param Name | Description |
|---|---|
|
search Optional |
Resume tasks matching search string Value: Must be String |
|
task_ids Optional |
Resume specific tasks by id Value: Must be an array of any type |
| Param Name | Description |
|---|---|
|
search Optional |
Search string Value: Must be String |
|
page Optional |
Page number, starting at 1 Value: Must be a number. |
|
per_page Optional |
Number of results per page to return Value: Must be a number. |
|
order Optional |
Sort field and order, eg. 'name DESC' Value: Must be String |
|
sort Optional |
Hash version of 'order' param Value: Must be a Hash |
|
sort[by] Optional |
Field to sort the results on Value: Must be String |
|
sort[order] Optional |
How to order the sorted results (e.g. ASC for ascending) Value: Must be String |
| Param Name | Description |
|---|---|
|
callback Optional |
Value: Must be a Hash |
|
callback[task_id] Optional |
UUID of the task Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |
|
callback[step_id] Optional |
The id of the step inside the execution plan to send the event to Value: Must be String |
|
data Optional |
Data to be sent to the action Value: Must be Hash |