Jump to

• Request
• Response

Get Image Version

get

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

Gets information regarding the specified version of the image

Request

Path Parameters

• goldImageId(required): string
  ID of the image
• versionId(required): string
  ID of the image version

Query Parameters

• include: string
  Provide a report if this version of the image can be deleted

  Allowed Values: [ "deleteVersionReport" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. Image version is retrieved.

Body ()

Root Schema : GoldImageVersion

Type: object

Summary of the image version

Match All

Summary of the image version

Show Source

• object GoldImageVersionSummary
  Summary of the image version

{
    "description":"Summary of the image version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageVersionSummary"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/DeleteGoldImageVersionReport"
        }
    ]
}

Match One Schema

Show Source

• object DeleteGoldImageVersionReport
  Delete gold image version report

{
    "description":"Summary of the image version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageVersionSummary"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/DeleteGoldImageVersionReport"
        }
    ]
}

Nested Schema : GoldImageVersionSummary

Type: object

Summary of the 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
• imageId: string
  ID of the image

  Example: 4B7738536B6E7888E053057FB10ACF8C
• links: object links
  Navigation links
• name: string
  Name of the image version

  Example: PSUNos
• position: string
  Position of a image version

  Example: 1
• provisioningStatus: string
  Status of the provisioning

  Example: READY
• releaseVersion: string
  RU details of the version

  Example: 19.12.0.0.0
• status: string
  Status of the image version

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

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

{
    "description":"Summary of the 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"
        },
        "imageId":{
            "description":"ID of the image",
            "type":"string",
            "example":"4B7738536B6E7888E053057FB10ACF8C"
        },
        "externalId":{
            "description":"External ID of the image version",
            "type":"string",
            "example":"oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1"
        },
        "status":{
            "description":"Status of the image version",
            "type":"string",
            "example":"CURRENT"
        },
        "position":{
            "description":"Position of a image 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"
        },
        "provisioningStatus":{
            "description":"Status of the provisioning",
            "type":"string",
            "example":"READY"
        },
        "releaseVersion":{
            "description":"RU details of the version",
            "type":"string",
            "example":"19.12.0.0.0"
        },
        "links":{
            "type":"object",
            "description":"Navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : DeleteGoldImageVersionReport

Type: object

Delete gold image version report

Show Source

• message: string
  Message indicates whether image version can be deleted

  Example: if the version is not CURRENT then message is "The version is a candidate for deletion." else message is "CURRENT version of the image cannot be deleted"

{
    "description":"Delete gold image version report",
    "type":"object",
    "properties":{
        "message":{
            "description":"Message indicates whether image version can be deleted",
            "type":"string",
            "example":"if the version is not CURRENT then message is \"The version is a candidate for deletion.\" else message is \"CURRENT version of the image cannot be deleted\""
        }
    }
}

Nested Schema : links

Type: object

Navigation links

Show Source

• self: object Link
  It represents a Link

{
    "type":"object",
    "description":"Navigation links",
    "properties":{
        "self":{
            "$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