ListTaggingWorkRequests
get
/20160918/taggingWorkRequests
Lists the tagging work requests in compartment.
Request
Supported Media Types
- application/json
Query Parameters
-
compartmentId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
limit: integer
Minimum Value:
1
Maximum Value:1000
For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.Default Value:100
-
page: string
Minimum Length:
1
Maximum Length:512
For list pagination. The value of the opc-next-page response header from the previous List call.Default Value:oracle.doceng.json.BetterJsonNull@2c07545f
-
resourceIdentifier: string
The identifier of the resource the work request affects.
Response
Supported Media Types
- application/json
200 Response
A list of tagging work requests.
Headers
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
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 : schema
Type:
Show Source
array
-
Array of:
object TaggingWorkRequestSummary
The work request summary. Tracks the status of the asynchronous operation.
Nested Schema : TaggingWorkRequestSummary
Type:
object
The work request summary. Tracks the status of the asynchronous operation.
Show Source
-
compartmentId:
string
The OCID of the compartment that contains the work request.
-
id(required):
string
The OCID of the work request.
-
operationType(required):
string
Allowed Values:
[ "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", "IMPORT_STANDARD_TAGS" ]
An enum-like description of the type of work the work request is doing. -
percentComplete:
number(float)
Minimum Value:
1
Maximum Value:100
How much progress the operation has made. -
resources:
array resources
The resources this work request affects.
-
status(required):
string
Allowed Values:
[ "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "PARTIALLY_SUCCEEDED", "CANCELING", "CANCELED" ]
The current status of the work request. -
timeAccepted:
string(date-time)
Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
-
timeFinished:
string(date-time)
Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
-
timeStarted:
string(date-time)
Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
Nested Schema : resources
Type:
array
The resources this work request affects.
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.
400 Response
Bad Request
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
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
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