You can link CIs with other CIs using the following API Request.
To authenticate the below API, see API Authentication and Authorization.
| Service Name | HTTP Method |
|---|---|
| CMDB_CreateCIRelations | POST |
Below is the sample request to link a CI.
{
"ServiceName": "CMDB_CreateCIRelations",
"objCommonParameters": {
"_ProxyDetails": {
"ProxyID": 0,
"ReturnType": "JSON",
"APIKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"AuthType": "APIKEY"
},
"_CMDBCIRelations": {
"SourceKey": "CIID",
"TargetKey": "CIID",
"SourceType": "CI",
"TargetType": "CI",
"SourceValue": "354",
"Relationship": "Parent",
"TargetValues": "340"
}
}
}
Request Parameters
| Parameter Name | Mandatory | Description | Type | Linking Type and Parameter Values | ||
|---|---|---|---|---|---|---|
| CI-CI | CI-Service | Service-CI | ||||
SourceKey | TRUE | Description | STRING | The value can be one of the following:
| The value can be one of the following:
| The value is either Service ID or ServiceName. |
TargetKey | TRUE | Name of the Source. | STRING | The value can be one of the following:
| The value is either ServiceID or ServiceName. | The value can be one of the following:
|
SourceType | TRUE | Name of the Target. | STRING | The value is CI. | The value is CI. | The value is Service. |
TargetType | TRUE | Type of Source. | STRING | The value is CI. | The value is Service. | The value is CI. |
SourceValue | TRUE | Type of Target. | STRING or INTEGER | Note: If the Sourcekey parameter value is CIID, the SourceValue parameter value must be numeric or else string. | Note: If the Sourcekey parameter value is ServiceID, the SourceValue parameter value must be numeric or else string. | |
Relationship | TRUE | Value of the Source. | STRING | Note: The Relationship parameter value must not be Service if the SourceKey and Targetkey parameter values are any of the following:
| Note: The Relationship parameter value must be Service if the SourceKey parameter value is one of the following:
| |
TargetValues | TRUE | Relationship between the Source and Target. | STRING or INTEGER | Note: If the TargetKey parameter value is CIID, the TargetValues parameter value must be numeric or else string. | Note: If the TargetKey parameter value is ServiceID, the TargetValues parameter value must be numeric or else string. | Note: If the TargetKey parameter value is CIID, the TargetValues parameter value must be numeric or else string. |
{
"Errors": "",
"Message": "CMDB CI Relations created successfully!",
"Output": "",
"TokenID": null,
"OrgID": 0,
"OutputObject": null,
"OutputID": 0,
"Input": null
}
Status and Error Codes
For more information, see Status and Error Messages