Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Retrieving details of any specific Integration Service

The list API uses the GET method to retrieve details of any specific Integration Service. You must provide authentication credentials by using the login API before retrieving detail of an integration service. For information about the authentication process, see Web-services-authentication.

URL to access the list API

The generic format of a URL for the list API is as follows: 

http|https://<serverHost>:<port>/bppmws/api/unifiedadmin/
IntegrationService/<identifier>/list

Example

http://bppmwsserver:80/bppmws/api/unifiedadmin/IntegrationService/
BPPM2|hostIS~12124/list

Response information for the list API

A sample JSON response is as follows:

{
   "response": [
       {
           "integrationService": {
               "hostname": "host1",
               "isClusterName": "bppm-1234-ISCluster",
               "bppmserver": "BPPMhost",
               "connectionModeToServer": "TCP_IP_DIRECT",
               "serviceType": "staging",
               "eventDestination": {
                   "destinationDetails": {
                       "cellName": "bppmws_cell"
                   },
                   "destination": "REMOTE_CELL"
               },
               "name": "IS1",
               "port": "12124"
           },
           "statusCode": "200",
           "statusMsg": "OK",
           "resourceURI": "BPPM2|hostIS~12124",
           "resourceName": "IS1"
       }
    ],
   "statusCode": "200",
   "statusMsg": "OK",
   "responseTimeStamp": "2013-03-29T10:36:18"
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*