スケジュールの更新
patch
/api/v2/schedules/{id}/
このリソースに対してPUTまたはPATCHリクエストを行って、このスケジュールを更新します。 次のフィールドを変更できます。
-
rrule: スケジュールのiCal繰返しルールを表す値。(文字列、必須) -
name: このスケジュールの名前。(文字列、必須) description: このスケジュールのオプションの説明。(文字列、デフォルト="")extra_data: (json、デフォルト={})inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id、デフォルト=``)scm_branch: (文字列、デフォルト="")job_type: (選択)None: --------- (デフォルト)"": ---------run: 実行check: チェック
job_tags: (文字列、デフォルト="")skip_tags: (文字列、デフォルト="")limit: (文字列、デフォルト="")diff_mode: (ブール、デフォルト=None)verbosity: (選択)None: --------- (デフォルト)0: 0 (標準)1: 1 (詳細)2: 2 (より詳細)3: 3 (デバッグ)4: 4 (接続デバッグ)5: 5 (WinRMデバッグ)
unified_job_template: (id、必須)enabled: このスケジュールの処理を有効にします。(ブール、デフォルト=True)
PATCHリクエストの場合は、変更中のフィールドのみを含めます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- search(オプション): 文字列
検索条件。
ルート・スキーマ : schema
例:
{
"extra_data":{
"var1":"bar"
}
}レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"created":"2018-02-01T08:00:00.000000Z",
"description":"",
"diff_mode":null,
"dtend":"2015-11-17T05:00:00Z",
"dtstart":"2015-11-17T05:00:00Z",
"enabled":true,
"extra_data":{
"var1":"$encrypted$"
},
"id":1,
"inventory":null,
"job_tags":null,
"job_type":null,
"limit":null,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"test sch",
"next_run":null,
"related":{
"credentials":"/api/v2/schedules/1/credentials/",
"inventory":"/api/v2/inventories/1/",
"project":"/api/v2/projects/1/",
"unified_job_template":"/api/v2/job_templates/2/",
"unified_jobs":"/api/v2/schedules/1/jobs/"
},
"rrule":"DTSTART:20151117T050000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1",
"scm_branch":null,
"skip_tags":null,
"summary_fields":{
"inventory":{
"description":"",
"has_active_failures":false,
"has_inventory_sources":false,
"hosts_with_active_failures":0,
"id":1,
"inventory_sources_with_failures":0,
"kind":"",
"name":"test-inv",
"organization_id":1,
"total_groups":0,
"total_hosts":0,
"total_inventory_sources":0
},
"unified_job_template":{
"description":"",
"id":2,
"name":"test-jt",
"unified_job_type":"job"
},
"user_capabilities":{
"delete":true,
"edit":true
}
},
"timezone":"UTC",
"type":"schedule",
"unified_job_template":2,
"until":"",
"url":"/api/v2/schedules/1/",
"verbosity":null
}