機械翻訳について

移動先

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

プロジェクトのスケジュールの作成

post

/api/v2/projects/{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デバッグ)

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

このリソースに対するPOSTリクエストには、特定の形式に従い、許可されたルールのサブセットに準拠した適切なrrule値が含まれている必要があります。

次に、rruleで想定される形式と詳細を示します。

• DTSTARTは必須であり、DTSTART:YYYYMMDDTHHMMSSZという形式に従う必要があります
• DTSTARTはUTCであると想定されます
• INTERVALは必須です
• SECONDLYはサポートされていません
• TZIDはサポートされていません
• ルール文の前にRRULEが必要です
• BYDAYはサポートされていますが、数値接頭辞が付いたBYDAYはサポートされていません
• BYYEARDAYおよびBYWEEKNOはサポートされていません
• スケジュールごとに1つのrrule文のみがサポートされています
• COUNTは< 1000である必要があります

次に、rruleの例をいくつか示します。

"DTSTART:20500331T055000Z RRULE:FREQ=MINUTELY;INTERVAL=10;COUNT=5"
"DTSTART:20240331T075000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1"
"DTSTART:20140331T075000Z RRULE:FREQ=MINUTELY;INTERVAL=1;UNTIL=20230401T075000Z"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=6"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=4;BYDAY=SU"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR,SA,SU"
"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=4;BYMONTHDAY=1"
"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYSETPOS=-1;BYMONTH=8;BYDAY=SU"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20230401T075000Z;BYDAY=MO,WE,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=HOURLY;INTERVAL=1;UNTIL=20230610T075000Z"

リクエスト

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

• application/json

パス・パラメータ

• id: 文字列

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• description(オプション): 文字列
• diff_mode(オプション): ブール
• enabled(オプション): ブール
  このスケジュールの処理を有効にします。
• extra_data(オプション): 文字列
• inventory(オプション): 整数
  プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する)
• job_tags(オプション): 文字列
• job_type(オプション): 文字列
• limit(オプション): 文字列
• name: 文字列
• rrule: 文字列
  スケジュールのiCal繰返しルールを表す値。
• scm_branch(オプション): 文字列
• skip_tags(オプション): 文字列
• unified_job_template: 整数
• verbosity(オプション): 文字列

{
    "properties":{
        "description":{
            "description":"",
            "type":"string"
        },
        "diff_mode":{
            "description":"",
            "type":"boolean"
        },
        "enabled":{
            "description":"Enables processing of this schedule.",
            "type":"boolean"
        },
        "extra_data":{
            "description":"",
            "type":"string"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "type":"integer"
        },
        "job_tags":{
            "description":"",
            "type":"string"
        },
        "job_type":{
            "description":"",
            "type":"string"
        },
        "limit":{
            "description":"",
            "type":"string"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "rrule":{
            "description":"A value representing the schedules iCal recurrence rule.",
            "type":"string"
        },
        "scm_branch":{
            "description":"",
            "type":"string"
        },
        "skip_tags":{
            "description":"",
            "type":"string"
        },
        "unified_job_template":{
            "description":"",
            "type":"integer"
        },
        "verbosity":{
            "description":"",
            "type":"string"
        }
    },
    "required":[
        "rrule",
        "name",
        "unified_job_template"
    ],
    "type":"object"
}

先頭に戻る

レスポンス

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

• application/json

201レスポンス

400レスポンス

本文

レスポンスの例(application/json)

{
    "extra_data":[
        "Field is not allowed on launch."
    ]
}

先頭に戻る