Skip to content

Namespace cmdb.dialog#

Work in Progress

cmdb.dialog.read#

Read dialog information.

Request parameters#

Key JSON data type Required Description
category String Yes Category constant, for example: "C__CATG__CPU"
property String Yes Attribute in the category, for example: "manufacturer"

Response parameters#

JSON key result contains an array of JSON objects.

Key JSON data type Description
id String Identifier
const String Constant of Dialog Attribute
title String Title of the Attribute

Example#

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [
        {
            "id": "1",
            "const": "",
            "title": "AMD"
        },
        {
            "id": "2",
            "const": "",
            "title": "Intel"
        }
    ]
}

cmdb.dialog.create#

Created Dialogs.

Request parameters#

Key JSON data type Required Description
category String Yes Category constant, for example: "C__CATG__CPU"
property String Yes Attribute in the category, for example: "manufacturer"
value String Yes Value of the Attribute

Response parameters#

JSON key result contains a JSON object.

Key JSON data type Description
success Boolean Should be true
entry_id Integer Entry Identifier, for example: 3

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "version": "2.0",
  "method": "cmdb.dialog.create",
  "params": {
    "category": "C__CATG__CPU",
    "property": "manufacturer",
    "value": "IBM",
    "apikey": "xxx",
    "language": "en"
  },
  "id": 1
}

1
2
3
4
5
6
7
8
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "success": true,
    "entry_id": 3
  }
}

cmdb.dialog.update#

Update a dialog entry.

Request parameters#

Key JSON data type Required Description
category String Yes Category constant, for example: "C__CATG__CPU"
property String Yes Attribute in the category, for example: "manufacturer"
value String Yes Value of the Attribute
entry_id Integer Yes Entry Identifier, for example: 3

Response parameters#

JSON key result contains a JSON object.

Key JSON data type Description
success Boolean Should be true
entry_id Integer/String Entry Identifier, for example: 3

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "version": "2.0",
  "method": "cmdb.dialog.update",
  "params": {
    "category": "C__CATG__CPU",
    "property": "manufacturer",
    "entry_id": 3,
    "value": "IBM",
    "apikey": "xxx",
    "language": "en"
  },
  "id": 1
}

1
2
3
4
5
6
7
8
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "success": true,
    "entry_id": "3"
  }
}

cmdb.dialog.delete#

Deletes dialogs.

Request parameters#

Key JSON data type Required Description
category String Yes Category constant, for example: "C__CATG__CPU"
property String Yes Attribute in the category, for example: "manufacturer"
entry_id Integer Yes Entry Identifier, for example: 3

Response parameters#

JSON key result contains a JSON object.

Key JSON data type Description
success Boolean Should be true
entry_id Integer/String Entry Identifier, for example: 3

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "version": "2.0",
  "method": "cmdb.dialog.delete",
  "params": {
    "category": "C__CATG__CPU",
    "property": "manufacturer",
    "entry_id": 3,
    "value": "IBM",
    "apikey": "h3md6u3y",
    "language": "en"
  },
  "id": 1
}

1
2
3
4
5
6
7
8
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "success": true,
    "entry_id": 3
  }
}