List Images in an FPP Image Series
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/getFppImages
Lists all images for a given FPP image series
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
FPP image series details
Show Source
-
seriesId: string
ID of the FPP series
-
seriesName: string
Name of the FPP series
-
serverName: string
FPP server cluster name
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
Ok. FPP images retrieved.
Root Schema : schema
Type:
object
Match All
Show Source
-
object
GoldImageGetFppImages
FPP image details collection
Nested Schema : GoldImageGetFppImages
Type:
object
FPP image details collection
Show Source
-
items: array
items
List of items
-
total: integer
Count of total images
Nested Schema : items
Type:
array
List of items
Show Source
-
Array of:
object FppImageSummary
FPP image details
Nested Schema : FppImageSummary
Type:
object
FPP image details
Show Source
-
imageId(required): string
ID of the FPP image
-
imageName(required): string
Name of the FPP image
-
imagePlatform: string
Platform of the FPP image
-
imageVersion: string
Version of the FPP image
-
isMarkedForDeleted: boolean
Flag indicates if the image has been marked as deleted
Examples
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
403 Response
Forbidden. The user is forbidden to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error. Exception in execution of REST API.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable. The server is unable to process the request.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string