Get Work Orders method

Use the Get Work Orders method to receive an XML file that contains links to the work orders.

HTTP method: GET

URI: /workorder/connection_name

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 orders. Y

Response payload example

The following example shows a response that contains a list of three work orders.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<ns2:workorders xmlns="http://www.w3.org/2005/Atom" 
 xmlns:ns2="http://www.ibm.com/optim/xsd/workorder/9.1.0">
   <atom:link href="http://interface:8080/server/workorder/10047"/>
   <atom:link href="http://interface:8080/server/workorder/10048"/>
   <atom:link href="http://interface:8080/server/workorder/10049"/>
</ns2:workorders>

Response codes

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

Response code Description
200 OK. The work orders links were successfully returned.
400 Bad Request. A malformed request was submitted.
404 Not Found. No work orders exist.


Feedback