Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the hideelements-macro macro with the following parameter(s): []
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

truetruetruetrue

You can retrieve the CI relationships using the following API. 

To authenticate the below API, see API Authentication and Authorization.

Service NameHTTP Method
CMDB_GetCIRelationship

POST

Below is the sample request to retrieve the CI relationships.

Code Block
themeDJango
titleSample Request
linenumberstrue
{
  "ServiceName": "CMDB_GetCIRelationship",
  "objCommonParameters": {
    "_ProxyDetails": {
      "ProxyID": 0,
      "ReturnType": "JSON",
      "APIKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "AuthType": "APIKEY"
    },
    "_CMDBDetails": {
      "InstanceName": "CMT",
      "Configuration_Id": "354",
      "Device_Host_Name": "",
      "Serial_No": "",
      "IPAddress": "",
      "CurrentPageIndex": 0,
      "PageSize": 0
    }
  }
}

Anchor
Request Parameters
Request Parameters
Request Parameters

Parameter NameMandatoryDescriptionTypeNotes

InstanceName 

Status
colourGreen
titletrue

Name of the Instance.

For Example: Info

Status
colourGreen
titlestring


Configuration_Id

Status
colourGrey
titlefalse

Unique Identification number of the Configuration Item (CI).

Status
titleInteger


You are required to specify any one of these parameter as mandatory (*).

Device_Host_Name 

Status
colourGrey
titlefalse

Name of the device Host.

Status
colourGreen
titlestring

Serial_No 

Status
colourGrey
titlefalse

Serial number of the CI.

Status
colourGreen
titlestring

IPAddress

Status
colourGrey
titlefalse

IP Address of the CI.

Status
colourGreen
titlestring

CurrentPageIndex 

Status
colourGrey
titlefalse

Current Index of the page that you are looking into.

Status
titleInteger

Example:

If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the  CurrentPageIndex value as 0.

PageSize 

Status
colourGrey
titlefalse

Number of records that should be displayed per each page.

Status
titleInteger

If you do not specify any value, by default, the page displays 20 records with the CurrentPageIndex value as 0.

Example:

Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records.

Code Block
themeDJango
titleSample Response
linenumberstrue
{
  "Errors": "",
  "Message": "5 CI Relationship Record(s) found.",
  "Output": "",
  "TokenID": "1D82B465C5D100A4B5DD92354AA1A4A288F5F57D1C44B61E00B7B1BD1BFDCF5D958500B60CA963F3940CAB8EEA
3AB427923DA6C3AB3E2CDA9C5D5800D50317DEB2CA9CED2C8A5DEBF825D04DBE8FE3399C4A84BD48B40CF338987D77C1A9D4953A8
D6358824BF24F5EFB0B8170AA756347997080503B47200B43818EAADB758FDD047C4FD0FD2098195BFEC85E72FC3A656359A1CF96
C74A5EDC77370FF4EA47",
  "OrgID": 0,
  "OutputObject": {
    "TotalRecords ": 5,
    "CIRelations": [
      {
        "ID": 4,
        "RelationshipType": "SERVICE",
        "Classification": "SERVICE",
        "ServiceName": "Service243",
        "Criticality": "",
        "Device_HostName": "",
        "Serial_No": "",
        "IPAddress": "",
        "MAC_Address": "",
        "Location": ""
      },
      {
        "ID": 41,
        "RelationshipType": "PARENT",
        "Classification": "Desktop",
        "ServiceName": "",
        "Criticality": "",
        "Device_HostName": "TestNew56",
        "Serial_No": "New343",
        "IPAddress": null,
        "MAC_Address": null,
        "Location": null
      }
    ]
  },
  "OutputID": 0,
  "Input": null
}

Status and Error Codes

For more information, see Status and Error Messages

Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
1

| |