Cancel outstanding universal work object
post
/crmRestApi/resources/11.13.18.05/universalWorkObjects/action/cancelWork
This method cancels the queue or agent assignment of outstanding universal work object.
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
cancelReason: string
Cancel the outstanding universal work object identified by the work identifier using the specified reason for canceling the work.
-
deleteWorkFlag: boolean
Cancel the outstanding universal work object identified by the work identifier and delete it if deleteWorkFlag is set to true.
-
workId: number
Cancel the outstanding universal work object identified by the work identifier.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): string
Cancel the outstanding universal work object identified by the work identifier and return the response code.