Jump to

• Request
• Response

Lists Work Request Errors

get

/20191010/workRequests/{workRequestId}/errors

Returns a paginated list of errors for a given work request.

Request

Supported Media Types

• application/json

Path Parameters

• workRequestId: string
  The ID of the asynchronous request.

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

  Default Value: 10
• page: string
  Minimum Length: 1

  Maximum Length: 1024

  The page at which to start retrieving results.

Header Parameters

• opc-request-id: string
  The client request ID for tracing.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of work request errors.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : WorkRequestErrorCollection

Type: object

Result of a platform list or search. Contains WorkRequestError

Show Source

• items: array items
  Collection of WorkRequestError

{
    "type":"object",
    "description":"Result of a platform list or search. Contains WorkRequestError",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Collection of WorkRequestError",
            "items":{
                "$ref":"#/definitions/WorkRequestError"
            }
        }
    }
}

Nested Schema : items

Type: array

Collection of WorkRequestError

Show Source

• Array of: object WorkRequestError
  An error encountered while executing a work request.

{
    "type":"array",
    "description":"Collection of WorkRequestError",
    "items":{
        "$ref":"#/definitions/WorkRequestError"
    }
}

Nested Schema : WorkRequestError

Type: object

An error encountered while executing a work request.

Show Source

• code: string
  A machine-usable code for the error that occured. Error codes are listed on (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)
• message: string
  A human readable description of the issue encountered.
• timestamp: string(date-time)
  The time the error occured. An RFC3339 formatted datetime string.

{
    "description":"An error encountered while executing a work request.",
    "properties":{
        "code":{
            "type":"string",
            "description":"A machine-usable code for the error that occured. Error codes are listed on\n(https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)\n"
        },
        "message":{
            "type":"string",
            "description":"A human readable description of the issue encountered."
        },
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The time the error occured. An RFC3339 formatted datetime string."
        }
    },
    "required":[
        "code",
        "message",
        "timestamp"
    ]
}

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "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

Service unavailable

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "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