Get Service Instance by execution Id method

Edit online

Use the Get Service Instance by execution Id method to generate XML data that contains information about a service instance. The data includes the service ID and the service instance ID, start time, end time, and return code. The data also lists any associated artifacts, which can be retrieved by using the Get Service Instance Artifact method.

HTTP method: GET

URI: /monitor/connection_name/execution_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 parameter(s):

Name	Description	Required
`connection_name`	Enter the name that identifies the Optim™ directory connection that contains the service instance.	Y
`execution_id`	Enter the execution ID that identifies the service instance whose information you want to view.	Y

Response payload example

The following example shows a service instance with execution ID 34770e5c-e282-47bf-9467-160cda2a1e06. Service SIDEMO.ERGL23393T was started on Thursday, August 1, 2013 at 17:30:00 UTC time (epoch time 1375378200230 in milliseconds). The service completed successfully at 17:33:07 UTC time (epoch time 1375378387206 in milliseconds). The service instance contains the artifacts execution.properties, overrides.txt, run.log, and svc_request.xml.

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<ns2:serviceInstance 
 xmlns:ns2="http://www.ibm.com/optim/xsd/sim/9.1.0">
   <id>34770e5c-e282-47bf-9467-160cda2a1e06</id>
   <serviceId>783015a5-5ad4-43a8-b3be-a45acaba081a</serviceId>
   <serviceName>SIDEMO.ERGL23393T</serviceName>
   <requestType>com.ibm.nex.model.oim.distributed.ExtractRequest</requestType>
   <origin>STAND_ALONE_MANAGER</origin>
   <startTime>1375378200230</startTime>
   <endTime>1375378387206</endTime>
   <returnCode>0</returnCode>
   <artifactList>
      <artifactName>run.log</artifactName>
      <artifactName>svc_request.xml</artifactName>
      <artifactName>execution.properties</artifactName>
      <artifactName>svc_response.xml</artifactName>
      <artifactName>overrides.txt</artifactName>
   </artifactList>
</ns2:serviceInstance>

Response codes

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

Response code	Description
200	OK. The service instance information was successfully returned.
400	Bad Request. A malformed request was submitted.
404	Not Found. The execution ID does not exist.