機械翻訳について

移動先

• リクエスト
• レスポンス

ワークフロー・ジョブ・テンプレートの更新

put

/api/v2/workflow_job_templates/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、このワークフロー・ジョブ・テンプレートを更新します。 次のフィールドを変更できます。

• name: このワークフロー・ジョブ・テンプレートの名前。(文字列、必須)

• description: このワークフロー・ジョブ・テンプレートのオプションの説明。(文字列、デフォルト="")

• extra_vars: (json、デフォルト=``)

• organization: このテンプレートへのアクセス権を決定するために使用される組織。(id、デフォルト=``)
• survey_enabled: (ブール、デフォルト=False)
• allow_simultaneous: (ブール、デフォルト=False)
• ask_variables_on_launch: (ブール、デフォルト=False)
• inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id、デフォルト=``)
• limit: (文字列、デフォルト="")
• scm_branch: (文字列、デフォルト="")
• ask_inventory_on_launch: (ブール、デフォルト=False)
• ask_scm_branch_on_launch: (ブール、デフォルト=False)
• ask_limit_on_launch: (ブール、デフォルト=False)
• webhook_service: Webフック・リクエストを受け入れるサービス(選択)
  • "": ---------
  • github: GitHub
  • gitlab: GitLab
  • bitbucket_dc: BitBucket DataCenter
• webhook_credential: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id、デフォルト=``)
• ask_labels_on_launch: (ブール、デフォルト=False)
• ask_skip_tags_on_launch: (boolean, default=False)
• ask_tags_on_launch: (boolean, default=False)
• skip_tags: (string, default="")
• job_tags: (string, default="")

PUTリクエストの場合は、リクエストにすべてのフィールドを含めます。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id(required): string

本文()

ルート・スキーマ : 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
  タイトル: Related

  読取り専用: true
• 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フック・リクエストの受入れ元となるサービス

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "ok",
                "missing",
                "none",
                "updating"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "survey_enabled":{
            "title":"Survey enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "title":"Webhook credential",
            "type":"integer",
            "x-nullable":true
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "enum":[
                "github",
                "gitlab",
                "bitbucket_dc"
            ],
            "title":"Webhook service",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• 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
  タイトル: Related

  読取り専用: true
• 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フック・リクエストの受入れ元となるサービス

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "ok",
                "missing",
                "none",
                "updating"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "survey_enabled":{
            "title":"Survey enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "title":"Webhook credential",
            "type":"integer",
            "x-nullable":true
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "enum":[
                "github",
                "gitlab",
                "bitbucket_dc"
            ],
            "title":"Webhook service",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る