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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer


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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
任意

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

Resume tasks matching search string

Validations:

  • Must be a String

task_ids
任意

Resume specific tasks by ID

Validations:

  • Must be an array of any type


GET /foreman_tasks/api/tasks
List tasks

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

Search string

Validations:

  • Must be a String

page
任意

Page number, starting at 1

Validations:

  • Must be a number.

per_page
任意

Number of results per page to return

Validations:

  • Must be a number.

order
任意

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

Validations:

  • Must be a String

sort
任意

Hash version of 'order' param

Validations:

  • Must be a Hash

sort[by]
任意

Field to sort the results on

Validations:

  • Must be a String

sort[order]
任意

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)

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

callback
任意

Validations:

  • Must be a Hash

callback[task_id]
任意

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]
任意

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

Validations:

  • Must be a String

data
任意

Data to be sent to the action

Validations:

  • Must be a Hash

callbacks
任意

Validations:

  • Must be an Array of nested elements

callbacks[callback]
任意

Validations:

  • Must be a Hash

callbacks[callback][task_id]
任意

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]
任意

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

Validations:

  • Must be a String

callbacks[data]
任意

Data to be sent to the action

Validations:

  • Must be a Hash