Jump to

• Request
• Response

Gets the upgrade plan

get

https://{host}:{port}/{basePath}/UpgradeRequest/getUpgradePlan

gets the upgrade plan

Request

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object UpgradePlan
  UpgradePlan object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UpgradePlan"
    }
}

Nested Schema : UpgradePlan

Type: object

UpgradePlan object.

Show Source

• componentType: string
  Maximum Length: 64
• currentBuild: string
  Maximum Length: 64
• currentVersion: string
  Maximum Length: 64
• faultIds: array faultIds
• impactedInfra: string
  Maximum Length: 64
• qualifier: string
  Maximum Length: 64
• requireReboot: string
  Maximum Length: 64
• requireUpgrade: string
  Maximum Length: 64
• targetBuild: string
  Maximum Length: 64
• targetVersion: string
  Maximum Length: 64
• timeEstimation: string
  Maximum Length: 64

{
    "properties":{
        "componentType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "qualifier":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "currentBuild":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "targetBuild":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "currentVersion":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "targetVersion":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "requireReboot":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeEstimation":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "requireUpgrade":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "impactedInfra":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "type":"object",
    "description":"UpgradePlan object."
}

Nested Schema : faultIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

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.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

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.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

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.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

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.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

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.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top