Updating a Integration Service cluster
The update API uses the PUT method to update a Integration Service cluster. You must provide authentication credentials by using the login API before updating the cluster. For information about the authentication process, see Web-services-authentication.
URL to access the update API
The generic format of a URL for the update API is as follows:
http|https://<serverHost>:<port>/bppmws/api/unifiedadmin/IntegrationServiceCluster/
<identifier1>,<identifier2>,...<identifierN>/update?&idType=<IDType>
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. |
identifier1, identifier2,...identifierN | Identifiers of the integration service clusters. The supported identifier types are:
You can provide multiple identifiers, separated by commas. |
idType | Specifies the identifier type for the integration service cluster that the web service request uses. The supported type of resource identifiers are as follows:
The default value is name. |
Input parameters in the JSON format to update a Integration Service cluster
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:
The sample input parameters in the JSON format are as follows:
"integrationServiceCluster": {
"integrationServices": [
{
"action": "addTop",
"host": "bppmIS1",
"port": "1234"
},
{
"action": "remove",
"host": "bppmIS2",
"port": "1235"
}
]
}
}
Attributes | Description |
|---|---|
integrationServices | List of Integration Services that you want to update |
action | Specifies the type of update you want to perform. The supported actions are:
|
host | Name of the Integration Service that is part of the cluster |
name | Name of the Integration Service cluster that you want to update |
description | Description about the Integration Service cluster |
port | Port number through which communication is established |
Response information for the update API
A sample JSON response is as follows:
"response": [
{
"resourceId": "67530e4e-b1ea-4b04-8815-819bfc783e6f",
"statusCode": "200",
"statusMsg": "OK",
"resourceName": "bppmIScluster"
}
],
"statusCode": "200",
"statusMsg": "OK",
"responseTimeStamp": "2012-10-30T13:58:52",
}