GetWorkRequest
get
/20180222/workRequests/{work_request_id}
Get the details of a work request.
Request
Supported Media Types
- application/json
Path Parameters
-
workRequestId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the work request.
Header Parameters
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Response
Supported Media Types
- application/json
200 Response
The work request.
Headers
-
etag: string
For optimistic concurrency control. See if-match.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
-
retry-after: integer
The number of seconds to should wait before polling this endpoint again.
Root Schema : WorkRequest
Type:
object
An asynchronous work request.
Show Source
-
compartmentId(required):
string
The OCID of the compartment that contains the work request.
-
id(required):
string
The OCID of the work request.
-
operationType(required):
string
The asynchronous operation tracked by this work request.
-
percentComplete(required):
number(float)
The percentage complete of the operation tracked by this work request.
-
resources(required):
array resources
The resources that are affected by this work request.
-
status(required):
string
Allowed Values:
[ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" ]
The status of the work request. -
timeAccepted(required):
string(date-time)
The date and time the work request was created, in the format defined by RFC3339.
-
timeFinished:
string(date-time)
The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the format defined by RFC3339.
-
timeStarted:
string(date-time)
The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.
Nested Schema : resources
Type:
array
The resources that are affected by this work request.
Show Source
-
Array of:
object WorkRequestResource
A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
Nested Schema : WorkRequestResource
Type:
object
A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
Show Source
-
actionType(required):
string
Allowed Values:
[ "CREATED", "UPDATED", "DELETED", "RELATED", "IN_PROGRESS", "FAILED" ]
The way in which this resource was affected by the operation that spawned the work request. -
entityType(required):
string
The resource type the work request affects.
-
entityUri:
string
The URI path that you can use for a GET request to access the resource metadata.
-
identifier(required):
string
An OCID or other unique identifier for the resource.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload