移動先

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

プロシージャ・インスタンスの再スケジュール

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedureInstances/{deploymentProcedureInstanceId}/actions/reschedule

リクエスト本文に指定されたインスタンスを再スケジュールします。emcliでは、'reschedule_instance'に相当します

リクエスト

パス・パラメータ

• deploymentProcedureInstanceId(必須): string
  インスタンスのID。

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

発行済のプロシージャ・インスタンスを再スケジュールします

ソースの表示

• scheduleTime: object Schedule
  これは、ブラックアウトをスケジュールするスケジュール・オブジェクトを表します。

{
    "description":"Reschedules a submitted procedure instance",
    "type":"object",
    "properties":{
        "scheduleTime":{
            "$ref":"#/components/schemas/Schedule"
        }
    }
}

ネストされたスキーマ: Schedule

型: object

これは、ブラックアウトをスケジュールするスケジュール・オブジェクトを表します。

ソースの表示

• repeat: object Repeat
  ブラックアウトの繰返しを示します。
• timeToStart: string
  タイムゾーン付きのブラックアウトの開始時刻。タイムスタンプは分精度です。タイムゾーンは、オフセット(+01:00)またはゾーン(ヨーロッパ/ベルリン)として指定できます。

  例: 2023-08-24T14:54-02:00

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
            "example":"2023-08-24T14:54-02:00"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

1つのスキーマに一致

ソースの表示

• object TimeToEnd
  タイムゾーン付きの終了時刻を指定するオブジェクト。タイムスタンプは分精度です。タイムゾーンは、オフセット(+01:00)またはゾーン(ヨーロッパ/ベルリン)として指定できます。
• object Duration
  時間および分で指定する期間。durationHoursおよびdurationMinutesの少なくとも1つが必要です。

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
            "example":"2023-08-24T14:54-02:00"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

ネストされたスキーマ: Repeat

型: object

ブラックアウトの繰返しを示します。

ソースの表示

• timeToEndRepeat: string
  タイムゾーン付きの繰返しの終了時刻。タイムスタンプは分精度です。

  例: 2023-08-24T14:54-02:00

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

1つのスキーマに一致

ソースの表示

• object DaysOfYear
  年の通算日のリスト。
• object DaysOfMonth
  1-31の範囲の月の通算日のリスト、または月の最終日の場合は-1。
• object DaysOfWeek
  曜日のリスト。
• object EveryNWeeks
  n週ごとに繰り返します。
• object EveryNDays
  n日ごとに繰り返します。
• object EveryNHours
  n時間ごとに繰り返します。
• object EveryNMinutes
  n分ごとに繰り返します。最小値は2です。

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

ネストされたスキーマ: TimeToEnd

型: object

タイムゾーン付きの終了時刻を指定するオブジェクト。タイムスタンプは分精度です。タイムゾーンは、オフセット(+01:00)またはゾーン(ヨーロッパ/ベルリン)として指定できます。

ソースの表示

• timeToEnd(required): string
  終了時刻

  例: 2023-08-23T14:54+01:00

{
    "type":"object",
    "required":[
        "timeToEnd"
    ],
    "description":"An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
    "properties":{
        "timeToEnd":{
            "type":"string",
            "description":"An end time",
            "example":"2023-08-23T14:54+01:00"
        }
    }
}

ネストされたスキーマ: Duration

型: object

時間および分で指定する期間。durationHoursおよびdurationMinutesの少なくとも1つが必要です。

ソースの表示

• durationHours: integer
  ブラックアウトの期間(時間)。

  例: 2
• durationMinutes: integer
  ブラックアウトの期間(分)

  例: 25

{
    "type":"object",
    "description":"A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.",
    "properties":{
        "durationMinutes":{
            "type":"integer",
            "description":"Duration of the blackout in minutes.",
            "example":"25"
        },
        "durationHours":{
            "type":"integer",
            "description":"Duration of the blackout in hours.",
            "example":"2"
        }
    }
}

ネストされたスキーマ: DaysOfYear

型: object

年の通算日のリスト。

ソースの表示

• daysOfYear: array daysOfYear
  年の通算日のリスト。

{
    "type":"object",
    "description":"List of days of year.",
    "properties":{
        "daysOfYear":{
            "type":"array",
            "description":"List of days of the year.",
            "items":{
                "type":"object",
                "properties":{
                    "month":{
                        "type":"integer",
                        "description":"Month in range of 1-12."
                    },
                    "day":{
                        "type":"integer",
                        "description":"Day in range 1-31 or -1 for last day of the month."
                    }
                }
            }
        }
    }
}

ネストされたスキーマ: DaysOfMonth

型: object

1-31の範囲の月の通算日のリスト、または月の最終日の場合は-1。

ソースの表示

