Retrieving details about BMC ProactiveNet Integration Services
The info API uses the GET method to retrieve details of the BMC ProactiveNet Integration Services running on BMC ProactiveNet Server including the total number of BMC PATROL Agents associated with each BMC ProactiveNet Integration Service. You must provide authentication credentials by using the login API before accessing the data. For information about the authentication process, see Web-services-authentication.
URL to access the info API
The generic format of a URL for the info API is as follows:
http|https://<serverHost>:<port>/bppmws/api/patrol/
integrationservice/info
Response information for the info API
A sample JSON response is as follows:
{
"bppmServers": [
{
"statusMessage": "OK",
"serverName": "bppmtestServer01",
"statusCode": "200",
"integrationService": [
{
"instanceName": "IntegrationService01|Target Availability",
"serviceHost": "bppmtestServer01",
"servicePort": "3182",
"numberOfAgents": 1
}
]
},
{
"statusMessage": "OK",
"serverName": "bppmtestServer02",
"statusCode": "200",
"integrationService": [
{
"instanceName": "IntegrationService02|Target Availability",
"serviceHost": "bppmtestServer02",
"servicePort": "3182",
"numberOfAgents": 2
},
{
"instanceName": "IntegrationService03|Target Availability",
"serviceHost": "bppmtestServer03",
"servicePort": "6698",
"numberOfAgents": 5
}
]
}
],
"statusCode": "200",
"statusMsg": "OK",
"responseTimeStamp": "2012-01-06T06:03:58"
}
"bppmServers": [
{
"statusMessage": "OK",
"serverName": "bppmtestServer01",
"statusCode": "200",
"integrationService": [
{
"instanceName": "IntegrationService01|Target Availability",
"serviceHost": "bppmtestServer01",
"servicePort": "3182",
"numberOfAgents": 1
}
]
},
{
"statusMessage": "OK",
"serverName": "bppmtestServer02",
"statusCode": "200",
"integrationService": [
{
"instanceName": "IntegrationService02|Target Availability",
"serviceHost": "bppmtestServer02",
"servicePort": "3182",
"numberOfAgents": 2
},
{
"instanceName": "IntegrationService03|Target Availability",
"serviceHost": "bppmtestServer03",
"servicePort": "6698",
"numberOfAgents": 5
}
]
}
],
"statusCode": "200",
"statusMsg": "OK",
"responseTimeStamp": "2012-01-06T06:03:58"
}
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*