Skip to content

Namespace cmdb.categories#

Work in Progress

cmdb.categories.read#

To retrieve multiple categories with a single request, you should use the method cmdb.categories.read. As mentioned above, it is helpful to use cmdb.object_type_categories in advance to obtain the available catgID (global categories) and catsID (specific categories).

Request parameters#

Key JSON data type Required Description
objID Integer Yes ID of the object
catgID Integer No catgid of a category, can be retrieved via cmdb.object_type_categories
catsID Integer No catsid of a category, can be retrieved via cmdb.object_type_categories

WIP

Response parameters#

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

Key JSON data type Description
Placeholder Placeholder Placeholder
Placeholder Placeholder Placeholder

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "version": "2.0",
  "method": "cmdb.categories.read",
  "params": {
    "objID": 62,
    "catgID": 1,
    "catsID": 48,
    "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
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "catgID": {
      "C__CATG__GLOBAL": {
        "id": "62",
        "objID": "62",
        "title": "Michael Huhn",
        "status": {
          "id": "2",
          "title": "Normal",
          "const": "",
          "title_lang": "LC__CMDB__RECORD_STATUS__NORMAL"
        },
        "created": "2023-08-15 08:28",
        "created_by": "admin",
        "changed": "2023-08-15 09:03",
        "changed_by": "admin",
        "purpose": null,
        "category": null,
        "sysid": "SYSID_1692080956",
        "cmdb_status": {
          "id": "6",
          "title": "in operation",
          "const": "C__CMDB_STATUS__IN_OPERATION",
          "title_lang": "LC__CMDB_STATUS__IN_OPERATION"
        },
        "type": {
          "id": "53",
          "title": "Persons",
          "const": "C__OBJTYPE__PERSON",
          "title_lang": "LC__CONTACT__TREE__PERSON"
        },
        "tag": null,
        "description": ""
      }
    },
    "catsID": {
      "C__CATS__PERSON": {
        "id": "8",
        "title": "",
        "salutation": null,
        "first_name": "Michael",
        "last_name": "Huhn",
        "academic_degree": "",
        "function": "",
        "service_designation": "",
        "street": "",
        "city": "",
        "zip_code": "",
        "mail": "mHuhn@i-doit.com",
        "phone_company": "",
        "phone_home": "",
        "phone_mobile": "",
        "fax": "",
        "pager": "",
        "personnel_number": "",
        "department": "",
        "organization": [],
        "ldap_id": null,
        "ldap_dn": "",
        "description": "",
        "custom_1": "",
        "custom_2": "",
        "custom_3": "",
        "custom_4": "",
        "custom_5": "",
        "custom_6": "",
        "custom_7": "",
        "custom_8": ""
      }
    }
  }
}