パブリック配信不可: 2025-05-14

移動先

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

新しいブラックアウト理由の作成

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/reasons

このAPIは、新しいユーザー定義ブラックアウト理由を作成します

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/json

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

ルート・スキーマ: schema

型: object

新しいブラックアウト理由を作成するためのペイロード。

すべてに一致

新しいブラックアウト理由を作成するためのペイロード。

ソースの表示

• object Reason
  ブラックアウトの理由。

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Payload to create a new blackout reason.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Reason"
        }
    ]
}

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

型: object

ブラックアウトの理由。

ソースの表示

• reason: string
  英語での事前定義済理由、またはユーザー定義理由。

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Reason of a blackout.",
    "properties":{
        "reason":{
            "type":"string",
            "description":"Predefined reason in English or a user defined reason."
        }
    }
}

例

例の選択 ブラックアウト理由の作成

先頭に戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ: BlackoutReason

型: object

単一のブラックアウト理由。

ソースの表示

• reasonDisplayName: string
  ローカライズされた事前定義済理由、またはユーザーが指定したユーザー定義理由。

{
    "x-em-sdk-level":"emSDK",
    "description":"A single blackout reason.",
    "type":"object",
    "properties":{
        "reasonDisplayName":{
            "type":"string",
            "description":"Localized predefined reason or the user defined reason as provided by the user."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ReasonId"
        },
        {
            "$ref":"#/components/schemas/Reason"
        }
    ]
}

すべてに一致

単一のブラックアウト理由。

単一のブラックアウト理由。

ソースの表示

• object ReasonId
  ブラックアウトの理由ID。
• object Reason
  ブラックアウトの理由。

{
    "x-em-sdk-level":"emSDK",
    "description":"A single blackout reason.",
    "type":"object",
    "properties":{
        "reasonDisplayName":{
            "type":"string",
            "description":"Localized predefined reason or the user defined reason as provided by the user."
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ReasonId"
        },
        {
            "$ref":"#/components/schemas/Reason"
        }
    ]
}

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

型: object

ブラックアウトの理由ID。

ソースの表示

• id: string
  ブラックアウトの理由ID。

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Reason id of a blackout.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Reason id of a blackout."
        }
    }
}

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

型: object

ブラックアウトの理由。

ソースの表示

• reason: string
  英語での事前定義済理由、またはユーザー定義理由。

{
    "x-em-sdk-level":"emSDK",
    "type":"object",
    "description":"Reason of a blackout.",
    "properties":{
        "reason":{
            "type":"string",
            "description":"Predefined reason in English or a user defined reason."
        }
    }
}

例

例の選択 結果 - 新しいブラックアウト理由の作成

400レスポンス

指定されたパラメータの1つが無効です。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

クライアントが認証されていません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

409レスポンス

認可されていないかターゲットがすでに存在します

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

リクエスト処理中の内部エラー

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

必要なサービスが使用不可であることを示しています。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る