Jump to

• Request
• Response

List FPP Client Properties

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppClients/{fppClientId}/properties

Lists all properties of an FPP client

Request

Path Parameters

• fppClientId(required): string
  ID of the FPP client

Query Parameters

• limit: integer(int32)
  Limit count of the items in the response

  Example:

  10

• page: string
  Marker indicating the next set (page) of items

  Example:

  b2Zmc2V0OjA

• sort: string
  Comma separated list of fields along with an optional sort direction. Valid fields include name. Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.

  Default Value: name:asc

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. FPP client properties retrieved.

Body ()

Root Schema : FppClientPropertyCollection

Type: object

FPP client properties

Match All

FPP client properties

Show Source

• object allOf PropertyCollection
  FPP properties

{
    "description":"FPP client properties",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PropertyCollection"
        }
    ]
}

Nested Schema : PropertyCollection

Type: object

FPP properties

Show Source

• items: array items
  Array of properties
• targetId: string
  ID of the target

{
    "description":"FPP properties",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        },
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "type":"string",
            "description":"ID of the target"
        },
        "items":{
            "description":"Array of properties",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertySummary"
            }
        }
    }
}

Match All

FPP properties

FPP properties

Show Source

• object Pagination
  Collection of items with links
• object schema
  Target details

{
    "description":"FPP properties",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        },
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "type":"string",
            "description":"ID of the target"
        },
        "items":{
            "description":"Array of properties",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertySummary"
            }
        }
    }
}

Nested Schema : Pagination

Type: object

Collection of items with links

Show Source

• count: integer
  Count of this fetch

  Example: 40
• links: object Links
  Represents the array of links
• total: integer
  total count

  Example: 40

{
    "description":"Collection of items with links",
    "properties":{
        "total":{
            "type":"integer",
            "description":"total count",
            "example":40
        },
        "count":{
            "type":"integer",
            "description":"Count of this fetch",
            "example":40
        },
        "links":{
            "$ref":"#/components/schemas/Links"
        }
    }
}

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

Nested Schema : Links

Type: object

Represents the array of links

Show Source

• next: object Link
  A link
• previous: object Link
  A link
• self: object Link
  A link

{
    "description":"Represents the array of links",
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : Link

Type: object

A link

Show Source

• href: string
  URL for link.

{
    "description":"A link",
    "type":"object",
    "properties":{
        "href":{
            "description":"URL for link.",
            "type":"string"
        }
    }
}

Examples

Select an example Payload

400 Response

Bad Request.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

401 Response

Unauthorized.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

403 Response

Forbidden.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

404 Response

Not Found.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

500 Response

Internal Server Error.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

503 Response

Service Unavailable

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

Back to Top