移動先

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

FPPサーバーから検出されたイメージ・シリーズのリスト

post

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

指定されたFPPサーバーに存在するイメージ・シリーズまたは登録されているすべてのFPPサーバーからイメージ・シリーズをリストします

リクエスト

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

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

• application/json

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

ルート・スキーマ: schema

型: object

ターゲットの詳細

ソースの表示

• targetName: string
  ターゲットの名前

  例: sales_db1
• targetType: string
  ターゲットのタイプ

  例: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

例

例の選択 ペイロード

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK。FPPイメージ・シリーズが取得されました。

本文()

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

• object GoldImageFppSeries
  FPPイメージ・シリーズのオプトイン/アウトの詳細のコレクション

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

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

型: object

FPPイメージ・シリーズのオプトイン/アウトの詳細のコレクション

ソースの表示

• items: array items
  アイテムのリスト
• optedInCount: integer
  オプトイン・イメージ・シリーズの数
• optedOutCount: integer
  オプトアウト・イメージ・シリーズの数
• total: integer
  合計シリーズ数

{
    "description":"FPP image series Opt-In/Out details collection",
    "type":"object",
    "properties":{
        "optedInCount":{
            "description":"Count of Opted-In image series",
            "type":"integer"
        },
        "optedOutCount":{
            "description":"Count of Opted-Out image series",
            "type":"integer"
        },
        "total":{
            "description":"Count of total series",
            "type":"integer"
        },
        "items":{
            "description":"List of items",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FppSeriesOptInSummary"
            }
        }
    }
}

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

型: array

アイテムのリスト

ソースの表示

• 配列: object FppSeriesOptInSummary
  FPPイメージ・シリーズのオプトイン/アウトの詳細

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

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

型: object

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

ソースの表示

• isDiscarded: boolean
  FPPシリーズが破棄済としてマークされているかどうかを示すフラグ
• isMarkedForDeleted: boolean
  FPPシリーズが削除済としてマークされているかどうかを示すフラグ
• isOptedIn(必須): boolean
  オプトイン・ステータスを示すフラグ
• seriesId(必須): string
  FPPシリーズのID
• seriesName: string
  FPPシリーズの名前
• serverName: string
  FPPサーバー・クラスタ名

{
    "description":"FPP Image Series Opt-In/Out details",
    "type":"object",
    "required":[
        "seriesId",
        "isOptedIn"
    ],
    "properties":{
        "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"
        },
        "isMarkedForDeleted":{
            "description":"Flag indicates if the FPP series is marked as deleted",
            "type":"boolean"
        },
        "isDiscarded":{
            "description":"Flag indicates if the FPP series is marked as discarded",
            "type":"boolean"
        },
        "isOptedIn":{
            "description":"Flag indicates Opted-In status",
            "type":"boolean"
        }
    }
}

例

例の選択 ペイロード

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

先頭に戻る