Get Work Order method

Use the Get Work Order method to receive an XML file that contains the properties and state of a specified work order. If the work order is associated with a service or a service set, the XML file also specifies the service or service set.

HTTP method: GET

URI: /workorder/connection_name/work_order_id

Request payload content type: None

Response payload content type: application/xml

Expected response: HTTP/1.1 200 OK

Parameters

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 that you want to receive. Y

Response payload example

The following example shows work order 10047, which was created on Thursday, August 1, 2013 at 17:30:00 local time (epoch time 1375378200000 in milliseconds).
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<ns2:workorder xmlns:ns2="http://www.ibm.com/optim/xsd/workorder/9.1.0">
  <id>10047</id> 
  <wfId>1</wfId> 
  <stateId>300</stateId> 
  <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> 
  <createdDate>1375378200000</createdDate> 
</ns2:workorder>
The following example shows work order 10047 after it is associated with a service with service ID fbf1cdd5-bdf7-4682-96ad-722672af0001.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<ns2:workorder xmlns:ns2="http://www.ibm.com/optim/xsd/workorder/9.1.0">
  <id>10047</id> 
  <wfId>1</wfId> 
  <stateId>500</stateId> 
  <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> 
  <createdDate>1375378200000</createdDate> 
  <serviceId>fbf1cdd5-bdf7-4682-96ad-722672af0001</serviceId>
</ns2:workorder>
The following example shows work order 10047 after its association is changed to version 1.0.0 of service set ExtractSet1.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<ns2:workorder xmlns:ns2="http://www.ibm.com/optim/xsd/workorder/9.1.0">
  <id>10047</id> 
  <wfId>1</wfId> 
  <stateId>500</stateId> 
  <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> 
  <createdDate>1375378200000</createdDate> 
  <sSetName>ExtractSet1</sSetName>
  <sSetVersion>1.0.0</sSetVersion>
</ns2:workorder>

Response codes

The following response codes can be received when the method is complete.

Response code Description
200 OK. The work order was successfully returned.
400 Bad Request. A malformed request was submitted.
404 Not Found. The work order ID was not found.


Feedback