Get an Instance

Topics:

Use the following service to get an instance using its unique identifier.

GET: /server/api/v1/server/instance/{subject}/{sourceName}/{sourceInstanceId}

Topics:

  • {subject} – Required subject name.
  • {sourceName} – Required source name of the instance.
  • {sourceInstanceId} – Required instance identifier.

Example:

GET https://localhost:9514/server/api/v1/server/instance/customer/ReadTest/ReadTestCustomer

-- response --

200 OK
Server:  Apache-Coyote/1.1
X-Application-Context:  application:9500
Content-Type:  application/xml;charset=UTF-8
Content-Length:  1256
Date:  Tue, 08 May 2018 15:42:07 GMT

<RestResponse>  
<status>0</status>  
<statusText></statusText>  
<responseType>java.lang.String</responseType>  <response>
<customer>
  <SourceName>ReadTest</SourceName>  
  <SourceInstanceId>ReadTestCustomer</SourceInstanceId>  
  <MasterId>26</MasterId>  
  <cu_title>Developer</cu_title>  
  <cu_salutation>Mr</cu_salutation>  
  <cu_suffix>Phd</cu_suffix>  
  <cu_first_name>Scott</cu_first_name>  
  <cu_middle_name>W</cu_middle_name>  
  <cu_last_name>Bishopp</cu_last_name>  
  <cu_full_name>Mr Scott W Bishopp Phd</cu_full_name>  
  <cu_gender>M</cu_gender>  
  <cu_dob format="yyyy-MM-dd">1965-02-21</cu_dob>  
  <cu_ssn>874-98-4546</cu_ssn>  
  <cu_type>P</cu_type>  
  <cu_bus_name>IBI</cu_bus_name>  
  <cu_dba_name>SCOTTYB</cu_dba_name> 
 <cust_addressOmniCollection> 
    <customercust_address>
      <SourceName>ReadTest</SourceName>  
      <SourceInstanceId>ReadTest:address</SourceInstanceId>  
      <ad_1>4212 S LIVONIA RD</ad_1>  
      <ad_2>ATTN: SCOTT BISHOPP</ad_2>  
      <ad_city>LIVONIA</ad_city>  
      <ad_state>NY</ad_state>  
      <ad_zip>14487</ad_zip>  
      <ad_zip4>0212</ad_zip4>  
      <ad_country>US</ad_country> 
    </customercust_address>
  </cust_addressOmniCollection> 
</customer>
</response>
</RestResponse>