Use the Update Work Order method to update a work order. If a state transition is specified, the service interface changes the state of the work order based upon the specified state transition. If email addresses are associated with users in the manager, the service interface also notifies users by email.
HTTP method: PUT
URI: /workorder/connection_name/work_order_id/transition_id
Request payload content type: application/xml
Response payload content type: None
Expected response: HTTP/1.1 200 OK
The method URI contains the following parameters.
| Name | Description | Required |
|---|---|---|
| connection_name | Enter the name that identifies the Optim™ directory connection that contains the work order. | Y |
| work_order_id | Enter the ID that identifies the work order to be updated. | Y |
| transition_id | Enter the ID that identifies the state transition of the work order to be updated. A state transition is a valid change of state for a work order. The manager and the service interface allow only state transitions that are defined in the workflow. Use the Get Active Reachable Transitions method to get a list of state transitions for the current state of the work order. | N |
<?xml version="1.0" encoding="UTF-8"?>
<workorder:workorder xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:workorder="http://www.ibm.com/optim/xsd/workorder/9.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ibm.com/optim/xsd/workorder/9.1.0 resource.xsd ">
<description>Create a subset of customers with personally identifiable information masked</description>
<priority>Within 8 hours</priority>
<comments>Mask names, addresses, phone numbers, email addresses</comments>
<createdBy>TEST1</createdBy>
</workorder:workorder>
The following response codes can be received when the method is complete.
| Response code | Description |
|---|---|
| 200 | OK. The work order was updated. |
| 400 | Bad Request. A malformed request was submitted. |
| 404 | Not Found. The work order ID does not exist. |