• daysOfMonth: array daysOfMonth
  月の通算日のリスト(1ベース)。

{
    "type":"object",
    "description":"List of days of month in range 1-31 or -1 for last day of the month.",
    "properties":{
        "daysOfMonth":{
            "type":"array",
            "description":"List of days of the month (1 based).",
            "items":{
                "type":"integer"
            },
            "example":[
                "1",
                "15"
            ]
        }
    }
}

ネストされたスキーマ: DaysOfWeek

型: object

曜日のリスト。

ソースの表示

• daysOfWeek: array daysOfWeek
  曜日のリスト(ローカライズされた短縮名)。

{
    "type":"object",
    "description":"List of days of week.",
    "properties":{
        "daysOfWeek":{
            "type":"array",
            "description":"List of days of week (localized short names).",
            "items":{
                "type":"string",
                "enum":[
                    "MO",
                    "TU",
                    "WE",
                    "TH",
                    "FR",
                    "SA",
                    "SU"
                ]
            },
            "example":[
                "MO",
                "TH"
            ]
        }
    }
}

ネストされたスキーマ: EveryNWeeks

型: object

n週ごとに繰り返します。

ソースの表示

• everyNWeeks: integer
  繰返し間隔(週)。

  例: 2

{
    "type":"object",
    "description":"Repeat every n weeks.",
    "properties":{
        "everyNWeeks":{
            "type":"integer",
            "description":"Repeat interval in weeks.",
            "example":"2"
        }
    }
}

ネストされたスキーマ: EveryNDays

型: object

n日ごとに繰り返します。

ソースの表示

• everyNDays: integer
  繰返し間隔(日)。最小値は1です。

  例: 5

{
    "type":"object",
    "description":"Repeat every n days.",
    "properties":{
        "everyNDays":{
            "type":"integer",
            "description":"Repeat interval in days, minimal value is 1.",
            "example":"5"
        }
    }
}

ネストされたスキーマ: EveryNHours

型: object

n時間ごとに繰り返します。

ソースの表示

• everyNHours: integer
  繰返し間隔(時間)。

  例: 2

{
    "type":"object",
    "description":"Repeat every n hours.",
    "properties":{
        "everyNHours":{
            "type":"integer",
            "description":"Repeat interval in hours.",
            "example":"2"
        }
    }
}

ネストされたスキーマ: EveryNMinutes

型: object

n分ごとに繰り返します。最小値は2です。

ソースの表示

• everyNMinutes: integer
  繰返し間隔(分)。

  例: 45

{
    "type":"object",
    "description":"Repeat every n minutes, minimal value is 2.",
    "properties":{
        "everyNMinutes":{
            "type":"integer",
            "description":"Repeat interval in minutes.",
            "example":"45"
        }
    }
}

ネストされたスキーマ: daysOfYear

型: array

年の通算日のリスト。

ソースの表示

• 配列: object items

{
    "type":"array",
    "description":"List of days of the year.",
    "items":{
        "type":"object",
        "properties":{
            "month":{
                "type":"integer",
                "description":"Month in range of 1-12."
            },
            "day":{
                "type":"integer",
                "description":"Day in range 1-31 or -1 for last day of the month."
            }
        }
    }
}

ネストされたスキーマ: items

型: object

ソースの表示

• day: integer
  1-31の範囲の日、またはまたは月の最終日の場合は-1。
• month: integer
  1-12の範囲の月。

{
    "type":"object",
    "properties":{
        "month":{
            "type":"integer",
            "description":"Month in range of 1-12."
        },
        "day":{
            "type":"integer",
            "description":"Day in range 1-31 or -1 for last day of the month."
        }
    }
}

ネストされたスキーマ: daysOfMonth

型: array

月の通算日のリスト(1ベース)。

ソースの表示

• 配列: integer

{
    "type":"array",
    "description":"List of days of the month (1 based).",
    "items":{
        "type":"integer"
    },
    "example":[
        "1",
        "15"
    ]
}

例:

[
    "1",
    "15"
]

ネストされたスキーマ: daysOfWeek

型: array

曜日のリスト(ローカライズされた短縮名)。

ソースの表示

• 配列: string
  指定できる値: [ "MO", "TU", "WE", "TH", "FR", "SA", "SU" ]

{
    "type":"array",
    "description":"List of days of week (localized short names).",
    "items":{
        "type":"string",
        "enum":[
            "MO",
            "TU",
            "WE",
            "TH",
            "FR",
            "SA",
            "SU"
        ]
    },
    "example":[
        "MO",
        "TH"
    ]
}

例:

[
    "MO",
    "TH"
]

先頭に戻る

レスポンス

204レスポンス

インスタンスが正常に再スケジュールされました

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

  例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

先頭に戻る