Jump to

• Request
• Response

List Image Series Discovered from FPP Server(s)

post

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

Lists the image series present at a given FPP server or from all registered FPP servers

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Target details

Show Source

• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Type of the target

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

Examples

Select an example Payload

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. The FPP image series is retrieved.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object GoldImageFppSeries
  FPP image series Opt-In/Out details collection

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

Nested Schema : GoldImageFppSeries

Type: object

FPP image series Opt-In/Out details collection

Show Source

• items: array items
  List of items
• optedInCount: integer
  Count of Opted-In image series
• optedOutCount: integer
  Count of Opted-Out image series
• total: integer
  Count of total series

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

Nested Schema : items

Type: array

List of items

Show Source

• Array of: object FppSeriesOptInSummary
  FPP Image Series Opt-In/Out details

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

Nested Schema : FppSeriesOptInSummary

Type: object

FPP Image Series Opt-In/Out details

Show Source

• isDiscarded: boolean
  Flag indicates if the FPP series is marked as discarded
• isMarkedForDeleted: boolean
  Flag indicates if the FPP series is marked as deleted
• isOptedIn(required): boolean
  Flag indicates Opted-In status
• seriesId(required): string
  ID of the FPP series
• seriesName: string
  Name of the FPP series
• serverName: string
  FPP server cluster name

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

Examples

Select an example Payload

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

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

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

Forbidden. The user is forbidden to perform the requested operation

Body ()

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

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

Internal Server Error. Exception in execution of REST API.

Body ()

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

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

Service Unavailable. The server is unable to process the request.

Body ()

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

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

Back to Top