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

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
选填

设置请求的当前位置上下文

Validations:

  • Must be a Integer

organization_id
选填

设置请求的当前组织上下文

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
选填

设置请求的当前位置上下文

Validations:

  • Must be a Integer

organization_id
选填

设置请求的当前组织上下文

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
选填

设置请求的当前位置上下文

Validations:

  • Must be a Integer

organization_id
选填

设置请求的当前组织上下文

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
选填

设置请求的当前位置上下文

Validations:

  • Must be a Integer

organization_id
选填

设置请求的当前组织上下文

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
选填

设置请求的当前位置上下文

Validations:

  • Must be a Integer

organization_id
选填

设置请求的当前组织上下文

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
选填

设置请求的当前位置上下文

Validations:

  • Must be a Integer

organization_id
选填

设置请求的当前组织上下文

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]
选填

如何排序結果的順序(比方說 ASC 從下到上)

Validations:

  • Must be a String


POST /foreman_tasks/api/tasks/callback
從外部執行者(例如 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

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