移動先

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

デプロイメント・プロシージャに関する詳細の取得

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedures/{deploymentProcedureId}

デプロイメント・プロシージャに関する詳細を取得します。emcliでは、'describe_procedure_input'に相当します

リクエスト

パス・パラメータ

• deploymentProcedureId(必須): string
  プロシージャのID。

問合せパラメータ

• include: string
  include=procedureInputまたはinclude=XmlFormatの場合は、プロシージャ入力またはプロシージャxmlに関する情報がレスポンスに含まれます

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

デプロイメント・プロシージャが正常に返されました

本文()

ルート・スキーマ: DeploymentProcedure

型: object

プロシージャを表します

すべてに一致

プロシージャを表します

ソースの表示

• object DeploymentProcedureDetails
  これは、プロシージャを表すものです。

{
    "description":"It represents a Procedure",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureDetails"
        }
    ]
}

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

型: object

これは、プロシージャを表すものです。

ソースの表示

• displayName: string
  プロシージャの表示名

  例: Copy of TEST_DP
• id: string
  プロシージャの一意の識別子

  例: B0FBBE587FD201E2E0537013790A7D53
• links: object links
  プロシージャ関連リンク
• name: string
  プロシージャの名前

  例: DP_CC67765EF65F51A5E053E00F4B64D991
• owner: string
  プロシージャの所有者

  例: SYSMAN
• parentName: string
  プロシージャの親プロシージャ

  例: TEST_DP
• procedureInput: object procedureInput
  プロシージャの発行時に指定された入力
• type: string
  プロシージャのタイプ

  例: UserDefined
• version: string
  プロシージャのバージョン番号

  例: Succeeded
• xmlFormat: string
  登録に再利用できるDP xmlを返します。

{
    "description":"This is the representation of a Procedure.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Procedure",
            "example":"B0FBBE587FD201E2E0537013790A7D53"
        },
        "name":{
            "type":"string",
            "description":"Name of a Procedure",
            "example":"DP_CC67765EF65F51A5E053E00F4B64D991"
        },
        "type":{
            "type":"string",
            "description":"Type of a Procedure",
            "example":"UserDefined"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of a Procedure",
            "example":"Copy of TEST_DP"
        },
        "version":{
            "type":"string",
            "description":"Version Number of a Procedure",
            "example":"Succeeded"
        },
        "owner":{
            "type":"string",
            "description":"Owner of a Procedure",
            "example":"SYSMAN"
        },
        "parentName":{
            "type":"string",
            "description":"Parent procedure of a Procedure",
            "example":"TEST_DP"
        },
        "procedureInput":{
            "type":"object",
            "description":"input which given during submit procedure",
            "allOf":[
                {
                    "$ref":"#/components/schemas/DescribeProcedureInput"
                }
            ]
        },
        "xmlFormat":{
            "type":"string",
            "description":"returns DP xml which can be reused to register."
        },
        "links":{
            "type":"object",
            "description":"Procedure related links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

プロシージャ関連リンク

ソースの表示

• self: object Link
  REST APIを参照するリンク。

{
    "type":"object",
    "description":"Procedure related links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: object

プロシージャの発行時に指定された入力

すべてに一致

プロシージャの発行時に指定された入力

ソースの表示

• object DescribeProcedureInput
  これは、デプロイメント・プロシージャの発行時に指定された入力を表すものです。

{
    "type":"object",
    "description":"input which given during submit procedure",
    "allOf":[
        {
            "$ref":"#/components/schemas/DescribeProcedureInput"
        }
    ]
}

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

型: object

REST APIを参照するリンク。

ソースの表示

• href: string
  リンクURL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

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

型: object

これは、デプロイメント・プロシージャの発行時に指定された入力を表すものです。

ソースの表示

• links: object links
  セルフ・リンク
• schedule: object Schedule
  これは、ブラックアウトをスケジュールするスケジュール・オブジェクトを表します。
• targets: array DeploymentProcedureTargetList
  プロシージャ・ターゲットのリストの定義
• variables: object DeploymentProcedureVariableCollection
  プロシージャ変数のコレクション

{
    "description":"This is the representation of an input given while submitting deployment procedure.",
    "type":"object",
    "properties":{
        "targets":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetList"
        },
        "variables":{
            "$ref":"#/components/schemas/DeploymentProcedureVariableCollection"
        },
        "schedule":{
            "$ref":"#/components/schemas/Schedule"
        },
        "links":{
            "type":"object",
            "description":"Self link",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

セルフ・リンク

ソースの表示

• self: object Link
  REST APIを参照するリンク。

{
    "type":"object",
    "description":"Self link",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

ネストされたスキーマ: 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"
        }
    ]
}

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

型: array

プロシージャ・ターゲットのリストの定義

ソースの表示

• 配列: object items

{
    "description":"Defining list of procedure targets",
    "type":"array",
    "items":{
        "properties":{
            "name":{
                "type":"string",
                "description":"name of target type",
                "example":"host"
            },
            "targets":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
            }
        }
    }
}

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

型: object

プロシージャ変数のコレクション

ソースの表示

• items: array items
  プロシージャ変数のリスト

{
    "description":"Collections of Procedure Variable",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of procedure variables",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
            }
        }
    }
}

