ジョブ・テンプレートのワークフロー・ジョブの作成
post
/api/v2/job_templates/{id}/slice_workflow_jobs/
次のワークフロー・ジョブ・フィールドを指定してこのリソースに対してPOSTリクエストを行って、このジョブ・テンプレートに関連付けられた新しいワークフロー・ジョブを作成します。
name
: このワークフロー・ジョブの名前。(文字列、必須)-
description
: このワークフロー・ジョブのオプションの説明。(文字列、デフォルト=""
) -
workflow_job_template
: (id、デフォルト=``) extra_vars
: (json、デフォルト=``)-
allow_simultaneous
: (ブール、デフォルト=False
) -
is_sliced_job
: (ブール、デフォルト=False
) inventory
: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id、デフォルト=``)limit
: (文字列、デフォルト=""
)scm_branch
: (文字列、デフォルト=""
)webhook_service
: Webフック・リクエストを受け入れるサービス(選択)""
: ---------github
: GitHubgitlab
: GitLabbitbucket_dc
: BitBucket DataCenter
webhook_credential
: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id、デフォルト=``)webhook_guid
: このWebフックをトリガーしたイベントの一意の識別子(文字列、デフォルト=""
)skip_tags
: (string, default=""
)job_tags
: (string, default=""
)
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
ルート・スキーマ : WorkflowJobList
型:
ソースを表示
object
- allow_simultaneous: boolean
タイトル:
Allow simultaneous
- canceled_on: string(date-time)
タイトル:
Canceled on
読取り専用:true
取消リクエストが送信された日時。 - created: string
タイトル:
Created
読取り専用:true
- description: string
タイトル:
Description
- elapsed: string(decimal)
タイトル:
Elapsed
読取り専用:true
ジョブが実行された経過時間(秒)。 - extra_vars: string
タイトル:
Extra vars
- failed: boolean
タイトル:
Failed
読取り専用:true
- finished: string(date-time)
タイトル:
Finished
読取り専用:true
ジョブの実行が終了した日時。 - id: integer
タイトル:
ID
読取り専用:true
- inventory: integer
タイトル:
Inventory
プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する) - is_sliced_job: boolean
タイトル:
Is sliced job
- job_explanation: string
タイトル:
Job explanation
読取り専用:true
最小長:1
ジョブが実行および取得できなかった場合にジョブの状態を示すステータス・フィールド - job_tags: string
タイトル:
Job tags
- job_template: string
タイトル:
Job template
スライスされたジョブの実行用に自動的に作成された場合、ワークフロー・ジョブの作成元となったジョブ・テンプレート。 - launch_type: string
タイトル:
Launch type
読取り専用:true
指定できる値:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
- launched_by: string
タイトル:
Launched by
読取り専用:true
- limit: string
タイトル:
Limit
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- related: string
- scm_branch: string
タイトル:
Scm branch
- skip_tags: string
タイトル:
Skip tags
- started: string(date-time)
タイトル:
Started
読取り専用:true
ジョブが開始のためにキューに入れられた日時。 - status: string
タイトル:
Status
読取り専用:true
指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- type: string
タイトル:
Type
読取り専用:true
- unified_job_template: string
タイトル:
unified job template
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true
- webhook_credential: integer
タイトル:
Webhook credential
サービスAPIにステータスをポスト・バックするための個人アクセス・トークン - webhook_guid: string
タイトル:
Webhook guid
最大長:128
このWebフックをトリガーしたイベントの一意の識別子 - webhook_service: string
タイトル:
Webhook service
指定できる値:[ "github", "gitlab", "bitbucket_dc" ]
Webフック・リクエストの受入れ元となるサービス - work_unit_id: string
タイトル:
Work unit id
読取り専用:true
最小長:1
このジョブに関連付けられた受容体作業ユニットID。 - workflow_job_template: string
タイトル:
Workflow job template
レスポンス
サポートされているメディア・タイプ
- application/json
201レスポンス
ルート・スキーマ : WorkflowJobList
型:
ソースを表示
object
- allow_simultaneous: boolean
タイトル:
Allow simultaneous
- canceled_on: string(date-time)
タイトル:
Canceled on
読取り専用:true
取消リクエストが送信された日時。 - created: string
タイトル:
Created
読取り専用:true
- description: string
タイトル:
Description
- elapsed: string(decimal)
タイトル:
Elapsed
読取り専用:true
ジョブが実行された経過時間(秒)。 - extra_vars: string
タイトル:
Extra vars
- failed: boolean
タイトル:
Failed
読取り専用:true
- finished: string(date-time)
タイトル:
Finished
読取り専用:true
ジョブの実行が終了した日時。 - id: integer
タイトル:
ID
読取り専用:true
- inventory: integer
タイトル:
Inventory
プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する) - is_sliced_job: boolean
タイトル:
Is sliced job
- job_explanation: string
タイトル:
Job explanation
読取り専用:true
最小長:1
ジョブが実行および取得できなかった場合にジョブの状態を示すステータス・フィールド - job_tags: string
タイトル:
Job tags
- job_template: string
タイトル:
Job template
スライスされたジョブの実行用に自動的に作成された場合、ワークフロー・ジョブの作成元となったジョブ・テンプレート。 - launch_type: string
タイトル:
Launch type
読取り専用:true
指定できる値:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
- launched_by: string
タイトル:
Launched by
読取り専用:true
- limit: string
タイトル:
Limit
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- related: string
- scm_branch: string
タイトル:
Scm branch
- skip_tags: string
タイトル:
Skip tags
- started: string(date-time)
タイトル:
Started
読取り専用:true
ジョブが開始のためにキューに入れられた日時。 - status: string
タイトル:
Status
読取り専用:true
指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- type: string
タイトル:
Type
読取り専用:true
- unified_job_template: string
タイトル:
unified job template
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true
- webhook_credential: integer
タイトル:
Webhook credential
サービスAPIにステータスをポスト・バックするための個人アクセス・トークン - webhook_guid: string
タイトル:
Webhook guid
最大長:128
このWebフックをトリガーしたイベントの一意の識別子 - webhook_service: string
タイトル:
Webhook service
指定できる値:[ "github", "gitlab", "bitbucket_dc" ]
Webフック・リクエストの受入れ元となるサービス - work_unit_id: string
タイトル:
Work unit id
読取り専用:true
最小長:1
このジョブに関連付けられた受容体作業ユニットID。 - workflow_job_template: string
タイトル:
Workflow job template