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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer


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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
optionel

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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
optionel

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/sub_tasks
Show sub_tasks details

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
optionel

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

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

search
optionel

Resume tasks matching search string

Validations:

  • Must be a String

task_ids
optionel

Resume specific tasks by ID

Validations:

  • Must be an array of any type


POST /foreman_tasks/api/tasks/bulk_cancel
Cancel all cancellable tasks

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

search
optionel

Cancel tasks matching search string

Validations:

  • Must be a String

task_ids
optionel

Cancel specific tasks by ID

Validations:

  • Must be an array of any type


GET /foreman_tasks/api/tasks
List tasks

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

search
optionel

Search string

Validations:

  • Must be a String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

order
optionel

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

Validations:

  • Must be a String

sort
optionel

Hash version of 'order' param

Validations:

  • Must be a Hash

sort[by]
optionel

Field to sort the results on

Validations:

  • Must be a String

sort[order]
optionel

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)

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

callback
optionel

Validations:

  • Must be a Hash

callback[task_id]
optionel

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]
optionel

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

Validations:

  • Must be a String

data
optionel

Data to be sent to the action

Validations:

  • Must be a Hash

callbacks
optionel

Validations:

  • Must be an Array of nested elements

callbacks[callback]
optionel

Validations:

  • Must be a Hash

callbacks[callback][task_id]
optionel

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]
optionel

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

Validations:

  • Must be a String

callbacks[data]
optionel

Data to be sent to the action

Validations:

  • Must be a Hash