Skip to content

Namespace cmdb.cabling#

Work in Progress

cmdb.cabling.read#

This endpoint retrieves information about which connector is connected to a cable object.

Request parameters#

Key JSON data type Required Description
objID Integer Yes ID of the object

WIP

Response parameters#

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

Key JSON data type Description
start Object Represents the starting point of the wiring connection.
end Object Represents the starting point of the wiring connection.

Example#

1
2
3
4
5
6
7
8
9
{
    "jsonrpc": "2.0",
    "method": "cmdb.cabling.read",
    "id": 1,
    "params": {
        "objID": 2821,
        "apikey": [{api-key}]
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "start": {
            "presentation": "server11 > server_output11",
            "connector": {
                "id": 2,
                "title": "server_output11",
                "type": "C__CATG__CONNECTOR",
                "inOutput": "Output"
            },
            "ciObject": {
                "id": 162,
                "title": "server11",
                "type": "Server",
                "typeConstant": "C__OBJTYPE__SERVER"
            }
        },
        "end": {
            "presentation": "switch_classic > input_switch11",
            "connector": {
                "id": 3,
                "title": "input_switch11",
                "type": "C__CATG__CONNECTOR",
                "inOutput": "Input"
            },
            "ciObject": {
                "id": 172,
                "title": "switch_classic",
                "type": "Switch",
                "typeConstant": "C__OBJTYPE__SWITCH"
            }
        }
    }
}

See also#