Skip to content

cmdb.object_type_groups#

Work in Progress

cmdb.object_type_groups#

Read object type groups.

Request parameters#

Key JSON data type Required Description
filter Array No Filter list of objects; see below for a full list of options
limit Mixed No Maximum amount of objects (as integer), for example, fetch the first thousand of objects: 1000

Combine this limit with an offset (as string), for example, fetch the next thousand of objects: "1000,1000"
sort String No Only useful in combination with key order_by; allowed values are either "ASC" (ascending) or "DESC" (descending)
order_by String No Order result set by (see filter for more details what each value means):
- "email",
- "first_name",
- "id",
- "last_name",
- "sysid",
- "type",
- "title",
- "type_title"
raw Boolean No Displayed raw formatting, see example.

Filter#

Key JSON data type Required Description
id Integer No Object type group ID
ids Array No List of object type group identifiers (as integers), for example: [1, 2, 3]
title String No Object type group language constant, for example: LC__CMDB__OBJTYPE_GROUP__INFRASTRUCTURE for Server
titles Array No List of Object type group language constants, for example: ["LC__CMDB__OBJTYPE_GROUP__INFRASTRUCTURE","LC__CMDB__OBJTYPE_GROUP__SOFTWARE"]

You can use any combination of filters. Filters are logically associated with AND. A valid combination could be: "Give me all servers which have the same hostname."

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
13
{
  "version": "2.0",
  "method": "cmdb.object_type_groups",
  "params": {
    "filter": {
      "ids": [1,2,3,4,1000]
    },
    "raw": false,
    "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
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": [
    {
      "id": "1",
      "title": "Software",
      "const": "C__OBJTYPE_GROUP__SOFTWARE",
      "status": "2"
    },
    {
      "id": "2",
      "title": "Infrastructure",
      "const": "C__OBJTYPE_GROUP__INFRASTRUCTURE",
      "status": "2"
    },
    {
      "id": "3",
      "title": "Other",
      "const": "C__OBJTYPE_GROUP__OTHER",
      "status": "2"
    },
    {
      "id": "4",
      "title": "Orphaned object types",
      "const": "C__OBJTYPE_GROUP__ORPHANED",
      "status": "2"
    },
    {
      "id": "1000",
      "title": "Contact",
      "const": "C__OBJTYPE_GROUP__CONTACT",
      "status": "2"
    }
  ]
}