Skip to content

Namespace cmdb.impact#

Work in Progress

cmdb.impact.read#

This method is used for impact analysis and recursively returns all relationships of the specified object. The output can be restricted by specifying the relationship type.
Attention: Depending on the environment and filling of the database this query may take some time and server resources (especially memory).

Request parameters#

Key JSON data type Required Description
id Integer Yes Object identifier, for example: 9
relation_type String or Integer Yes Constant of the relationship type or ID of the relationship type, for example 4

Default relation types are:

Title ID Constant
Software assignment 1 C__RELATION_TYPE__SOFTWARE
Cluster service assignment 2 C__RELATION_TYPE__CLUSTER_SERVICE
Backup 3 C__RELATION_TYPE__BACKUP
Contact assignment 4 C__RELATION_TYPE__ADMIN
Contact assignment 5 C__RELATION_TYPE__USER
Cluster memberships 6 C__RELATION_TYPE__CLUSTER_MEMBERSHIPS
Power consumer 7 C__RELATION_TYPE__POWER_CONSUMER
Ports 8 C__RELATION_TYPE__NETWORK_PORT
Virtual machine 9 C__RELATION_TYPE__VIRTUAL_MACHINE
Location 10 C__RELATION_TYPE__LOCATION
Interface 11 C__RELATION_TYPE__UNIVERSAL_INTERFACE
Host address 12 C__RELATION_TYPE__IP_ADDRESS
FC port 13 C__RELATION_TYPE__CONTROLLER_FC_PORT
Connectors 14 C__RELATION_TYPE__CONNECTORS
Logical devices (Client) 15 C__RELATION_TYPE__LDEV_CLIENT
Group memberships 16 C__RELATION_TYPE__GROUP_MEMBERSHIPS
Person group memberships 17 C__RELATION_TYPE__PERSON_ASSIGNED_GROUPS
Dependency 18 C__RELATION_TYPE__DEFAULT
Database access 19 C__RELATION_TYPE__DATABASE_ACCESS
Database links 20 C__RELATION_TYPE__DATABASE_LINK
Database gateway 21 C__RELATION_TYPE__DATABASE_GATEWAY
Database instance 22 C__RELATION_TYPE__DATABASE_INSTANCE
Service component 23 C__RELATION_TYPE__IT_SERVICE_COMPONENT
Replication partner 24 C__RELATION_TYPE__REPLICATION_PARTNER
SOA-Component 25 C__RELATION_TYPE__SOA_COMPONENTS

Response parameters#

JSON key result contains an array of JSON objects. Each object contains a search result.

Key JSON data type Description
id String Placeholder
name String Placeholder
data String Placeholder
type String Placeholder
text String Placeholder
relation String Placeholder
statusColor String Placeholder
objTypeID String Placeholder
objectType String Placeholder
objID String Placeholder

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "version": "2.0",
  "method": "cmdb.impact.read",
  "params": {
    "id": 9,
    "relation_type": 4,
    "apikey": "xxx",
    "language": "en"
  },
  "id": 1
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": [
    {
      "id": 123,
      "name": "CareBear Power Client",
      "data": {
        "relation": {
          "type": "Contact assignment",
          "text": "administrates"
        },
        "color": "B9E1BE",
        "statusColor": "33C20A",
        "objTypeID": 10,
        "objectType": "Client",
        "objID": 1122714692
      }
    }
  ]
}