List Work Request Errors
get
/20190828/workRequests/{workRequestId}/errors
Return a (paginated) list of errors for a given work request.
Request
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:1000
-
page: string
Minimum Length:
1
Maximum Length:1024
The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Header Parameters
-
opc-request-id: string
The client request ID for tracing.
Response
Supported Media Types
- application/json
200 Response
A collection of WorkRequestError.
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.
Root Schema : WorkRequestErrorCollection
Type:
object
Results of ListWorkRequestErrors
Show Source
-
items(optional):
array items
A page of WorkRequestError objects.
Nested Schema : items
Type:
array
A page of WorkRequestError objects.
Show Source
-
Array of:
object WorkRequestError
An error encountered while executing a work request.
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.
400 Response
Bad Request
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.
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.
401 Response
Unauthorized
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.
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.
404 Response
Not Found
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.
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.
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.
-
retry-after: number(float)
A decimal number representing the number of seconds the client should wait before polling this endpoint again.
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.
500 Response
Internal Server 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.
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.
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.
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.