Jump to

• Request
• Response

Gets the details of an upgrade job.

get

https://{host}:{port}/{basePath}/UpgradeJob/getUpgradeStatus

Gets the details of an upgrade job.

Request

Query Parameters

• requestId(required): string

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

Type: object

This object represents status of the upgradeRack operation.

Show Source

• completedComponents: array completedComponents
• compositionId: string
  Maximum Length: 64
• endTime: string
  Maximum Length: 64
• jobs: array jobs
• pendingComponents: array pendingComponents
• previousBuild: string
  Maximum Length: 64
• requestId: string
  Maximum Length: 64
• startTime: string
  Maximum Length: 64
• status: string
  Allowed Values: [ "PASSED", "FAILED", "RUNNING", "NOTRUN", "CANCELLED", "WARN", "NONE" ]
• targetBuild: string
  Maximum Length: 64
• timeElapsed: string
  Maximum Length: 64
• timeRemaining: string
  Maximum Length: 64
• type: string
  Maximum Length: 64

{
    "properties":{
        "requestId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "status":{
            "description":"",
            "enum":[
                "PASSED",
                "FAILED",
                "RUNNING",
                "NOTRUN",
                "CANCELLED",
                "WARN",
                "NONE"
            ],
            "type":"string"
        },
        "compositionId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "type":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "previousBuild":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "targetBuild":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "jobs":{
            "description":"",
            "type":"array"
        },
        "completedComponents":{
            "description":"",
            "type":"array"
        },
        "pendingComponents":{
            "description":"",
            "type":"array"
        },
        "timeElapsed":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeRemaining":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "startTime":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "endTime":{
            "description":"",
            "maxLength":64,
            "type":"string"
        }
    },
    "type":"object",
    "description":"This object represents status of the upgradeRack operation."
}

Nested Schema : completedComponents

Type: array

Nested Schema : jobs

Type: array

Nested Schema : pendingComponents

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