スケジュールの更新
put
/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デバッグ)
execution_environment
: 実行に使用されるコンテナ・イメージ。(id、デフォルト=``)forks
: (integer, default=None
)job_slice_count
: (integer, default=None
)timeout
: (integer, default=None
)unified_job_template
: (id、必須)enabled
: このスケジュールの処理を有効にします。(ブール、デフォルト=True
)
PUTリクエストの場合は、リクエストにすべてのフィールドを含めます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
ルート・スキーマ : スケジュール
型:
ソースを表示
object
- created: string
タイトル:
Created
読取り専用:true
- description: string
タイトル:
Description
- diff_mode: boolean
タイトル:
Diff mode
- dtend: string(date-time)
タイトル:
Dtend
読取り専用:true
スケジュールの最後の発生はこの時間より前に発生し、多くの場合スケジュールの期限が切れます。 - dtstart: string(date-time)
タイトル:
Dtstart
読取り専用:true
スケジュールの最初の出現は、この時間以降に発生します。 - enabled: boolean
タイトル:
Enabled
デフォルト値:true
このスケジュールの処理を有効にします。 - execution_environment: integer
タイトル:
Execution environment
実行に使用するコンテナ・イメージ。 - extra_data: object Extra data
タイトル:
Extra data
- forks: integer
タイトル:
Forks
最小値:0
- id: integer
タイトル:
ID
読取り専用:true
- inventory: integer
タイトル:
Inventory
プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する) - job_slice_count: integer
タイトル:
Job slice count
最小値:0
- job_tags: string
タイトル:
Job tags
- job_type: string
タイトル:
Job type
指定できる値:[ "run", "check" ]
- limit: string
タイトル:
Limit
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- next_run: string(date-time)
タイトル:
Next run
読取り専用:true
スケジュール済アクションが次回実行されるとき。 - related: string
- rrule(required): string
タイトル:
Rrule
最小長:1
スケジュールのiCal繰返しルールを表す値。 - scm_branch: string
タイトル:
Scm branch
- skip_tags: string
タイトル:
Skip tags
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- timeout: integer
タイトル:
Timeout
- timezone: string
タイトル:
Timezone
読取り専用:true
このスケジュールが実行されるタイムゾーン。 このフィールドはRRULEから抽出されます。 RRULEのタイムゾーンが別のタイムゾーンへのリンクである場合、リンクはこのフィールドに反映されます。 - type: string
タイトル:
Type
読取り専用:true
- unified_job_template(required): integer
タイトル:
Unified job template
- until: string
タイトル:
Until
読取り専用:true
このスケジュールが終了する日付。 このフィールドはRRULEから計算されます。 スケジュールが終了しない場合、空の文字列が返されます - url: string
タイトル:
Url
読取り専用:true
- verbosity: string
タイトル:
Verbosity
指定できる値:[ "0", "1", "2", "3", "4", "5" ]
ネストされたスキーマ : 追加データ
型:
object
タイトル:
Extra data
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ルート・スキーマ : スケジュール
型:
ソースを表示
object
- created: string
タイトル:
Created
読取り専用:true
- description: string
タイトル:
Description
- diff_mode: boolean
タイトル:
Diff mode
- dtend: string(date-time)
タイトル:
Dtend
読取り専用:true
スケジュールの最後の発生はこの時間より前に発生し、多くの場合スケジュールの期限が切れます。 - dtstart: string(date-time)
タイトル:
Dtstart
読取り専用:true
スケジュールの最初の出現は、この時間以降に発生します。 - enabled: boolean
タイトル:
Enabled
デフォルト値:true
このスケジュールの処理を有効にします。 - execution_environment: integer
タイトル:
Execution environment
実行に使用するコンテナ・イメージ。 - extra_data: object Extra data
タイトル:
Extra data
- forks: integer
タイトル:
Forks
最小値:0
- id: integer
タイトル:
ID
読取り専用:true
- inventory: integer
タイトル:
Inventory
プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する) - job_slice_count: integer
タイトル:
Job slice count
最小値:0
- job_tags: string
タイトル:
Job tags
- job_type: string
タイトル:
Job type
指定できる値:[ "run", "check" ]
- limit: string
タイトル:
Limit
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- next_run: string(date-time)
タイトル:
Next run
読取り専用:true
スケジュール済アクションが次回実行されるとき。 - related: string
- rrule(required): string
タイトル:
Rrule
最小長:1
スケジュールのiCal繰返しルールを表す値。 - scm_branch: string
タイトル:
Scm branch
- skip_tags: string
タイトル:
Skip tags
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- timeout: integer
タイトル:
Timeout
- timezone: string
タイトル:
Timezone
読取り専用:true
このスケジュールが実行されるタイムゾーン。 このフィールドはRRULEから抽出されます。 RRULEのタイムゾーンが別のタイムゾーンへのリンクである場合、リンクはこのフィールドに反映されます。 - type: string
タイトル:
Type
読取り専用:true
- unified_job_template(required): integer
タイトル:
Unified job template
- until: string
タイトル:
Until
読取り専用:true
このスケジュールが終了する日付。 このフィールドはRRULEから計算されます。 スケジュールが終了しない場合、空の文字列が返されます - url: string
タイトル:
Url
読取り専用:true
- verbosity: string
タイトル:
Verbosity
指定できる値:[ "0", "1", "2", "3", "4", "5" ]
ネストされたスキーマ : 追加データ
型:
object
タイトル:
Extra data