Get Service method

Use the Get Service method to receive an XML file that contains information about a service.

HTTP method: GET

URI: /service/connection_name/service_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 service. Y
service_id Enter the ID that identifies the service whose information you want to view. Y

Response payload example

The following example shows an XML file that contains information about the requested service. The information includes the service name, path, type, and platform.
<?xml version="1.0" encoding="UTF-8"?>
<srm:service xmlns:atom="http://www.w3.org/2005/Atom" 
 xmlns:srm="http://www.ibm.com/optim/xsd/srm/9.1.0" 
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 xsi:schemaLocation="http://www.ibm.com/optim/xsd/srm/9.1.0 
 resource.xsd ">
  <serviceId>fbf1cdd5-bdf7-4682-96ad-722672af0001</serviceId>
  <serviceName>SIDEMO.ERGL23393T</serviceName>
  <servicePath>OPTIMDIR/SMK_V910</servicePath>
  <serviceType>com.ibm.nex.model.oim.distributed.ExtractRequest</serviceType>
  <servicePlatform>com.ibm.nex.ois.runtime.productplatform.distributed</servicePlatform>
</srm:service>

Response codes

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

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


Feedback