Get a Work Request Status
get
/20190828/workRequests/{workRequestId}
Get the status of the work request with the given ID.
Request
Path Parameters
-
workRequestId: string
The ID of the asynchronous request.
Header Parameters
-
opc-request-id: string
The client request ID for tracing.
Response
Supported Media Types
- application/json
200 Response
The detail of the work request.
Headers
-
etag: string
For optimistic concurrency control. See `if-match`.
-
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 : WorkRequest
Type:
object
A description of workrequest status.
Show Source
-
compartmentId:
string
The ocid of the compartment that contains the work request.
-
id:
string
The id of the work request.
-
operationType:
string
Allowed Values:
[ "CREATE_TABLE", "UPDATE_TABLE", "DELETE_TABLE" ]
Type of the work request. -
percentComplete:
number(float)
Percentage of the request completed.
-
resources:
array resources
The resources affected by this work request.
-
status:
string
Allowed Values:
[ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]
Status of current work request. -
timeAccepted:
string(date-time)
The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
-
timeFinished(optional):
string(date-time)
The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
-
timeStarted(optional):
string(date-time)
The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
Nested Schema : resources
Type:
array
The resources affected by this work request.
Show Source
-
Array of:
object WorkRequestResource
A resource created or operated on by a work request.
Nested Schema : WorkRequestResource
Type:
object
A resource created or operated on by a work request.
Show Source
-
actionType:
string
Allowed Values:
[ "CREATED", "UPDATED", "DELETED", "IN_PROGRESS" ]
The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. -
entityType:
string
The resource type the work request affects.
-
entityUri(optional):
string
The URI path to access the resource metadata.
-
identifier:
string
The identifier of the resource the work request affects.
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.