Foreman tasks

>>>

GET /foreman_tasks/api/tasks/summary
Show task summary

>>>

GET /foreman_tasks/api/tasks/:id
Show task details

Params

Param Name Description
id
Optional

UUID of the task

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /foreman_tasks/api/tasks/bulk_search
List dynflow tasks for uuids

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.

Params

Param Name Description
searches
Optional

List of uuids to fetch info about

Validations:

  • 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.

Validations:

  • Must be String
searches[type]
Optional

Validations:

  • Must be one of: user, resource, task.
searches[task_id]
Optional

In case :type = 'task', find the task by the uuid

Validations:

  • Must be String
searches[user_id]
Optional

In case :type = 'user', find tasks for the user

Validations:

  • Must be String
searches[resource_type]
Optional

In case :type = 'resource', what resource type we're searching the tasks for

Validations:

  • Must be String
searches[resource_type]
Optional

In case :type = 'resource', what resource id we're searching the tasks for

Validations:

  • Must be String
searches[action_types]
Optional

Return just tasks of given action type, e.g. [“Actions::Katello::Repository::Synchronize”]

Validations:

  • Must be one of: String.
searches[active_only]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'
searches[page]
Optional

Validations:

  • Must be String
searches[per_page]
Optional

Validations:

  • Must be String
>>>

POST /foreman_tasks/api/tasks/bulk_resume
Resume all paused error tasks

Params

Param Name Description
search
Optional

Resume tasks matching search string

Validations:

  • Must be String
task_ids
Optional

Resume specific tasks by ID

Validations:

  • Must be an array of any type
>>>

GET /foreman_tasks/api/tasks
List tasks

Params

Param Name Description
search
Optional

Search string

Validations:

  • Must be String
page
Optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
Optional

Number of results per page to return

Validations:

  • Must be a number.
order
Optional

Sort field and order, e.g. 'name DESC'

Validations:

  • Must be String
sort
Optional

Hash version of 'order' param

Validations:

  • Must be a Hash
sort[by]
Optional

Field to sort the results on

Validations:

  • Must be String
sort[order]
Optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • Must be String
>>>

POST /foreman_tasks/api/tasks/callback
Send data to the task from external executor (such as smart_proxy_dynflow)

Params

Param Name Description
callback
Optional

Validations:

  • Must be a Hash
callback[task_id]
Optional

UUID of the task

Validations:

  • 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

Validations:

  • Must be String
data
Optional

Data to be sent to the action

Validations:

  • Must be Hash