Jump to

• Request
• Response

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

Request Body - 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

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

Examples

Select an example Payload

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. FPP images retrieved.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object GoldImageGetFppImages
  FPP image details collection

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

Nested Schema : GoldImageGetFppImages

Type: object

FPP image details collection

Show Source

• items: array items
  List of items
• total: integer
  Count of total images

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

Nested Schema : items

Type: array

List of items

Show Source

• Array of: object FppImageSummary
  FPP image details

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

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

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

Examples

Select an example Payload

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top