Jump to

• Request
• Response

Gets the details of an upgrade job.

get

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

Gets the details of an upgrade job.

Request

Query Parameters

• upgradeJobId(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 : UpgradeJob

Type: object

This object represents the data returned from the UWS getJobDetails call.

Show Source

• arguments: string
  Maximum Length: 64
• compositionId: string
  Maximum Length: 64
• endTime: string
  Maximum Length: 64
• executionTime: integer
• faultIds: array faultIds
• host: string
  Maximum Length: 64
• logFile: string
  Maximum Length: 64
• name: string
  Maximum Length: 64
• pid: string
  Maximum Length: 64
• process: string
  Maximum Length: 64
• startTime: string
  Maximum Length: 64
• status: string
  Allowed Values: [ "PASSED", "FAILED", "RUNNING", "NOTRUN", "CANCELLED", "WARN", "NONE" ]
• tasks: array tasks
• upgradeRequestId: string
  Maximum Length: 64

{
    "properties":{
        "upgradeRequestId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "compositionId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "name":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "startTime":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "endTime":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "pid":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "host":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "logFile":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "arguments":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "process":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "status":{
            "description":"",
            "enum":[
                "PASSED",
                "FAILED",
                "RUNNING",
                "NOTRUN",
                "CANCELLED",
                "WARN",
                "NONE"
            ],
            "type":"string"
        },
        "executionTime":{
            "description":"",
            "type":"integer"
        },
        "tasks":{
            "description":"",
            "type":"array"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "type":"object",
    "description":"This object represents the data returned from the UWS getJobDetails call."
}

Nested Schema : faultIds

Type: array

Nested Schema : tasks

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