移動先

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

FPPイメージ・シリーズのイメージのリスト

post

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

指定されたFPPイメージ・シリーズのすべてのイメージをリストします

リクエスト

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

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

• application/json

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

ルート・スキーマ: schema

型: object

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

ソースの表示

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

{
    "type":"object",
    "description":"FPP image series details",
    "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 GoldImageGetFppImages
  FPPイメージの詳細のコレクション

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

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

型: object

FPPイメージの詳細のコレクション

ソースの表示

• items: array items
  アイテムのリスト
• total: integer
  合計イメージ数

{
    "description":"FPP image details collection",
    "type":"object",
    "properties":{
        "total":{
            "description":"Count of total images",
            "type":"integer"
        },
        "items":{
            "description":"List of items",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FppImageSummary"
            }
        }
    }
}

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

型: array

アイテムのリスト

ソースの表示

• 配列: object FppImageSummary
  FPPイメージの詳細

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

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

型: object

FPPイメージの詳細

ソースの表示

• imageId(必須): string
  FPPイメージのID
• imageName(必須): string
  FPPイメージの名前
• imagePlatform: string
  FPPイメージのプラットフォーム
• imageVersion: string
  FPPイメージのバージョン
• isMarkedForDeleted: boolean
  イメージが削除済としてマークされているかどうかを示すフラグ

{
    "description":"FPP image details",
    "type":"object",
    "required":[
        "imageId",
        "imageName"
    ],
    "properties":{
        "imageId":{
            "description":"ID of the FPP image",
            "type":"string"
        },
        "imageName":{
            "description":"Name of the FPP image",
            "type":"string"
        },
        "imageVersion":{
            "description":"Version of the FPP image",
            "type":"string"
        },
        "imagePlatform":{
            "description":"Platform of the FPP image",
            "type":"string"
        },
        "isMarkedForDeleted":{
            "description":"Flag indicates if the image has been marked as deleted",
            "type":"boolean"
        }
    }
}

例

例の選択 ペイロード

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

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

先頭に戻る