移動先

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

イメージ・シリーズのオプトアウト

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/fppSeriesOptOut

Enterprise ManagerからこのFPPイメージ・シリーズは使用しないでください。

リクエスト

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

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

• application/json

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

ルート・スキーマ: schema

型: object

FPPシリーズのオプトアウトの詳細

すべてに一致

ソースの表示

• object FppSeriesOptOutInputDetails
  FPPイメージ・シリーズの詳細

{
    "description":"Opt-Out details for the FPP series",
    "type":"object",
    "required":[
        "series"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/FppSeriesOptOutInputDetails"
        }
    ]
}

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

型: object

FPPイメージ・シリーズの詳細

ソースの表示

• series: array series
  イメージ・シリーズの配列

{
    "type":"object",
    "description":"FPP image series details",
    "properties":{
        "series":{
            "description":"Array of the image series",
            "type":"array",
            "items":{
                "type":"object",
                "oneOf":[
                    {
                        "required":[
                            "seriesName",
                            "serverName"
                        ]
                    },
                    {
                        "required":[
                            "seriesId"
                        ]
                    }
                ],
                "properties":{
                    "seriesId":{
                        "type":"string",
                        "description":"ID of the FPP series"
                    },
                    "seriesName":{
                        "type":"string",
                        "description":"Name of the FPP series"
                    },
                    "serverName":{
                        "type":"string",
                        "description":"FPP server cluster name"
                    }
                }
            }
        }
    }
}

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

型: array

イメージ・シリーズの配列

ソースの表示

• 配列: object items

{
    "description":"Array of the image series",
    "type":"array",
    "items":{
        "type":"object",
        "oneOf":[
            {
                "required":[
                    "seriesName",
                    "serverName"
                ]
            },
            {
                "required":[
                    "seriesId"
                ]
            }
        ],
        "properties":{
            "seriesId":{
                "type":"string",
                "description":"ID of the FPP series"
            },
            "seriesName":{
                "type":"string",
                "description":"Name of the FPP series"
            },
            "serverName":{
                "type":"string",
                "description":"FPP server cluster name"
            }
        }
    }
}

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

型: object

ソースの表示

• seriesId: string
  FPPシリーズのID
• seriesName: string
  FPPシリーズの名前
• serverName: string
  FPPサーバー・クラスタ名

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName"
            ]
        },
        {
            "required":[
                "seriesId"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"ID of the FPP series"
        },
        "seriesName":{
            "type":"string",
            "description":"Name of the FPP series"
        },
        "serverName":{
            "type":"string",
            "description":"FPP server cluster name"
        }
    }
}

1つのスキーマに一致

ソースの表示

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName"
            ]
        },
        {
            "required":[
                "seriesId"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"ID of the FPP series"
        },
        "seriesName":{
            "type":"string",
            "description":"Name of the FPP series"
        },
        "serverName":{
            "type":"string",
            "description":"FPP server cluster name"
        }
    }
}

例

例の選択 ペイロード

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK。FPPイメージ・シリーズのオプトアウトが完了しました。

本文()

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

• object allOf GoldImageFppSeriesOptOut
  FPPイメージ・シリーズのオプトアウトのレスポンス

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageFppSeriesOptOut"
        }
    ]
}

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

型: object

FPPイメージ・シリーズのオプトアウトのレスポンス

すべてに一致

ソースの表示

• object FppSeriesOptInOptOutResult
  FPPイメージ・シリーズのオプトイン/アウトの結果

{
    "description":"FPP image series Opt-Out response",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/FppSeriesOptInOptOutResult"
        }
    ]
}

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

型: object

FPPイメージ・シリーズのオプトイン/アウトの結果

ソースの表示

• failed: integer
  失敗したシリーズの数
• items: array items
  アイテムのリスト
• successful: integer
  成功したシリーズの数
• total: integer
  合計シリーズ数

{
    "description":"FPP image series Opt-In/Out result",
    "type":"object",
    "properties":{
        "failed":{
            "description":"Count of failed series",
            "type":"integer"
        },
        "successful":{
            "description":"Count of successful series",
            "type":"integer"
        },
        "total":{
            "description":"Count of total series",
            "type":"integer"
        },
        "items":{
            "description":"List of items",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FppSeriesOptInResultSummary"
            }
        }
    }
}

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

型: array

アイテムのリスト

ソースの表示

• 配列: object FppSeriesOptInResultSummary
  FPPイメージ・シリーズのオプトインのレスポンス

{
    "description":"List of items",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FppSeriesOptInResultSummary"
    }
}

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

型: object

FPPイメージ・シリーズのオプトインのレスポンス

ソースの表示

• code: integer
  シリーズのオプトインのHTTPステータス・コード
• message: string
  オプトイン・メッセージ
• seriesId: string
  FPPシリーズのID
• seriesName: string
  FPPシリーズの名前
• serverName: string
  FPPサーバー・クラスタ名

{
    "description":"FPP image series Opt-In response",
    "type":"object",
    "properties":{
        "code":{
            "description":"Series Opt-In HTTP status code",
            "type":"integer"
        },
        "seriesId":{
            "description":"ID of the FPP series",
            "type":"string"
        },
        "seriesName":{
            "description":"Name of the FPP series",
            "type":"string"
        },
        "serverName":{
            "description":"FPP server cluster name",
            "type":"string"
        },
        "message":{
            "description":"Opt-In message",
            "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"
        }
    }
}

403レスポンス

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

本文()

ルート・スキーマ: 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レスポンス

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

本文()

ルート・スキーマ: 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"
        }
    }
}

先頭に戻る