Jump to

• Request
• Response

Get Image

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}

Gets the image information

Request

Path Parameters

• goldImageId(required): string
  ID of the image

Query Parameters

• include: string
  Provide a report on the versions of this image that can be deleted or if the image also be deleted in case there are no subscribers to the same

  Allowed Values: [ "deleteImageReport" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. Image information is retrieved.

Body ()

Root Schema : GoldImage

Summary of the image

Match All

Show Source

• object GoldImageCommonSummary
  Common image summary

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

Match Any

Show Source

• object DeleteGoldImageReport
  Delete gold image report

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

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

Type: object

Delete gold image report

Show Source

• imageVersions: array imageVersions
  Array of the image versions, which are candidates for deletion
• message: string
  Message indicates whether the image can be deleted

  Example: If the image does not have subscriptions, then the message is "The following versions are candidates for deletion." else the message is "The image has active subscriptions hence cannot be deleted.Please delete all subscriptions or use force option to delete the image and following versions are candidate for deletion"

{
    "description":"Delete gold image report",
    "type":"object",
    "properties":{
        "message":{
            "description":"Message indicates whether the image can be deleted",
            "type":"string",
            "example":"If the image does not have subscriptions, then the message is \"The following versions are candidates for deletion.\" else the message is \"The image has active subscriptions hence cannot be deleted.Please delete all subscriptions or use force option to delete the image and following versions are candidate for deletion\""
        },
        "imageVersions":{
            "description":"Array of the image versions, which are candidates for deletion",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DeletableGoldImageVersionCandidate"
            }
        }
    }
}

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

Type: array

Array of the image versions, which are candidates for deletion

Show Source

• Array of: object DeletableGoldImageVersionCandidate
  Information on safe delete gold image/version

{
    "description":"Array of the image versions, which are candidates for deletion",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DeletableGoldImageVersionCandidate"
    }
}

Nested Schema : DeletableGoldImageVersionCandidate

Type: object

Information on safe delete gold image/version

Show Source

• externalId: string
  External ID of the image version

  Example: oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1
• hashCode: string
  HashCode of the image version

  Example: C1622270664:B<NO_PATCHES>
• id: string
  ID of the image version

  Example: 4BAFA861A7ED6603E053057FB10A0588
• name: string
  Name of the image version

  Example: PSUNos
• position: string
  Position of a version

  Example: 1
• timeCreated: string (date-time)
  Creation time of the image version

  Example: 2017-03-27 10:13:28.0

{
    "description":"Information on safe delete gold image/version",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the image version",
            "type":"string",
            "example":"PSUNos"
        },
        "id":{
            "description":"ID of the image version",
            "type":"string",
            "example":"4BAFA861A7ED6603E053057FB10A0588"
        },
        "externalId":{
            "description":"External ID of the image version",
            "type":"string",
            "example":"oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1"
        },
        "position":{
            "description":"Position of a version",
            "type":"string",
            "example":"1"
        },
        "hashCode":{
            "description":"HashCode of the image version",
            "type":"string",
            "example":"C1622270664:B<NO_PATCHES>"
        },
        "timeCreated":{
            "description":"Creation time of the image version",
            "type":"string",
            "format":"date-time",
            "example":"2017-03-27 10:13:28.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