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

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer


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

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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.


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

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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


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

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

search
Optional

Resume tasks matching search string

Validations:

  • Must be a 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
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

search
Optional

Search string

Validations:

  • Must be a String

page
Optional

Číslo stránky, začíná od jedničky

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 a 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 a String

sort[order]
Optional

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

Validations:

  • Must be a String


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

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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 a String

data
Optional

Data to be sent to the action

Validations:

  • Must be a Hash

callbacks
Optional

Validations:

  • Must be an Array of nested elements

callbacks[callback]
Optional

Validations:

  • Must be a Hash

callbacks[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.

callbacks[callback][step_id]
Optional

The ID of the step inside the execution plan to send the event to

Validations:

  • Must be a String

callbacks[data]
Optional

Data to be sent to the action

Validations:

  • Must be a Hash