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

List of images

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

Summary of the image

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
  It represents a Link
• previous: object Link
  It represents a Link
• self: object Link
  It represents 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

It represents a Link

Show Source

• href: string
  URL for the link

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link"
        }
    },
    "description":"It represents a Link"
}

Examples

Select an example Payload

400 Response

Bad Request

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

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

404 Response

Not Found

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

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