ワークフロー・ジョブ・テンプレートの更新
patch
/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: GitHubgitlab: GitLab
webhook_credential: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id、デフォルト=``)
PATCHリクエストの場合は、変更中のフィールドのみを含めます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- search(オプション): 文字列
検索条件。
ルート・スキーマ : schema
例:
{
"name":"foooooo"
}レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"allow_simultaneous":false,
"ask_inventory_on_launch":false,
"ask_limit_on_launch":false,
"ask_scm_branch_on_launch":false,
"ask_variables_on_launch":false,
"created":"2018-02-01T08:00:00.000000Z",
"description":"",
"extra_vars":"",
"id":1,
"inventory":null,
"last_job_failed":false,
"last_job_run":null,
"limit":null,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"foooooo",
"next_job_run":null,
"organization":1,
"related":{
"access_list":"/api/v2/workflow_job_templates/1/access_list/",
"activity_stream":"/api/v2/workflow_job_templates/1/activity_stream/",
"copy":"/api/v2/workflow_job_templates/1/copy/",
"labels":"/api/v2/workflow_job_templates/1/labels/",
"launch":"/api/v2/workflow_job_templates/1/launch/",
"notification_templates_approvals":"/api/v2/workflow_job_templates/1/notification_templates_approvals/",
"notification_templates_error":"/api/v2/workflow_job_templates/1/notification_templates_error/",
"notification_templates_started":"/api/v2/workflow_job_templates/1/notification_templates_started/",
"notification_templates_success":"/api/v2/workflow_job_templates/1/notification_templates_success/",
"object_roles":"/api/v2/workflow_job_templates/1/object_roles/",
"organization":"/api/v2/organizations/1/",
"schedules":"/api/v2/workflow_job_templates/1/schedules/",
"survey_spec":"/api/v2/workflow_job_templates/1/survey_spec/",
"webhook_key":"/api/v2/workflow_job_templates/1/webhook_key/",
"webhook_receiver":"",
"workflow_jobs":"/api/v2/workflow_job_templates/1/workflow_jobs/",
"workflow_nodes":"/api/v2/workflow_job_templates/1/workflow_nodes/"
},
"scm_branch":null,
"status":"never updated",
"summary_fields":{
"labels":{
"count":0,
"results":[
]
},
"object_roles":{
"admin_role":{
"description":"Can manage all aspects of the workflow job template",
"id":16,
"name":"Admin"
},
"approval_role":{
"description":"Can approve or deny a workflow approval node",
"id":19,
"name":"Approve"
},
"execute_role":{
"description":"May run the workflow job template",
"id":17,
"name":"Execute"
},
"read_role":{
"description":"May view settings for the workflow job template",
"id":18,
"name":"Read"
}
},
"organization":{
"description":"test-org-desc",
"id":1,
"name":"test-org"
},
"recent_jobs":[
],
"user_capabilities":{
"copy":true,
"delete":true,
"edit":true,
"schedule":true,
"start":true
}
},
"survey_enabled":false,
"type":"workflow_job_template",
"url":"/api/v2/workflow_job_templates/1/",
"webhook_credential":null,
"webhook_service":""
}