ネストされたスキーマ: 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"
]

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

型: object

ソースの表示

• name: string
  ターゲット・タイプの名前

  例: host
• targets: object DeploymentProcedureTargetCollection
  プロシージャ・ターゲットのコレクション

{
    "properties":{
        "name":{
            "type":"string",
            "description":"name of target type",
            "example":"host"
        },
        "targets":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
        }
    }
}

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

型: object

プロシージャ・ターゲットのコレクション

ソースの表示

• items: array items
  ターゲットのリスト

{
    "description":"Collections of Procedure Target",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of targets",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
            }
        }
    }
}

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

型: array

ターゲットのリスト

ソースの表示

• 配列: object DeploymentProcedureTargetSummary
  これは、プロシージャ・ターゲットを表すものです

{
    "type":"array",
    "description":"The list of targets",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
    }
}

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

型: object

これは、プロシージャ・ターゲットを表すものです

すべてに一致

これは、プロシージャ・ターゲットを表すものです

ソースの表示

• object DeploymentProcedureTargetDetails
  デプロイメント・プロシージャのターゲットの定義

{
    "description":"This is the representation of Procedure Target",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureTargetDetails"
        }
    ]
}

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

型: object

デプロイメント・プロシージャのターゲットの定義

ソースの表示

• credentialReferences: array CredentialReference
  これは、資格証明参照を表すものです。
• targetName: string
  ターゲット名

  例: host1.oracle.com
• targetType: string
  ターゲット・タイプ

  例: host

{
    "description":"Defining Target for Deployment Procedure",
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target Name",
            "example":"host1.oracle.com"
        },
        "targetType":{
            "type":"string",
            "description":"Target Type",
            "example":"host"
        },
        "credentialReferences":{
            "$ref":"#/components/schemas/CredentialReference"
        }
    }
}

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

型: array

これは、資格証明参照を表すものです。

ソースの表示

• 配列: object items

{
    "description":"This is the representation of credential references.",
    "type":"array",
    "items":{
        "properties":{
            "usage":{
                "type":"string",
                "description":"Represents credential usage",
                "example":"defaultHostCred"
            },
            "credentialType":{
                "type":"string",
                "description":"Represents type of the credential",
                "example":"NAMED"
            },
            "owner":{
                "type":"string",
                "description":"Represents owner of the credential",
                "example":"SYSMAN"
            },
            "credentialName":{
                "type":"string",
                "description":"Represents credential name",
                "example":"EMGA"
            }
        }
    }
}

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

型: object

ソースの表示

• credentialName: string
  資格証明名を表します

  例: EMGA
• credentialType: string
  資格証明のタイプを表します

  例: NAMED
• owner: string
  資格証明の所有者を表します

  例: SYSMAN
• usage: string
  資格証明の使用方法を表します

  例: defaultHostCred

{
    "properties":{
        "usage":{
            "type":"string",
            "description":"Represents credential usage",
            "example":"defaultHostCred"
        },
        "credentialType":{
            "type":"string",
            "description":"Represents type of the credential",
            "example":"NAMED"
        },
        "owner":{
            "type":"string",
            "description":"Represents owner of the credential",
            "example":"SYSMAN"
        },
        "credentialName":{
            "type":"string",
            "description":"Represents credential name",
            "example":"EMGA"
        }
    }
}

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

型: array

プロシージャ変数のリスト

ソースの表示

• 配列: object DeploymentProcedureVariableSummary
  これは、プロシージャ変数を表すものです

{
    "type":"array",
    "description":"The list of procedure variables",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
    }
}

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

型: object

これは、プロシージャ変数を表すものです

すべてに一致

これは、プロシージャ変数を表すものです

ソースの表示

• object DeploymentProcedureVariableDetails
  デプロイメント・プロシージャの変数の定義

{
    "description":"This is the representation of Procedure Variable",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureVariableDetails"
        }
    ]
}

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

型: object

デプロイメント・プロシージャの変数の定義

ソースの表示

• variableName: string
  デプロイメント・プロシージャの変数名を表示します

  例: userId
• variableValue: string
  デプロイメント・プロシージャの変数値を表示します

  例: 10001

{
    "description":"Defining Variable for Deployment Procedure",
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale name",
            "example":"userId"
        },
        "variableValue":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale value",
            "example":"10001"
        }
    }
}

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"
        }
    }
}

先頭に戻る