Creating a Integration Service

The create API uses the POST method to create a Integration Service. You must provide authentication credentials by using the login API before creating the integration service. For information about the authentication process, see Web services authentication.

URL to access the create API

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

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

Example

http://bppmwsserver:80/bppmws/api/unifiedadmin/IntegrationService/create

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.

Input parameters in the JSON format to create a Integration Service

You can provide the following parameters in the JSON format along with the URL.

When you provide input parameters for any web service request, you must specify the content-type parameter in the header of the web service request as follows:

content-type application/json

The sample input parameters in the JSON format are as follows:

{
    "integrationService": {
        "hostname": "host1", 
        "isClusterName": "bppm-1234-ISCluster", 
        "bppmserver": "BPPMhost", 
        "connectionModeToServer": "TCP_IP_DIRECT", 
        "serviceType": "STAGING", 
        "eventDestination": {
            "destinationDetails": {
                "cellName": "pncell_pun-sms-lnx11234"
            }, 
            "destination": "REMOTE_CELL"
        }, 
        "name": "IS1", 
        "port": "12124"
    }
}

Attributes	Description
hostname	Name of the computer that you want to host the integration service This parameter is mandatory.
isClusterName	Name of the Integration Service cluster to which the integration service belongs to
bppmserver	Details of the Child Server to which you want to add the integration service. You can either provide the name of the server or the identifier for the Child Server.
connectionModeToServer	Communication protocol between the integration service and the Infrastructure Management Child Sever. The supported values are as follows: TCP_IP_DIRECT TCP_IP_SSL
serviceType	Specifies whether the Integration Service is a staging Integration Service. The supported value is STAGING. "STAGING" must be in capital letters.
eventDestination	Destination where you want to send the events
destinationDetails	Details of the cell name where you want to send the events
cellName	Name of the cell where you want to send the events
destination	Type of destination where you want to send the events. The supported values are as follows: CURRENT_INTEGRATION_SERVICE — Indicates that the events are sent to the cell of the integration service CHILD_SERVER — Indicates the events are sent to the cell of the Child Server REMOTE_CELL — Indicates the events are sent to the cell of the remote cell
name	Name for the Integration Service
port	Port number through which communication is established

Response information for the create API

A sample JSON response is as follows:

{
    "response": [
        {
            "URI": "BPPMhost|host1~1234", 
            "statusCode": "200", 
            "statusMsg": "Successfully created integration service"
        }
    ], 
    "statusCode": "200", 
    "statusMsg": "OK", 
    "responseTimeStamp": "2012-06-20T08:36:24", 
}

Page tree

Creating a Integration Service

URL to access the create API

Input parameters in the JSON format to create a Integration Service

Response information for the create API