移動先

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

システム・ジョブ・テンプレートのスケジュールの作成

post

/api/v2/system_job_templates/{id}/schedules/

次のスケジュール・フィールドを指定してこのリソースに対してPOSTリクエストを行って、このシステム・ジョブ・テンプレートに関連付けられる新しいスケジュールを作成します。

• 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: (整数、デフォルト=None)
• job_slice_count: (整数、デフォルト=None)

• timeout: (整数、デフォルト=None)

• enabled: このスケジュールの処理を有効にします。(ブール、デフォルト=True)

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : Schedule

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• diff_mode: ブール
  タイトル: Diff mode
• dtend: 文字列(日付-時間)
  タイトル: Dtend

  読取り専用: true

  最後のスケジュールはこの時間より前に発生し、これ以降、スケジュールは失効します。
• dtstart: 文字列(日付-時間)
  タイトル: Dtstart

  読取り専用: true

  初回のスケジュールはこの時間以降に発生します。
• enabled: ブール
  タイトル: Enabled

  デフォルト値: true

  このスケジュールの処理を有効にします。
• execution_environment: 整数
  タイトル: Execution environment

  実行に使用されるコンテナ・イメージ。
• extra_data: オブジェクト Extra data
  タイトル: Extra data
• forks: 整数
  タイトル: Forks

  最小値: 0
• id: 整数
  タイトル: ID

  読取り専用: true
• inventory: 整数
  タイトル: Inventory

  プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する)
• job_slice_count: 整数
  タイトル: Job slice count

  最小値: 0
• job_tags: 文字列
  タイトル: Job tags
• job_type: 文字列
  タイトル: Job type

  指定できる値: [ "run", "check" ]
• limit: 文字列
  タイトル: Limit
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• next_run: 文字列(日付-時間)
  タイトル: Next run

  読取り専用: true

  スケジュールされたアクションの次回の実行日時。
• related: 文字列
  タイトル: Related

  読取り専用: true
• rrule(必須): 文字列
  タイトル: Rrule

  最小長: 1

  スケジュールのiCal繰返しルールを表す値。
• scm_branch: 文字列
  タイトル: Scm branch
• skip_tags: 文字列
  タイトル: Skip tags
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• timeout: 整数
  タイトル: Timeout
• timezone: 文字列
  タイトル: Timezone

  読取り専用: true

  このスケジュールが実行されるタイムゾーン。このフィールドはRRULEから抽出されます。RRULEのタイムゾーンが別のタイムゾーンにリンクされている場合、そのリンクがこのフィールドに反映されます。
• type: 文字列
  タイトル: Type

  読取り専用: true
• unified_job_template(必須): 整数
  タイトル: Unified job template
• until: 文字列
  タイトル: Until

  読取り専用: true

  このスケジュールを終了する日付。このフィールドはRRULEから計算されます。スケジュールに終了日がない場合は、空の文字列が返されます
• url: 文字列
  タイトル: Url

  読取り専用: true
