Jump to

• Request
• Response

List Images

get

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

Lists images

Request

Query Parameters

• createdByMatches: string
  Wildcard search on the owner of the image

  Example:

  ADMIN

• descriptionMatches: string
  Wildcard search on the description of the image

  Example:

  %image%

• include: string
  Include 'all' images (ready and not ready images)

  Allowed Values: [ "all" ]
• limit: integer(int32)
  Limit count of the items in the response

  Example:

  10

• nameMatches: string
  Wildcard search on the name of the image

  Example:

  %DB19%

• 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. The supported attribute of sorting is 'name'.Valid sort directions are 'asc' and 'desc'. If sort direction is not specified, 'asc' is used by default.

  Example:

  name:desc

• targetType: string
  Image target type

  Example:

  oracle_database

• versionMatches: string
  Wildcard search on the version name of the image

  Example:

  %19%

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. The list of the images is retrieved.

Body ()

Root Schema : GoldImageCollection

Type: object

List of images

Show Source

• items(required): array items
  Array of images

{
    "type":"object",
    "description":"List of images",
    "required":[
        "items"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        }
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Array of images",
            "items":{
                "$ref":"#/components/schemas/GoldImageSummary"
            }
        }
    }
}

Match All

Show Source

• object Pagination
  Collection of items with links

{
    "type":"object",
    "description":"List of images",
    "required":[
        "items"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        }
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Array of images",
            "items":{
                "$ref":"#/components/schemas/GoldImageSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Array of images

Show Source

• Array of: GoldImageSummary
  Summary of the image

{
    "type":"array",
    "description":"Array of images",
    "items":{
        "$ref":"#/components/schemas/GoldImageSummary"
    }
}

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 : GoldImageSummary

Summary of the image

Match All

Show Source

• object GoldImageCommonSummary
  Common image summary

{
    "description":"Summary of the image",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageCommonSummary"
        }
    ]
}

Nested Schema : GoldImageCommonSummary

Type: object

Common image summary

Show Source

• createdBy: string
  Owner of the image

  Example: ADMIN
• description: string
  Description of the image

  Example: fm_1914_description
• fppServer: string
  If isFppImage is true, then this field contains FPP server name, where the image is present

  Example: xyz0102c
• fppUser: string
  If isFppImage is true, then this field contains FPP user name, who has access to the image

  Example: restuser
• id: string
  ID of the image

  Example: E6C5858BD2B46B37E05380FE4564A69B
• isFppImage: boolean
  Flag to indicate FPP image

  Example: true
• links: object links
  Navigation links
• name: string
  Name of the image

  Example: fm_1914image
• platformName: string
  Platform of the image

  Example: Linux x86-64
• timeCreated: string (date-time)
  Creation time of the image

  Example: 2022-08-22 00:10:27.0
• version: string
  Version of the image

  Example: 19.0.0.0.0

{
    "description":"Common image summary",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the image",
            "type":"string",
            "example":"fm_1914image"
        },
        "id":{
            "description":"ID of the image",
            "type":"string",
            "example":"E6C5858BD2B46B37E05380FE4564A69B"
        },
        "isFppImage":{
            "description":"Flag to indicate FPP image",
            "type":"boolean",
            "example":true
        },
        "fppServer":{
            "description":"If isFppImage is true, then this field contains FPP server name, where the image is present",
            "type":"string",
            "example":"xyz0102c"
        },
        "fppUser":{
            "description":"If isFppImage is true, then this field contains FPP user name, who has access to the image",
            "type":"string",
            "example":"restuser"
        },
        "description":{
            "description":"Description of the image",
            "type":"string",
            "example":"fm_1914_description"
        },
        "version":{
            "description":"Version of the image",
            "type":"string",
            "example":"19.0.0.0.0"
        },
        "platformName":{
            "description":"Platform of the image",
            "type":"string",
            "example":"Linux x86-64"
        },
        "timeCreated":{
            "description":"Creation time of the image",
            "type":"string",
            "format":"date-time",
            "example":"2022-08-22 00:10:27.0"
        },
        "createdBy":{
            "description":"Owner of the image",
            "type":"string",
            "example":"ADMIN"
        },
        "links":{
            "type":"object",
            "description":"Navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/SelfLink"
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Navigation links

Show Source

• self: object SelfLink
  Represents a self-link

{
    "type":"object",
    "description":"Navigation links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/SelfLink"
        }
    }
}

Nested Schema : SelfLink

Type: object

Represents a self-link

Show Source

• href: string
  URL for the self-link

  Example: /em/api/<resources>/<resourceId>

{
    "type":"object",
    "description":"Represents a self-link",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the self-link",
            "example":"/em/api/<resources>/<resourceId>"
        }
    }
}

Nested Schema : Links

Type: object

Represents the array of links

Show Source

• next: object Link
  Represents a link(could be self, previous or next)
• previous: object Link
  Represents a link(could be self, previous or next)
• self: object Link
  Represents a link(could be self, previous or next)

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

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Examples

Select an example Payload

400 Response

Bad Request. The payload is null or missing some parameters

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

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

404 Response

Not Found. The requested REST API URL is not found.

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