Retrieving details of all the Integration Services

The list API uses the PUT method to retrieve details of all the Integration Services. You must provide authentication credentials by using the login API before retrieving the details of all the integration services. 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/list&responseType=basic

Example

http://bppmwsserver:80/bppmws/api/unifiedadmin/IntegrationService/
list&responseType=basic

Entry	Description
http\|https	Type of protocol to send the request. Infrastructure Management support both HTTP and HTTPS protocols.
serverHost	Host name of the Central Server
port	Port number through which communication is established. The default port number is 80 if you use the HTTP protocol and 443 if you use the HTTPS protocol.

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": "BPPMhost|host1~12124", 
            "resourceName": "IS1"
        }, 
        {
            "integrationService": {
                "hostname": "host1", 
                "isClusterName": "bppm-1234-ISCluster", 
                "bppmserver": "BPPMhost", 
                "connectionModeToServer": "TCP_IP_DIRECT", 
                "eventDestination": {
                    "destinationDetails": {
                        "cellName": "bppmws_cell1"
                    }, 
                    "destination": "REMOTE_CELL"
                }, 
                "name": "IS2", 
                "port": "12125"
            }, 
            "statusCode": "200", 
            "statusMsg": "OK", 
            "resourceURI": "BPPMhost|host1~12125", 
            "resourceName": "IS2"
        }
    ], 
    "statusCode": "200", 
    "statusMsg": "OK", 
    "responseTimeStamp": "2013-03-29T10:36:18", 
}

Page tree

Retrieving details of all the Integration Services

URL to access the list API

Response information for the list API