• verbosity: 文字列
  タイトル: Verbosity

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "dtend":{
            "description":"The last occurrence of the schedule occurs before this time, aftewards the schedule expires.",
            "format":"date-time",
            "readOnly":true,
            "title":"Dtend",
            "type":"string",
            "x-nullable":true
        },
        "dtstart":{
            "description":"The first occurrence of the schedule occurs on or after this time.",
            "format":"date-time",
            "readOnly":true,
            "title":"Dtstart",
            "type":"string",
            "x-nullable":true
        },
        "enabled":{
            "default":true,
            "description":"Enables processing of this schedule.",
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "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_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "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_run":{
            "description":"The next time that the scheduled action will run.",
            "format":"date-time",
            "readOnly":true,
            "title":"Next run",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "rrule":{
            "description":"A value representing the schedules iCal recurrence rule.",
            "minLength":"1",
            "title":"Rrule",
            "type":"string",
            "x-nullable":true
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "timezone":{
            "description":"The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.",
            "readOnly":true,
            "title":"Timezone",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "title":"Unified job template",
            "type":"integer"
        },
        "until":{
            "description":"The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned",
            "readOnly":true,
            "title":"Until",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "rrule",
        "name",
        "unified_job_template"
    ],
    "type":"object"
}

ネストされたスキーマ : Extra data

型: object

タイトル: Extra data

先頭に戻る

レスポンス

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

• application/json

201レスポンス

本文()

ルート・スキーマ : Schedule

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• diff_mode: ブール
  タイトル: Diff mode
• dtend: 文字列(日付-時間)
  タイトル: Dtend

  読取り専用: true

  最後のスケジュールはこの時間より前に発生し、これ以降、スケジュールは失効します。
• dtstart: 文字列(日付-時間)
  タイトル: Dtstart

  読取り専用: true

  初回のスケジュールはこの時間以降に発生します。
• enabled: ブール
  タイトル: Enabled

  デフォルト値: true

  このスケジュールの処理を有効にします。
• execution_environment: 整数
  タイトル: Execution environment

  実行に使用されるコンテナ・イメージ。
• extra_data: オブジェクト Extra data
  タイトル: Extra data
• forks: 整数
  タイトル: Forks

  最小値: 0
• id: 整数
  タイトル: ID

  読取り専用: true
• inventory: 整数
  タイトル: Inventory

  プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する)
• job_slice_count: 整数
  タイトル: Job slice count

  最小値: 0
• job_tags: 文字列
  タイトル: Job tags
• job_type: 文字列
  タイトル: Job type

  指定できる値: [ "run", "check" ]
• limit: 文字列
  タイトル: Limit
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• next_run: 文字列(日付-時間)
  タイトル: Next run

  読取り専用: true

  スケジュールされたアクションの次回の実行日時。
• related: 文字列
  タイトル: Related

  読取り専用: true
• rrule(必須): 文字列
  タイトル: Rrule

  最小長: 1

  スケジュールのiCal繰返しルールを表す値。
• scm_branch: 文字列
  タイトル: Scm branch
• skip_tags: 文字列
  タイトル: Skip tags
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• timeout: 整数
  タイトル: Timeout
• timezone: 文字列
  タイトル: Timezone

  読取り専用: true

  このスケジュールが実行されるタイムゾーン。このフィールドはRRULEから抽出されます。RRULEのタイムゾーンが別のタイムゾーンにリンクされている場合、そのリンクがこのフィールドに反映されます。
• type: 文字列
  タイトル: Type

  読取り専用: true
• unified_job_template(必須): 整数
  タイトル: Unified job template
• until: 文字列
  タイトル: Until

  読取り専用: true

  このスケジュールを終了する日付。このフィールドはRRULEから計算されます。スケジュールに終了日がない場合は、空の文字列が返されます
• url: 文字列
  タイトル: Url

  読取り専用: true
• verbosity: 文字列
  タイトル: Verbosity

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "dtend":{
            "description":"The last occurrence of the schedule occurs before this time, aftewards the schedule expires.",
            "format":"date-time",
            "readOnly":true,
            "title":"Dtend",
            "type":"string",
            "x-nullable":true
        },
        "dtstart":{
            "description":"The first occurrence of the schedule occurs on or after this time.",
            "format":"date-time",
            "readOnly":true,
            "title":"Dtstart",
            "type":"string",
            "x-nullable":true
        },
        "enabled":{
            "default":true,
            "description":"Enables processing of this schedule.",
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "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_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "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_run":{
            "description":"The next time that the scheduled action will run.",
            "format":"date-time",
            "readOnly":true,
            "title":"Next run",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "rrule":{
            "description":"A value representing the schedules iCal recurrence rule.",
            "minLength":"1",
            "title":"Rrule",
            "type":"string",
            "x-nullable":true
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "timezone":{
            "description":"The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.",
            "readOnly":true,
            "title":"Timezone",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "title":"Unified job template",
            "type":"integer"
        },
        "until":{
            "description":"The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned",
            "readOnly":true,
            "title":"Until",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "rrule",
        "name",
        "unified_job_template"
    ],
    "type":"object"
}

ネストされたスキーマ : Extra data

型: object

タイトル: Extra data

先頭に戻る