ワークフロー・ジョブ・テンプレートの取得
get
/api/v2/workflow_job_templates/{id}/
このリソースに対してGETリクエストを行って、次のフィールドを含む単一のワークフロー・ジョブ・テンプレート・レコードを取得します。
id
: このワークフロー・ジョブ・テンプレートのデータベースID。(整数)type
: このワークフロー・ジョブ・テンプレートのデータ型。(選択)url
: このワークフロー・ジョブ・テンプレートのURL。(文字列)related
: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields
: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created
: このワークフロー・ジョブ・テンプレートが作成されたときのタイムスタンプ。(日時)modified
: このワークフロー・ジョブ・テンプレートが最後に変更されたときのタイムスタンプ。(日時)name
: このワークフロー・ジョブ・テンプレートの名前。(文字列)description
: このワークフロー・ジョブ・テンプレートのオプションの説明。(文字列)last_job_run
: (日時)last_job_failed
: (ブール)next_job_run
: (日時)status
: (選択)new
: 新規pending
: 保留中waiting
: 待機中running
: 実行中successful
: 成功failed
: 失敗error
: エラーcanceled
: 取消し済never updated
: 更新なしok
: OKmissing
: 不明none
: 外部ソースなしupdating
: 更新中
extra_vars
: (json)organization
: このテンプレートへのアクセス権を決定するために使用される組織。(id)survey_enabled
: (ブール)allow_simultaneous
: (ブール)ask_variables_on_launch
: (ブール)inventory
: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id)limit
: (文字列)scm_branch
: (文字列)ask_inventory_on_launch
: (ブール)ask_scm_branch_on_launch
: (ブール)ask_limit_on_launch
: (ブール)webhook_service
: Webフック・リクエストを受け入れるサービス(選択)""
: ---------github
: GitHubgitlab
: GitLabbitbucket_dc
: BitBucket DataCenter
webhook_credential
: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id)ask_labels_on_launch
: (boolean)ask_skip_tags_on_launch
: (boolean)ask_tags_on_launch
: (boolean)skip_tags
: (文字列)job_tags
: (文字列)
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
先頭に戻る
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ルート・スキーマ : WorkflowJobTemplate
型:
ソースを表示
object
- allow_simultaneous: boolean
タイトル:
Allow simultaneous
- ask_inventory_on_launch: boolean
タイトル:
Ask inventory on launch
- ask_labels_on_launch: boolean
タイトル:
Ask labels on launch
- ask_limit_on_launch: boolean
タイトル:
Ask limit on launch
- ask_scm_branch_on_launch: boolean
タイトル:
Ask scm branch on launch
- ask_skip_tags_on_launch: boolean
タイトル:
Ask skip tags on launch
- ask_tags_on_launch: boolean
タイトル:
Ask tags on launch
- ask_variables_on_launch: boolean
タイトル:
Ask variables on launch
- created: string
タイトル:
Created
読取り専用:true
- description: string
タイトル:
Description
- extra_vars: string
タイトル:
Extra vars
- id: integer
タイトル:
ID
読取り専用:true
- inventory: integer
タイトル:
Inventory
ジョブ・テンプレートがインベントリを要求すると仮定して、プロンプトとして適用されたインベントリ - job_tags: string
タイトル:
Job tags
- last_job_failed: boolean
タイトル:
Last job failed
読取り専用:true
- last_job_run: string(date-time)
タイトル:
Last job run
読取り専用:true
- limit: string
タイトル:
Limit
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- next_job_run: string(date-time)
タイトル:
Next job run
読取り専用:true
- organization: integer
タイトル:
Organization
このテンプレートへのアクセスを決定するために使用される組織。 - related: string
- scm_branch: string
タイトル:
Scm branch
- skip_tags: string
タイトル:
Skip tags
- status: string
タイトル:
Status
読取り専用:true
指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- survey_enabled: boolean
タイトル:
Survey enabled
- type: string
タイトル:
Type
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true
- webhook_credential: integer
タイトル:
Webhook credential
サービスAPIにステータスを転記するための個人アクセス・トークン - webhook_service: string
タイトル:
Webhook service
指定できる値:[ "github", "gitlab", "bitbucket_dc" ]
webフック・リクエストを受け入れるサービス