Category: General#

The General category is the central base category of every object in i-doit. It is present in all object types and is automatically created as soon as an object is created. It contains the basic administrative information (name, purpose, CMDB status) and serves as the starting point for filtering and searching in the CMDB.

Usage#

Typical use cases:

• Maintain CMDB status: The CMDB status (In operation, Planned, Out of operation, etc.) allows you to map the lifecycle of an object. Many evaluations and reports specifically filter by this status.
• Document purpose of use: The Purpose field (Production, Test, QA) makes it immediately visible in which environment an object is operated.
• Use tags for grouping: Tags enable flexible cross-cutting grouping across all object types -- e.g. to tag all objects of a project or site.
• Description as free text: The description field is suitable for notes that do not fit in any other field -- such as configuration specifics or maintenance notes.

Fields#

Title#

The name of the object. It is used as the primary identifier throughout the entire CMDB -- in the object list, in relations, and in reports. The name should be unique and descriptive, e.g. srv-web-01 or Switch GF Room 1.12.

CMDB Status#

The most important mandatory field of the category. Maps the lifecycle of an object -- from planning to decommissioning. Default values: Planned, Ordered, Delivered, Assembled, In operation, Out of operation, Scrapped. Many filters, reports, and automated processes (e.g. notifications) rely on this status -- it should be consistently maintained.

Purpose#

Describes the operational context of the object. Typical values: Production, Test, QA, Development. The field is expandable -- custom values can be added at any time. Helpful for separating production and test environments in reports.

Tags#

Free-text tags for flexible cross-cutting grouping. An object can have any number of tags. Tags can be filtered in the object list and evaluated in reports. Example: project-migration-2025, datacenter-fra01.

Description#

A free text field with no length limitation. Information that does not fit in any structured field belongs here: configuration specifics, maintenance history, operational notes.

Category#

A free classification of the object, independent of the object type. Can be used, for example, to group objects by department or project -- supplementary to tags.

SYSID#

A system-wide unique identifier that is automatically assigned by i-doit (e.g. SYSID_1680000001). Useful for integration with external systems when the internal object ID is not suitable. The SYSID is immutable after creation.

Technical Reference#

Fields (API Reference)#

API Examples#

Create an entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "objID": 123,
        "category": "C__CATG__GLOBAL",
        "data": {
            "title": "srv-web-01",
            "cmdb_status": 6,
            "purpose": "Production",
            "description": "Primary web server, operated in datacenter Frankfurt."
        }
    },
    "id": 1
}

Read entries#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.read",
    "params": {
        "apikey": "your-api-key",
        "objID": 123,
        "category": "C__CATG__GLOBAL"
    },
    "id": 2
}

Update an entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "objID": 123,
        "category": "C__CATG__GLOBAL",
        "entry": 1,
        "data": {
            "cmdb_status": 10,
            "description": "Decommissioned on 2025-04-01."
        }
    },
    "id": 3
}