Related CI API (GET method)
Related CI API (GET method) is used to find the CIs that are related to the CI specified in the URL. It searches using the relationshipType parameter specified in the URL.
The identifier for the CI can be partial or complete. For example, if you want to search the CIs identified by sim in their names, the details of the CIs that have sim in their names are retrieved. The supported identifiers are as follows:
- Name of the CI
- Uniform Resource Identifier of the CI
- Identifier of the CI (CI_ID or RECON_ID)
The relationship types for a CI can be root_causes, possible_causes, impacted_consumers, provider_all, provider_direct, consumer_all, and consumer_direct.
You must provide authentication credentials by using the login API before accessing the data. For information about authentication, see Web services authentication.
URL to access the Related CI API (GET method)
The generic format of a URL for the Related CI API (GET method) is as follows:
http|https://<serverHost>:<port>/bppmws/api/CI/<CI Identifier>/related?
<queryParam1>&<queryParam2>&...<queryParamn>
Example
http://bppmwsserver:80/bppmws/api/CI/nc_1_0/related?
idType=RECON_ID&relationshipType=root_causes
Entry | Description |
|---|---|
http|https | Type of protocol to send the request. Infrastructure Management web services support both HTTP and HTTPS protocols. |
serverHost | Host name of the Infrastructure Management 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. |
CI Identifier | String to identify the CI for which the related CIs are requested. |
queryParam1, queryParam2, queryParamn | Additional parameters that you want to provide in the request. |
Available query parameters (optional) | |
idType | Type of identifier based on which the related CIs are to be searched for the specified CI. The search is not case sensitive. The supported identifier types are as follows:
The default value is RECON_ID. |
| relationshipType | Type of relationship with the specified CI. The supported values are as follows:
The default value is root_causes. |
| routingTarget | Cell names used to search consumers for a distributed service model. This should be a comma separated list. For example, cell1,cell2,cell3 |
| filter | Additional filter provided on the related CIs search result. The supported value is class. For example, filter=class:BMC_BaseElement |
Response information of the Related CI API (GET method)
The response to the Related CI API (GET method) depends on the query parameters that you pass.
A sample JSON response is as follows:
{
"response": {
"size": 0,
"bunchOfRelatedCIs": [
{
"id": "mc.pncell_clm-pun-002870.1400ae32.0",
"className": "BMC_BaseElement",
"hostUri": "HTTP://clm-pun-002870:80",
"hasProviders": false,
"hasConsumers": true,
"attributeMap": {
"Model": "",
"last_status_modification": "1409330738",
"UsersAffected": "0",
"PNReadAcl": "[]",
"WriteSecurity": "[]",
"impact_sla_rollup_status": "NO_SLAS",
"ManufacturerName": "",
"Room": "",
"Item": "",
"PNWriteAcl": "[]",
"DATABASE_event_max_sev": "OK",
"NETWORK_event_max_sev": "OK",
"PriorityWatchdog": "YES",
"data_handle": "1058",
"self_status": "NONE",
"UsingOrganization": "",
"OwnerContact": "",
"maintenance_mode": "NO",
"manual_status_providers": "[]",
"raw_impact_priority": "0",
"schedule_status": "IN",
"StatusModel": "STANDARD",
"pn_predict_to_occur_time": "0",
"any_open_event_max_sev": "OK",
"change_number": "1",
"VersionNumber": "",
"comment": "",
"root_causes": "[l('mc.pncell_clm-pun-002870.1400ae32.0',0x1,IMPACTED)]",
"mc_modification_requestor": "admin",
"DeviceID": "0",
"impacting_open_event_max_sev": "OK",
"InstanceId": "",
"AutoDeleteDelay": "0",
"mc_bad_slot_names": "[]",
"USER_TRANSACTIONS_event_max_sev": "OK",
"SelfPriorityFunction": "BASE_PRIORITY",
"mc_modification_request_time": "1409330738",
"consumer_num": "1",
"DatasetId": "",
"APPLICATION_event_max_sev": "OK",
"SYSTEM_event_max_sev": "OK",
"SiteGroup": "",
"business_data": "",
"shadow_cells": "[]",
"SelfPriorityFunctionParam": "",
"Priority": "PRIORITY_5",
"ReadSecurity": "[]",
"mc_bad_slot_values": "[]",
"PriorityOut": "PRIORITY_5",
"CLASS": "BMC_BaseElement",
"HomeCell": "pncell_clm-pun-002870",
"manual_status_requestor": "admin",
"manual_status_comment": "jjk",
"SerialNumber": "",
"ScheduleId": "",
"Site": "",
"status": "IMPACTED",
"self_priority": "PRIORITY_5",
"direct_events_count": "0",
"component_scope": "LOCAL",
"cost": "0",
"highest_pn_event_score": "0",
"Floor": "",
"ShortDescription": "n/a",
"Notes": "[]",
"manual_status": "IMPACTED",
"manual_status_providers_count": "0",
"HomePageURI": "",
"publish_providers_cis": "[]",
"computed_priority": "PRIORITY_4",
"Type": "",
"consolidate_function": "HIGHEST_VAL",
"possible_causes": "[]",
"sla_rollup_status": "NO_SLAS",
"ImpactCostPerSec": "0",
"TokenId": "0",
"mc_associations": "[]",
"mc_creation_time": "1409330738",
"Region": "",
"impact_status": "NONE",
"ImpactCostPerSecOut": "0",
"Company": "",
"Department": "",
"OwnerName": "",
"Description": "",
"impact_priority": "PRIORITY_5",
"sub_status": "NONE",
"UsingOrganizationId": "-1",
"impact_cost": "0",
"OTHER_event_max_sev": "OK",
"any_event_max_sev": "OK",
"highest_pn_predicted_severity": "",
"computed_status": "OK",
"Name": "B",
"publish_env_id": "",
"Category": "",
"mc_udid": "mc.pncell_clm-pun-002870.1400ae32.0",
"source": "",
"ImpactCostUnit": "",
"mc_modification_time": "1409330738",
"ComponentAliases": "[mc.pncell_clm-pun-002870.1400ae32.0]"
}
}
],
"status": null,
"relatedComponents": null,
"batch": false,
"cellNameToCIidMapping": { }
},
"statusCode": "200",
"statusMsg": "OK",
"statusCodes": [ ],
"responseTimeStamp": "1969-12-31T18:00:00"
}
Comments
Log in or register to comment.