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

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer


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

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
任意

タスクの UUID

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

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
任意

タスクの UUID

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

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
任意

タスクの UUID

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
一時停止されたすべてのエラータスクを再開

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

search
任意

検索文字列に一致するタスクを再開

Validations:

  • Must be a String

task_ids
任意

ID 別に特定のタスクを再開

Validations:

  • Must be an array of any type


POST /foreman_tasks/api/tasks/bulk_cancel
キャンセル可能な全タスクをキャンセル

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

search
任意

検索文字列に一致するタスクをキャンセル

Validations:

  • Must be a String

task_ids
任意

ID 別に特定のタスクをキャンセル

Validations:

  • Must be an array of any type


POST /foreman_tasks/api/tasks/bulk_stop
Stop all stoppable tasks

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

search
任意

Stop tasks matching search string

Validations:

  • Must be a String

task_ids
任意

Stop specific tasks by ID

Validations:

  • Must be an array of any type


GET /foreman_tasks/api/tasks
タスクの一覧を表示します。

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

search
任意

検索文字列

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

order
任意

フィールドと順序のソート (例: 'name DESC')

Validations:

  • Must be a String

sort
任意

ハッシュバージョンの 'order' パラメーター

Validations:

  • Must be a Hash

sort[by]
任意

結果をソートするフィールド

Validations:

  • Must be a String

sort[order]
任意

ソートされた結果を順序付ける方法 (例: ascending (昇順) の ASC)

Validations:

  • Must be a String


POST /foreman_tasks/api/tasks/callback
外部のエグゼキューター (smart_proxy_dynflow など) からタスクにデータを送信

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

callback
任意

Validations:

  • Must be a Hash

callback[task_id]
任意

タスクの UUID

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

イベントの送信先の実行プラン内のステップ ID

Validations:

  • Must be a String

data
任意

アクションに送信されるデータ

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

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

イベントの送信先の実行プラン内のステップ ID

Validations:

  • Must be a String

callbacks[data]
任意

アクションに送信されるデータ

Validations:

  • Must be a Hash