diff --git a/config/de/mkdocs.yml b/config/de/mkdocs.yml index 41c299da..b640e44e 100644 --- a/config/de/mkdocs.yml +++ b/config/de/mkdocs.yml @@ -550,6 +550,28 @@ nav: - Methoden: - v1: - i-doit-add-ons/api/methoden/v1/index.md + - cmdb.categories: i-doit-add-ons/api/methoden/v1/cmdb.categories.md + - cmdb.category_info: i-doit-add-ons/api/methoden/v1/cmdb.category_info.md + - cmdb.category: i-doit-add-ons/api/methoden/v1/cmdb.category.md + - cmdb.condition: i-doit-add-ons/api/methoden/v1/cmdb.condition.md + - cmdb.contact: i-doit-add-ons/api/methoden/v1/cmdb.contact.md + - cmdb.dialog: i-doit-add-ons/api/methoden/v1/cmdb.dialog.md + - cmdb.filter: i-doit-add-ons/api/methoden/v1/cmdb.filter.md + - cmdb.impact: i-doit-add-ons/api/methoden/v1/cmdb.impact.md + - cmdb.location_tree: i-doit-add-ons/api/methoden/v1/cmdb.location_tree.md + - cmdb.logbook: i-doit-add-ons/api/methoden/v1/cmdb.logbook.md + - cmdb.object_type_categories: i-doit-add-ons/api/methoden/v1/cmdb.object_type_categories.md + - cmdb.object_type_groups: i-doit-add-ons/api/methoden/v1/cmdb.object_type_groups.md + - cmdb.object_types: i-doit-add-ons/api/methoden/v1/cmdb.object_types.md + - cmdb.object: i-doit-add-ons/api/methoden/v1/cmdb.object.md + - cmdb.objects_by_relation: i-doit-add-ons/api/methoden/v1/cmdb.objects_by_relation.md + - cmdb.objects: i-doit-add-ons/api/methoden/v1/cmdb.objects.md + - cmdb.reports: i-doit-add-ons/api/methoden/v1/cmdb.reports.md + - cmdb.status: i-doit-add-ons/api/methoden/v1/cmdb.status.md + - cmdb.workstation_components: i-doit-add-ons/api/methoden/v1/cmdb.workstation_components.md + - console: i-doit-add-ons/api/methoden/v1/console.md + - idoit: i-doit-add-ons/api/methoden/v1/idoit.md + - addons: i-doit-add-ons/api/methoden/v1/addons.md - v2: - i-doit-add-ons/api/methoden/v2/index.md - cmdb.external: i-doit-add-ons/api/methoden/v2/cmdb.external.md @@ -608,8 +630,7 @@ nav: - Replacement: i-doit-add-ons/replacement.md - SHD SM-VIEW Connect: - i-doit-add-ons/sm-view-connect/index.md - - Telekom-Adapter: i-doit-add-ons/sm-view-connect/telekom-adapter.md - - Baramundi-Adapter: i-doit-add-ons/sm-view-connect/baramundi-adapter.md + - SHD SM-VIEW Connect - Telekom Adapter: i-doit-add-ons/sm-view-connect/telekom-adapter.md - VIVA: - i-doit-add-ons/viva/index.md - Einleitung zu VIVA: i-doit-add-ons/viva/einleitung-zu-viva.md diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/addons.md b/docs/de/i-doit-add-ons/api/methoden/v1/addons.md new file mode 100644 index 00000000..c96949a5 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/addons.md @@ -0,0 +1,160 @@ +--- +title: addons +description: Here you find API methods from Add-ons +icon: material/api +#status: updated +lang: de +--- + +# addons + +Hier werden bekannte Methoden zu Add-ons aufgelistet. + +## analysis + +### analysis.dataquality.read + +#### Request parameters + +| Key | JSON data typ | Required | Description | +| ------------- | ------------- | -------- | ---------------------------------- | +| **profileId** | Integer | Yes | Profile identifier, for example: 1 | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "analysis.dataquality.read", + "params": { + "profileId": 1, + "apikey": "h3md6u3y", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "objects": [], + "averagePercent": 0 + } + } + ``` + +## Documents + +### document.documents.read + +#### Request parameters + +| Key | JSON data typ | Required | Description | +| --------- | ------------- | ------------ | ----------------------------------- | +| **docID** | Integer | Yes or objID | Document identifier, for example: 1 | +| **objID** | Integer | Yes or docID | Object identifier, for example: 1 | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "document.documents.read", + "params": { + "apikey": "h3md6u3y", + "language": "en", + "docID": 1337 + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + + } + } + ``` + +### document.documents.delete + +| Key | JSON data typ | Required | Description | +| ---------- | ------------- | -------- | ----------------------------------- | +| **delete** | Integer | Yes | Document identifier, for example: 1 | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "document.documents.read", + "params": { + "apikey": "h3md6u3y", + "language": "en", + "docID": 1337 + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "message": "Document successfully deleted.", + "success": true + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.categories.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.categories.md new file mode 100644 index 00000000..3d978939 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.categories.md @@ -0,0 +1,134 @@ +--- +title: cmdb.categories +description: cmdb.categories +icon: material/api +#status: updated +lang: de +--- + +# Namespace cmdb.categories + +!!! example "Work in Progress" + +## cmdb.categories.read + +Retrieve multiple categories by one request.
+Before you start, you should use [cmdb.object_type_categories](cmdb.object_type_categories.md#cmdbobject_type_categories) to get available categories and the cats/catg id. + +### 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](cmdb.object_type_categories.md#cmdbobject_type_categories) | +| **catsID** | Integer | No | catsid of a category, can be retrieved via [cmdb.object_type_categories](cmdb.object_type_categories.md#cmdbobject_type_categories) | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.categories.read", + "params": { + "objID": 62, + "catgID": 1, + "catsID": 48, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "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": "" + } + } + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.category.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.category.md new file mode 100644 index 00000000..69eb07f7 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.category.md @@ -0,0 +1,560 @@ +--- +title: Namespace cmdb.category +description: Read, create or update one or more category entries for an object. +icon: material/api +#status: updated +lang: de +--- + +# Namespace cmdb.category + +Zum lesen oder editieren einer Kategorie. + +## cmdb.category.create + +!!! warning "This method is deprecated and will be removed in a feature release. Use [cmdb.category.save](#cmdbcategorysave) instead." + +Create a new [category](../../../../grundlagen/kategorien-und-attribute.md) entry + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------------ | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- | +| **objID** | Integer | Yes | Object identifier, for example: **42** | +| **category** | String | Yes | Category constant, for example: **C__CATG__MODEL** | +| **data** | Object | Yes | Attributes with their values, for example:
```{ "manufacturer": "Name of manufacturer", "title": "Name of model" }``` | + +### Response parameters + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------------------------ | +| **id** | String | Entry identifier (as numeric string) | +| **message** | String | Some information | +| **success** | Boolean | Should always be **true** | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.create", + "params": { + "objID": 42, + "data": { + "manufacturer": "Name of manufacturer", + "title": "Name of model" + }, + "category": "C__CATG__MODEL", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "id": "123", + "message": "Category entry successfully created. [This method is deprecated and will be removed in a feature release. Use 'cmdb.category.save' instead.]", + "success": true + } + } + ``` + +## cmdb.category.read + +Read one or more [category](../../../../grundlagen/kategorien-und-attribute.md) entries for an object + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------------ | -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **objID** | Integer | Yes | Object identifier, for example: **42** | +| **category** | String | Yes | Category constant, for example: **"C__CATG__MODEL"** | +| **status** | Integer | Yes | ID of the status, for example **2** for **normal**
If the status parameter is not specified, the status must be set to **2** (normal). This corresponds to the previous behavior. | + +### Response parameters + +JSON key **result** contains an array of JSON objects. Each object contains **all available attributes** for the requested category. + +!!! note "" + Even if it is a [single-value category](../../../../grundlagen/kategorien-und-attribute.md) or a [multi-value category](../../../../grundlagen/kategorien-und-attribute.md) with only 1 entry, the JSON key **result** contains always an array of JSON objects. + +| Key | JSON data type | Description | +| --------- | -------------- | --------------------------------------------------------------- | +| **id** | String | Entry identifier (as numeric string) | +| **objID** | String | Object identifier (as numeric string) | +| … | Mixed | Optional attributes with values depending on requested category | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.read", + "params": { + "objID": 1000, + "category": "C__CATG__MODEL", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "id": "74", + "objID": "1000", + "manufacturer": { + "id": "19", + "title": "Lenovo", + "const": null, + "title_lang": "Lenovo" + }, + "title": { + "id": "38", + "title": "ThinkPad R61", + "const": null, + "title_lang": "ThinkPad R61" + }, + "productid": "", + "service_tag": "WRT231", + "serial": "123000999888", + "firmware": "", + "description": "" + } + ] + } + ``` + +## cmdb.category.update + +!!! warning "This method is deprecated and will be removed in a feature release. Use [cmdb.category.save](#cmdbcategorysave) instead." + +### Request parameters + +| Key | JSON data type | Required | Description | +| -------------------- | -------------- | -------- | ----------------------------------------------------------- | +| **objID** | Integer | Yes | Object identifier, for example: **42** | +| **category** | String | Yes | Category constants, for example: **"C__CATG__MODEL"** | +| **data** | Object | Yes | Attributes which will be updated | +| **data.category_id** | Integer | No | Entry identifier (only required for multi-value categories) | + +### Response parameters + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------------------------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Should be **"Category entry successfuly saved"** | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.update", + "params": { + "objID": 42, + "category": "C__CATG__MODEL", + "data": { + "serial": "123abc" + }, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Category entry successfuly saved. [This method is deprecated and will be removed in a feature release. Use 'cmdb.category.save' instead.]" + } + } + ``` + +## cmdb.category.delete + +Archive a category entry for an object, mark it as deleted or purge it from database. See also [Dokumentationszyklus](../../../../grundlagen/lebens-und-dokumentationszyklus.md) + +**Limitations:** + +- This only works with ==multi-value categories== at the moment. +- You can only ==archive== category entries which have a normal status. +- You can only ==mark== category entries ==as deleted== which are archived. +- You can only ==purge== category entries from the database which are marked as deleted. + +### Request parameters + +| Key | JSON data type | Required | Description | +| -------------------- | -------------- | -------- | ------------------------------------------------- | +| **objID** | Integer | Yes | Object identifier, for example: **42** | +| **category** | String | Yes | Category constant, for example: **"C__CATG__IP"** | +| **cateID** or **id** | Integer | Yes | Entry identifier, for example: **3** | + +### Response + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Delete Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.delete", + "params": { + "objID": 42, + "category": "C__CATG__IP", + "cateID": 3, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Category entry '3' successfuly deleted" + } + } + ``` + +## cmdb.category.save + +Create or Update a category entry of an object.
+It works for multi-value categories and single-value category. + +### Request parameters + +| **Key** | **JSON data type** | **Required** | **Description** | +| ------------ | ------------------ | ------------ | ---------------------------------------------------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **456** | +| **category** | String | Yes | Category constant, for example: **"C__CATG__ACCESS"** | +| **data** | Object | Yes | ```{ "title":"Name of the access", "description": "description of the access" }``` | + +### Response body + +JSON key **result** contains a JSON object. + +| **Key** | **JSON data type** | **Description** | +| ----------- | ------------------ | ------------------------------------- | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | +| **entry** | Integer | Entry identifier, for example: **35** | + +### Example + +=== "Create Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.save", + "params": { + "object": 456, + "data": { + "title":"Name of the access", + "description":"description of the access" + }, + "category": "C__CATG__ACCESS", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Category entry successfuly saved", + "entry": 35 + } + } + ``` + +=== "or update Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.save", + "params": { + "object": 456, + "data": { + "manufacturer": "Name of manufacturer", + "title": "Name of model" + }, + "category": "C__CATG__MODEL", + "entry": 24, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +## cmdb.category.quickpurge + +If **Quickpurge** is [enabled](../../../../administration/verwaltung/mandanten-name-verwaltung/einstellungen-mandanten-name.md#cmdb), purge a category entry of an object directly from the database. + +### Request parameters + +| Key | JSON data type | Required | Description | +| -------------------- | -------------- | -------- | ------------------------------------------------- | +| **objID** | Integer | Yes | Object identifier, for example: **42** | +| **category** | String | Yes | Category constant, for example: **"C__CATG__IP"** | +| **cateID** or **id** | Integer | Yes | Entry identifier, for example: **3** | + +### Response body + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Create Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.quickpurge", + "params": { + "objID": 42, + "category": "C__CATG__IP", + "cateID": 3, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Category entry '3' successfuly purged" + } + } + ``` + +## cmdb.category.purge + +Purge a category entry of an object.It works for multi-value categories and single-value category. + +### Request parameters + +| **Key** | **JSON data type** | **Required** | **Description** | +| ------------ | ------------------ | ------------ | ----------------------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **456** | +| **category** | String | Yes | Category constant, for example: **"C__CATG__ACCESS"** | +| **entry** | Integer | Yes | Entry identifier, for example: **33** | + +### Response body + +JSON key **result** contains a JSON object. + +| **Key** | **JSON data type** | **Description** | +| ----------- | ------------------ | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.purge", + "params": { + "object": 456, + "category": "C__CATG__ACCESS", + "entry": 33, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Entry 33 has been successfuly purged from 2 to 5." + } + } + ``` + +## cmdb.category.recycle + +**Limitations:** + +- This only works with multi-value categories. +- You can recycle category entries which have archived or deleted status. + +### Request parameters + +| **Key** | **JSON data type** | **Required** | **Description** | +| ------------ | ------------------ | ------------ | ----------------------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **456** | +| **category** | String | Yes | Category constant, for example: **"C__CATG__ACCESS"** | +| **entry** | Integer | Yes | Entry identifier, for example: **32** | + +### Response body + +JSON key **result** contains a JSON object. + +| **Key** | **JSON data type** | **Description** | +| ----------- | ------------------ | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.recycle", + "params": { + "object": 456, + "category": "C__CATG__ACCESS", + "entry": 32, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Entry 32 has been successfuly recycled from 3 to 2." + } + } + ``` + +## cmdb.category.archive + +**Limitations** + +- This only works with multi-value categories at the moment. +- You can only archive category entries which have a normal status. + +### Request parameters + +| **Key** | **JSON data type** | **Required** | **Description** | +| ------------ | ------------------ | ------------ | ----------------------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **456** | +| **category** | String | Yes | Category constant, for example: **"C__CATG__ACCESS"** | +| **entry** | Integer | Yes | Entry identifier, for example: **32** | + +### Response body + +JSON key **result** contains a JSON object. + +| **Key** | **JSON data type** | **Description** | +| ----------- | ------------------ | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.category.archive", + "params": { + "object": 456, + "category": "C__CATG__ACCESS", + "entry": 32, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Entry 32 has been successfuly archived from 2 to 3." + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.category_info.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.category_info.md new file mode 100644 index 00000000..ee405c6d --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.category_info.md @@ -0,0 +1,2157 @@ +--- +title: cmdb.category_info +description: cmdb.category_info +icon: material/api +#status: updated +lang: de +--- + +# category_info + +Zeigt Informationen einer Kategorie und deren Felder an. + +## cmdb.category_info.read + +Einer der Keys muss mitgegeben werden. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------------ | -------------- | -------- | ----------- | +| **catgID** | Integer | No | Placeholder | +| **catsID** | Integer | No | Placeholder | +| **customID** | Integer | No | Placeholder | +| **category** | String | No | Placeholder | + +!!! example "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 + +=== "Request body catgID" + + ```json + { + "version": "2.0", + "method": "cmdb.category_info.read", + "params": { + "catgID": 1, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body catgID" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "id": { + "title": "ID", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "int", + "backward": false, + "title": "ID", + "description": "ID" + }, + "data": { + "type": "int", + "readonly": false, + "index": true, + "field": "isys_obj__id", + "table_alias": "isys_obj" + }, + "ui": { + "type": "text", + "params": { + "p_strPlaceholder": "0", + "default": "0" + }, + "default": null, + "id": "C__OBJ__ID" + } + }, + "title": { + "title": "Title", + "check": { + "mandatory": false + }, + "info": { + "title": "LC__UNIVERSAL__TITLE", + "type": "text", + "primaryField": false, + "backwardCompatible": false + }, + "data": { + "type": "text", + "field": "isys_obj__title", + "sourceTable": "isys_obj", + "readOnly": false, + "index": true, + "select": {} + }, + "ui": { + "id": "C__CATG__GLOBAL_TITLE", + "type": "text", + "params": { + "p_nMaxLen": 255 + } + }, + "format": [] + }, + "status": { + "title": "Condition", + "check": { + "mandatory": null + }, + "info": { + "title": "LC__UNIVERSAL__CONDITION", + "type": "dialog", + "primaryField": false, + "backwardCompatible": false + }, + "data": { + "type": "int", + "field": "isys_obj__status", + "sourceTable": "isys_obj", + "readOnly": true, + "index": true, + "select": {} + }, + "ui": { + "id": "C__OBJ__STATUS", + "type": "dialog", + "default": "-1", + "params": { + "p_arData": {}, + "p_bDbFieldNN": false, + "chosen": false + } + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog" + ] + } + }, + "created": { + "title": "Creation date", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "datetime", + "backward": false, + "title": "LC__TASK__DETAIL__WORKORDER__CREATION_DATE", + "description": "Created" + }, + "data": { + "type": "date_time", + "readonly": true, + "index": false, + "field": "isys_obj__created", + "table_alias": "isys_obj", + "select": {}, + "sort_alias": "obj_main.isys_obj__created" + }, + "ui": { + "type": "datetime", + "params": { + "p_strPopupType": "calendar", + "p_bTime": 1, + "p_bReadonly": true, + "default": "n/a" + }, + "default": null, + "id": "C__CATG__GLOBAL_CREATED" + }, + "format": { + "callback": [ + "isys_export_helper", + "datetime" + ] + } + }, + "created_by": { + "title": "Created by", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__UNIVERSAL__CREATED_BY", + "description": "Created by" + }, + "data": { + "type": "text", + "readonly": true, + "index": false, + "field": "isys_obj__created_by", + "table_alias": "isys_obj" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255 + }, + "id": "C__CATG__GLOBAL_CREATED_BY" + } + }, + "changed": { + "title": "Last change", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "datetime", + "backward": false, + "title": "LC__CMDB__LAST_CHANGE", + "description": "Changed" + }, + "data": { + "type": "date_time", + "readonly": true, + "index": true, + "sort_alias": "isys_obj__updated", + "field": "isys_obj__updated", + "table_alias": "isys_obj", + "select": {} + }, + "ui": { + "type": "datetime", + "params": { + "p_strPopupType": "calendar", + "p_bTime": 1, + "p_bReadonly": true, + "default": "n/a" + }, + "default": null, + "id": "C__CATG__GLOBAL_UPDATED" + }, + "format": { + "callback": [ + "isys_export_helper", + "datetime" + ] + } + }, + "changed_by": { + "title": "Last change by", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__CMDB__LAST_CHANGE_BY", + "description": "Changed" + }, + "data": { + "type": "text", + "readonly": true, + "index": false, + "sort_alias": "isys_obj__updated_by", + "field": "isys_obj__updated_by", + "table_alias": "isys_obj" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255 + }, + "id": "C__CATG__GLOBAL_UPDATED_BY" + } + }, + "purpose": { + "title": "Purpose", + "check": { + "mandatory": null + }, + "info": { + "primary_field": false, + "type": "dialog_plus", + "backward": false, + "title": "LC__CMDB__CATG__GLOBAL_PURPOSE", + "description": "Purpose" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_global_list__isys_purpose__id", + "source_table": "isys_purpose", + "references": [ + "isys_purpose", + "isys_purpose__id" + ], + "select": {}, + "join": [ + {}, + {} + ] + }, + "ui": { + "type": "popup", + "params": { + "p_strPopupType": "dialog_plus", + "p_strTable": "isys_purpose" + }, + "default": "-1", + "id": "C__CATG__GLOBAL_PURPOSE" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog_plus" + ] + } + }, + "category": { + "title": "Category", + "check": { + "mandatory": null + }, + "info": { + "primary_field": false, + "type": "dialog_plus", + "backward": false, + "title": "LC__CMDB__CATG__GLOBAL_CATEGORY", + "description": "Category" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_global_list__isys_catg_global_category__id", + "source_table": "isys_catg_global_category", + "references": [ + "isys_catg_global_category", + "isys_catg_global_category__id" + ], + "select": {}, + "join": [ + {}, + {} + ] + }, + "ui": { + "type": "popup", + "params": { + "p_strPopupType": "dialog_plus", + "p_strTable": "isys_catg_global_category" + }, + "default": "-1", + "id": "C__CATG__GLOBAL_CATEGORY" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog_plus" + ] + } + }, + "sysid": { + "title": "SYSID", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__CMDB__CATG__GLOBAL_SYSID", + "description": "SYSID" + }, + "data": { + "type": "text", + "readonly": false, + "index": true, + "field": "isys_obj__sysid", + "table_alias": "isys_obj" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255, + "p_bDisabled": "1" + }, + "id": "C__CATG__GLOBAL_SYSID" + } + }, + "cmdb_status": { + "title": "CMDB status", + "check": { + "mandatory": null + }, + "info": { + "primary_field": false, + "type": "dialog", + "backward": false, + "title": "LC__UNIVERSAL__CMDB_STATUS", + "description": "CMDB status" + }, + "data": { + "type": "int", + "readonly": true, + "index": false, + "field": "isys_obj__isys_cmdb_status__id", + "source_table": "isys_cmdb_status", + "references": [ + "isys_cmdb_status", + "isys_cmdb_status__id" + ], + "select": {} + }, + "ui": { + "type": "dialog", + "params": { + "p_strTable": "isys_cmdb_status", + "condition": "isys_cmdb_status__id NOT IN (13, 14)", + "default": "n/a", + "p_bDbFieldNN": 1 + }, + "default": "-1", + "id": "C__OBJ__CMDB_STATUS" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog" + ] + } + }, + "type": { + "title": "Object type", + "check": { + "mandatory": null + }, + "info": { + "primary_field": false, + "type": "dialog", + "backward": false, + "title": "LC__REPORT__FORM__OBJECT_TYPE", + "description": "Object-Type" + }, + "data": { + "type": "int", + "readonly": true, + "index": true, + "field": "isys_obj__isys_obj_type__id", + "references": [ + "isys_obj_type", + "isys_obj_type__id" + ], + "select": {} + }, + "ui": { + "type": "dialog", + "params": { + "p_strTable": "", + "p_arData": {}, + "default": "n/a", + "p_bDbFieldNN": 1 + }, + "default": "-1", + "id": "C__OBJ__TYPE" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog" + ] + } + }, + "tag": { + "title": "Tags", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "multiselect", + "backward": false, + "title": "LC__CMDB__CATG__GLOBAL_TAG", + "description": "Tag" + }, + "data": { + "type": "int", + "readonly": false, + "index": true, + "field": "isys_obj__id", + "table_alias": "global_tag", + "source_table": "isys_tag", + "references": [ + "isys_tag_2_isys_obj", + "isys_obj__id" + ], + "select": {} + }, + "ui": { + "type": "popup", + "params": { + "type": "f_popup", + "p_strPopupType": "dialog_plus", + "multiselect": true, + "p_strTable": "isys_tag", + "emptyMessage": "LC__CMDB__CATG__GLOBAL__NO_TAGS_FOUND", + "p_onComplete": "idoit.callbackManager.triggerCallback('cmdb-catg-global-tag-update', selected);" + }, + "default": null, + "id": "C__CATG__GLOBAL_TAG" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog_multiselect" + ] + } + }, + "description": { + "title": "Description", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "commentary", + "backward": false, + "title": "LC__CMDB__LOGBOOK__DESCRIPTION", + "description": "Description" + }, + "data": { + "type": "text_area", + "readonly": false, + "index": false, + "field": "isys_obj__description", + "table_alias": "isys_obj" + }, + "ui": { + "type": "textarea", + "default": null, + "id": "C__CMDB__CAT__COMMENTARY_01" + } + } + } + } + ``` + +=== "Request body catsID" + + ```json + { + "version": "2.0", + "method": "cmdb.category_info.read", + "params": { + "catsID": 53, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body catsID" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "title": { + "title": "Title", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__CONTACT__GROUP_TITLE", + "description": "Title" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_cats_person_group_list__title" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255 + }, + "id": "C__CONTACT__GROUP_TITLE" + } + }, + "email_address": { + "title": "E-Mail", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__CONTACT__GROUP_EMAIL_ADDRESS", + "description": "EMail" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_mail_addresses_list__title", + "select": {}, + "join": [ + {} + ] + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255 + }, + "id": "C__CONTACT__GROUP_EMAIL_ADDRESS" + } + }, + "phone": { + "title": "Phone", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__CONTACT__GROUP_PHONE", + "description": "Phone" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_cats_person_group_list__phone" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255 + }, + "id": "C__CONTACT__GROUP_PHONE" + } + }, + "ldap_group": { + "title": "LDAP-Group (Mapping)", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__CMDB__CATS__PERSON_GROUPS__LDAP_MAPPING", + "description": "LDAP Group" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_cats_person_group_list__ldap_group" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255 + }, + "id": "C__CONTACT__GROUP_LDAP" + } + }, + "description": { + "title": "Description", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "commentary", + "backward": false, + "title": "LC__CMDB__LOGBOOK__DESCRIPTION", + "description": "Description" + }, + "data": { + "type": "text_area", + "readonly": false, + "index": false, + "field": "isys_cats_person_group_list__description" + }, + "ui": { + "type": "textarea", + "default": null, + "id": "C__CMDB__CAT__COMMENTARY_153" + } + } + } + } + ``` + +=== "Request body custimID" + + ```json + { + "version": "2.0", + "method": "cmdb.category_info.read", + "params": { + "customID": 1, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body customID" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "f_popup_c_16920981543572760": { + "title": "Checkbox", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "multiselect", + "backward": false, + "title": "Checkbox", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920981543572760", + "source_table": "isys_catg_custom_fields_list", + "references": [ + "isys_dialog_plus_custom", + "isys_dialog_plus_custom__id" + ], + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "checkboxes", + "title": "Checkbox", + "identifier": "Addition", + "multiselection": 1, + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_strTable": "isys_dialog_plus_custom", + "condition": "isys_dialog_plus_custom__identifier = 'Addition'", + "p_arData": {}, + "p_strPopupType": "dialog_plus", + "p_identifier": "Addition", + "multiselect": true + }, + "id": "c_16920981543572760" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldDialogPlus" + ] + } + }, + "f_popup_c_16920981545077660": { + "title": "Date and Time", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "datetime", + "backward": false, + "title": "Date and Time", + "description": "f_popup" + }, + "data": { + "type": "date_time", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920981545077660", + "select": {} + }, + "ui": { + "type": "datetime", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "calendar", + "extra": "date-datetime", + "title": "Date and Time", + "default": "1", + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_bTime": true, + "p_strStyle": "width:70%;" + }, + "id": "c_16920981545077660" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldCalendarWithTime" + ] + } + }, + "f_popup_c_16920981546684770": { + "title": "Dialog +", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "dialog_plus", + "backward": false, + "title": "Dialog +", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920981546684770", + "source_table": "isys_catg_custom_fields_list", + "references": [ + "isys_dialog_plus_custom", + "isys_dialog_plus_custom__id" + ], + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "dialog_plus", + "title": "Dialog +", + "identifier": "Addition", + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_strTable": "isys_dialog_plus_custom", + "condition": "isys_dialog_plus_custom__identifier = 'Addition'", + "p_arData": {}, + "p_strPopupType": "dialog_plus", + "p_identifier": "Addition" + }, + "id": "c_16920981546684770" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldDialogPlus" + ] + } + }, + "f_popup_c_16920981548156320": { + "title": "Dialog +Multiple selection)", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "multiselect", + "backward": false, + "title": "Dialog +Multiple selection)", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920981548156320", + "source_table": "isys_catg_custom_fields_list", + "references": [ + "isys_dialog_plus_custom", + "isys_dialog_plus_custom__id" + ], + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "dialog_plus", + "title": "Dialog +Multiple selection)", + "identifier": "Addition", + "multiselection": 1, + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_strTable": "isys_dialog_plus_custom", + "condition": "isys_dialog_plus_custom__identifier = 'Addition'", + "p_arData": {}, + "p_strPopupType": "dialog_plus", + "p_identifier": "Addition", + "multiselect": true + }, + "id": "c_16920981548156320" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldDialogPlus" + ] + } + }, + "f_popup_c_16920981549657730": { + "title": "File browser", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "object_browser", + "backward": false, + "title": "File browser", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920981549657730", + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "file", + "title": "File browser", + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_strPopupType": "browser_object_ng", + "multiselection": false + }, + "id": "c_16920981549657730" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldObject" + ] + } + }, + "html_c_16920981551089650": { + "title": "HTML", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "HTML", + "description": "html" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "html_c_16920981551089650", + "select": {} + }, + "ui": { + "type": "html", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "html", + "title": "HTML", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920981551089650" + } + }, + "f_wysiwyg_c_16920981552569820": { + "title": "HTML-Editor", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "textarea", + "backward": false, + "title": "HTML-Editor", + "description": "f_wysiwyg" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_wysiwyg_c_16920981552569820", + "select": {} + }, + "ui": { + "type": "wysiwyg", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_wysiwyg", + "title": "HTML-Editor", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920981552569820" + } + }, + "hr_c_16920982533611700": { + "title": "Horizontal line", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "Horizontal line", + "description": "hr" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "hr_c_16920982533611700", + "select": {} + }, + "ui": { + "type": "hr", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "hr", + "title": "Horizontal line", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920982533611700" + } + }, + "script_c_16920982535068230": { + "title": "Javascript", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "Javascript", + "description": "script" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "script_c_16920982535068230", + "select": {} + }, + "ui": { + "type": "script", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "script", + "title": "Javascript", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920982535068230" + } + }, + "f_link_c_16920982536598820": { + "title": "Link", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "Link", + "description": "f_link" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_link_c_16920982536598820", + "select": {} + }, + "ui": { + "type": "link", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_link", + "title": "Link", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920982536598820" + } + }, + "f_numeric_c_16920982538135930": { + "title": "Number only", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "Number only", + "description": "f_numeric" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_numeric_c_16920982538135930", + "select": {} + }, + "ui": { + "type": "numeric", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_numeric", + "title": "Number only", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920982538135930" + } + }, + "f_popup_c_16920982539453190": { + "title": "Object-Browser (Several objects)", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "object_browser", + "backward": false, + "title": "Object-Browser (Several objects)", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920982539453190", + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "browser_object", + "title": "Object-Browser (Several objects)", + "multiselection": true, + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_strPopupType": "browser_object_ng" + }, + "id": "c_16920982539453190" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldObject" + ] + } + }, + "f_popup_c_16920982540799680": { + "title": "Object-Relation (Several objects)", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "object_browser", + "backward": false, + "title": "Object-Relation (Several objects)", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920982540799680", + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "browser_object", + "title": "Object-Relation (Several objects)", + "identifier": "38", + "multiselection": true, + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_strPopupType": "browser_object_ng", + "p_identifier": "38" + }, + "id": "c_16920982540799680" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldObject" + ] + } + }, + "f_popup_c_16920982542208730": { + "title": "Object browser (One object)", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "object_browser", + "backward": false, + "title": "Object browser (One object)", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920982542208730", + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "browser_object", + "title": "Object browser (One object)", + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_strPopupType": "browser_object_ng", + "multiselection": false + }, + "id": "c_16920982542208730" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldObject" + ] + } + }, + "f_popup_c_16920982543638450": { + "title": "Object relationship (One object)", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "object_browser", + "backward": false, + "title": "Object relationship (One object)", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920982543638450", + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "browser_object", + "title": "Object relationship (One object)", + "identifier": "38", + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_strPopupType": "browser_object_ng", + "multiselection": false, + "p_identifier": "38" + }, + "id": "c_16920982543638450" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldObject" + ] + } + }, + "f_popup_c_16920983590869540": { + "title": "Report", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "Report", + "description": "f_popup" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_popup_c_16920983590869540", + "select": {} + }, + "ui": { + "type": "popup", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_popup", + "popup": "report_browser", + "title": "Report", + "identifier": "1", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920983590869540" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomReport" + ] + } + }, + "f_text_c_1692098359236280": { + "title": "Textfield", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "Textfield", + "description": "f_text" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_text_c_1692098359236280", + "select": {} + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_text", + "title": "Textfield", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_1692098359236280" + } + }, + "f_password_c_16920983593948440": { + "title": "Textfield (masked)", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "Textfield (masked)", + "description": "f_password" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_password_c_16920983593948440", + "select": {} + }, + "ui": { + "type": "password", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_password", + "title": "Textfield (masked)", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920983593948440" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldPassword" + ] + } + }, + "f_textarea_c_16920983595455790": { + "title": "Textfield (multiple rows)", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "textarea", + "backward": false, + "title": "Textfield (multiple rows)", + "description": "f_textarea" + }, + "data": { + "type": "text_area", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_textarea_c_16920983595455790", + "select": {} + }, + "ui": { + "type": "textarea", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_textarea", + "title": "Textfield (multiple rows)", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920983595455790" + } + }, + "f_time_c_16920983597011990": { + "title": "Time", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "time", + "backward": false, + "title": "Time", + "description": "f_time" + }, + "data": { + "type": "time", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_time_c_16920983597011990", + "select": {} + }, + "ui": { + "type": "time", + "default": null, + "params": { + "p_nMaxLen": 255, + "type": "f_time", + "title": "Time", + "visibility": "visible", + "show_in_list": false, + "show_inline": false + }, + "id": "c_16920983597011990" + } + }, + "f_dialog_c_16920983598535500": { + "title": "Yes-no-field", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "dialog", + "backward": false, + "title": "Yes-no-field", + "description": "f_dialog" + }, + "data": { + "type": "text", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "f_dialog_c_16920983598535500", + "select": {} + }, + "ui": { + "type": "dialog", + "default": "LC__UNIVERSAL__NO", + "params": { + "p_nMaxLen": 255, + "type": "f_dialog", + "extra": "yes-no", + "title": "Yes-no-field", + "default": "0", + "visibility": "visible", + "show_in_list": false, + "show_inline": false, + "p_arData": { + "LC__UNIVERSAL__YES": "Yes", + "LC__UNIVERSAL__NO": "No" + } + }, + "id": "c_16920983598535500" + }, + "format": { + "callback": [ + "isys_global_custom_fields_export_helper", + "exportCustomFieldYesNoDialog" + ] + } + }, + "description": { + "title": "Description", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "commentary", + "backward": false, + "title": "LC__CMDB__LOGBOOK__DESCRIPTION", + "description": "Description" + }, + "data": { + "type": "text_area", + "readonly": false, + "index": false, + "field": "isys_catg_custom_fields_list__field_content", + "field_alias": "C__CMDB__CAT__COMMENTARY_41", + "select": {} + }, + "ui": { + "type": "textarea", + "default": null, + "id": "C__CMDB__CAT__COMMENTARY_41" + } + } + } + } + ``` + +=== "Request body category" + + ```json + { + "version": "2.0", + "method": "cmdb.category_info.read", + "params": { + "category": "C__CATG__GLOBAL", + "apikey": "{{apikey}}", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body category" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "id": { + "title": "ID", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "int", + "backward": false, + "title": "ID", + "description": "ID" + }, + "data": { + "type": "int", + "readonly": false, + "index": true, + "field": "isys_obj__id", + "table_alias": "isys_obj" + }, + "ui": { + "type": "text", + "params": { + "p_strPlaceholder": "0", + "default": "0" + }, + "default": null, + "id": "C__OBJ__ID" + } + }, + "title": { + "title": "Title", + "check": { + "mandatory": false + }, + "info": { + "title": "LC__UNIVERSAL__TITLE", + "type": "text", + "primaryField": false, + "backwardCompatible": false + }, + "data": { + "type": "text", + "field": "isys_obj__title", + "sourceTable": "isys_obj", + "readOnly": false, + "index": true, + "select": {} + }, + "ui": { + "id": "C__CATG__GLOBAL_TITLE", + "type": "text", + "params": { + "p_nMaxLen": 255 + } + }, + "format": [] + }, + "status": { + "title": "Condition", + "check": { + "mandatory": null + }, + "info": { + "title": "LC__UNIVERSAL__CONDITION", + "type": "dialog", + "primaryField": false, + "backwardCompatible": false + }, + "data": { + "type": "int", + "field": "isys_obj__status", + "sourceTable": "isys_obj", + "readOnly": true, + "index": true, + "select": {} + }, + "ui": { + "id": "C__OBJ__STATUS", + "type": "dialog", + "default": "-1", + "params": { + "p_arData": {}, + "p_bDbFieldNN": false, + "chosen": false + } + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog" + ] + } + }, + "created": { + "title": "Creation date", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "datetime", + "backward": false, + "title": "LC__TASK__DETAIL__WORKORDER__CREATION_DATE", + "description": "Created" + }, + "data": { + "type": "date_time", + "readonly": true, + "index": false, + "field": "isys_obj__created", + "table_alias": "isys_obj", + "select": {}, + "sort_alias": "obj_main.isys_obj__created" + }, + "ui": { + "type": "datetime", + "params": { + "p_strPopupType": "calendar", + "p_bTime": 1, + "p_bReadonly": true, + "default": "n/a" + }, + "default": null, + "id": "C__CATG__GLOBAL_CREATED" + }, + "format": { + "callback": [ + "isys_export_helper", + "datetime" + ] + } + }, + "created_by": { + "title": "Created by", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__UNIVERSAL__CREATED_BY", + "description": "Created by" + }, + "data": { + "type": "text", + "readonly": true, + "index": false, + "field": "isys_obj__created_by", + "table_alias": "isys_obj" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255 + }, + "id": "C__CATG__GLOBAL_CREATED_BY" + } + }, + "changed": { + "title": "Last change", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "datetime", + "backward": false, + "title": "LC__CMDB__LAST_CHANGE", + "description": "Changed" + }, + "data": { + "type": "date_time", + "readonly": true, + "index": true, + "sort_alias": "isys_obj__updated", + "field": "isys_obj__updated", + "table_alias": "isys_obj", + "select": {} + }, + "ui": { + "type": "datetime", + "params": { + "p_strPopupType": "calendar", + "p_bTime": 1, + "p_bReadonly": true, + "default": "n/a" + }, + "default": null, + "id": "C__CATG__GLOBAL_UPDATED" + }, + "format": { + "callback": [ + "isys_export_helper", + "datetime" + ] + } + }, + "changed_by": { + "title": "Last change by", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__CMDB__LAST_CHANGE_BY", + "description": "Changed" + }, + "data": { + "type": "text", + "readonly": true, + "index": false, + "sort_alias": "isys_obj__updated_by", + "field": "isys_obj__updated_by", + "table_alias": "isys_obj" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255 + }, + "id": "C__CATG__GLOBAL_UPDATED_BY" + } + }, + "purpose": { + "title": "Purpose", + "check": { + "mandatory": null + }, + "info": { + "primary_field": false, + "type": "dialog_plus", + "backward": false, + "title": "LC__CMDB__CATG__GLOBAL_PURPOSE", + "description": "Purpose" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_global_list__isys_purpose__id", + "source_table": "isys_purpose", + "references": [ + "isys_purpose", + "isys_purpose__id" + ], + "select": {}, + "join": [ + {}, + {} + ] + }, + "ui": { + "type": "popup", + "params": { + "p_strPopupType": "dialog_plus", + "p_strTable": "isys_purpose" + }, + "default": "-1", + "id": "C__CATG__GLOBAL_PURPOSE" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog_plus" + ] + } + }, + "category": { + "title": "Category", + "check": { + "mandatory": null + }, + "info": { + "primary_field": false, + "type": "dialog_plus", + "backward": false, + "title": "LC__CMDB__CATG__GLOBAL_CATEGORY", + "description": "Category" + }, + "data": { + "type": "int", + "readonly": false, + "index": false, + "field": "isys_catg_global_list__isys_catg_global_category__id", + "source_table": "isys_catg_global_category", + "references": [ + "isys_catg_global_category", + "isys_catg_global_category__id" + ], + "select": {}, + "join": [ + {}, + {} + ] + }, + "ui": { + "type": "popup", + "params": { + "p_strPopupType": "dialog_plus", + "p_strTable": "isys_catg_global_category" + }, + "default": "-1", + "id": "C__CATG__GLOBAL_CATEGORY" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog_plus" + ] + } + }, + "sysid": { + "title": "SYSID", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "text", + "backward": false, + "title": "LC__CMDB__CATG__GLOBAL_SYSID", + "description": "SYSID" + }, + "data": { + "type": "text", + "readonly": false, + "index": true, + "field": "isys_obj__sysid", + "table_alias": "isys_obj" + }, + "ui": { + "type": "text", + "default": null, + "params": { + "p_nMaxLen": 255, + "p_bDisabled": "1" + }, + "id": "C__CATG__GLOBAL_SYSID" + } + }, + "cmdb_status": { + "title": "CMDB status", + "check": { + "mandatory": null + }, + "info": { + "primary_field": false, + "type": "dialog", + "backward": false, + "title": "LC__UNIVERSAL__CMDB_STATUS", + "description": "CMDB status" + }, + "data": { + "type": "int", + "readonly": true, + "index": false, + "field": "isys_obj__isys_cmdb_status__id", + "source_table": "isys_cmdb_status", + "references": [ + "isys_cmdb_status", + "isys_cmdb_status__id" + ], + "select": {} + }, + "ui": { + "type": "dialog", + "params": { + "p_strTable": "isys_cmdb_status", + "condition": "isys_cmdb_status__id NOT IN (13, 14)", + "default": "n/a", + "p_bDbFieldNN": 1 + }, + "default": "-1", + "id": "C__OBJ__CMDB_STATUS" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog" + ] + } + }, + "type": { + "title": "Object type", + "check": { + "mandatory": null + }, + "info": { + "primary_field": false, + "type": "dialog", + "backward": false, + "title": "LC__REPORT__FORM__OBJECT_TYPE", + "description": "Object-Type" + }, + "data": { + "type": "int", + "readonly": true, + "index": true, + "field": "isys_obj__isys_obj_type__id", + "references": [ + "isys_obj_type", + "isys_obj_type__id" + ], + "select": {} + }, + "ui": { + "type": "dialog", + "params": { + "p_strTable": "", + "p_arData": {}, + "default": "n/a", + "p_bDbFieldNN": 1 + }, + "default": "-1", + "id": "C__OBJ__TYPE" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog" + ] + } + }, + "tag": { + "title": "Tags", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "multiselect", + "backward": false, + "title": "LC__CMDB__CATG__GLOBAL_TAG", + "description": "Tag" + }, + "data": { + "type": "int", + "readonly": false, + "index": true, + "field": "isys_obj__id", + "table_alias": "global_tag", + "source_table": "isys_tag", + "references": [ + "isys_tag_2_isys_obj", + "isys_obj__id" + ], + "select": {} + }, + "ui": { + "type": "popup", + "params": { + "type": "f_popup", + "p_strPopupType": "dialog_plus", + "multiselect": true, + "p_strTable": "isys_tag", + "emptyMessage": "LC__CMDB__CATG__GLOBAL__NO_TAGS_FOUND", + "p_onComplete": "idoit.callbackManager.triggerCallback('cmdb-catg-global-tag-update', selected);" + }, + "default": null, + "id": "C__CATG__GLOBAL_TAG" + }, + "format": { + "callback": [ + "isys_export_helper", + "dialog_multiselect" + ] + } + }, + "description": { + "title": "Description", + "check": { + "mandatory": false + }, + "info": { + "primary_field": false, + "type": "commentary", + "backward": false, + "title": "LC__CMDB__LOGBOOK__DESCRIPTION", + "description": "Description" + }, + "data": { + "type": "text_area", + "readonly": false, + "index": false, + "field": "isys_obj__description", + "table_alias": "isys_obj" + }, + "ui": { + "type": "textarea", + "default": null, + "id": "C__CMDB__CAT__COMMENTARY_01" + } + } + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.condition.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.condition.md new file mode 100644 index 00000000..0c50eba7 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.condition.md @@ -0,0 +1,121 @@ +--- +title: cmdb.condition +description: cmdb.condition +icon: material/api +#status: updated +lang: de +--- + +# cmdb.condition + +!!! example "Work in Progress. **Alpha state**" + +## cmdb.condition.read + +Give me all objects that have attribute Y = Z in category X. Like a report. + +### Request parameters + +| Key | JSON data type | Required | Description | +| --------------------------------------------------------- | -------------- | ----------------- | --------------------------------------------------------- | +| **conditions** | Array | Yes | Consists of the category constant + the attribute name | +| **property** | String | Yes | `=`, `!=`, `like`, `not like`, `>`, `>=`, `<`, `<=`, `<>` | +| **comparison** | String | String or Integer | Exmaple, `C__OBJTYPE__SERVER`, `123` or `*server*` | +| **operator** :material-flask:{ title="Work in progress" } | Array | Yes | `AND` or `OR` | + +!!! example "WIP" + + ### Response parameters + + JSON key **result** contains an array of JSON objects. Each object contains a search result. + + | Key | JSON data type | Description | + | --------- | -------------- | -------------------------------- | + | **key** | String | Attribute which relates to query | + | **value** | String | Value which relates to query | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.condition.read", + "params": { + "conditions": [ + { + "property": "C__CATG__GLOBAL-type", + "comparison": "=", + "value": "C__OBJTYPE__CLIENT" + }, + { + "property": "C__CATG__ACCOUNTING-inventory_no", + "comparison": "like", + "value": "*" + }, + { + "property": "C__CATG__GLOBAL-title", + "comparison": "like", + "value": "*serv*" + } + ], + "apikey": "h3md6u3y", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "id": "26", + "title": "Client01", + "sysid": "SYSID_1651224253", + "type": "10", + "created": "2022-04-29 11:23:47", + "updated": "2022-04-29 11:24:53", + "type_title": "Client", + "type_icon": "images/icons/silk/computer.png", + "type_group_title": null, + "status": "2", + "cmdb_status": "6", + "cmdb_status_title": "in operation" + }, + { + "id": "27", + "title": "Client", + "sysid": "SYSID_1651224275", + "type": "10", + "created": "2022-04-29 11:24:08", + "updated": "2022-04-29 11:24:13", + "type_title": "Client", + "type_icon": "images/icons/silk/computer.png", + "type_group_title": null, + "status": "2", + "cmdb_status": "6", + "cmdb_status_title": "in operation" + }, + { + "id": "28", + "title": "MyClient", + "sysid": "SYSID_1651224285", + "type": "10", + "created": "2022-04-29 11:24:17", + "updated": "2022-04-29 11:24:25", + "type_title": "Client", + "type_icon": "images/icons/silk/computer.png", + "type_group_title": null, + "status": "2", + "cmdb_status": "6", + "cmdb_status_title": "in operation" + } + ] + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.contact.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.contact.md new file mode 100644 index 00000000..ec0d2e24 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.contact.md @@ -0,0 +1,71 @@ +--- +title: cmdb.contact +description: cmdb.contact +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.contact.read + +Retrieves all assigned objects by contact. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ---------- | -------------- | -------------------------------------------- | --------------------------------- | +| **method** | String | only "assigned_objects_by_contact" available | | +| **filter** | Object | Yes | By `email` String or `id` Integer | + +!!! example "WIP" + + ### Response parameters + + JSON key **result** contains an array of JSON objects. Each object contains a search result. + + | Key | JSON data type | Description | + | --------- | -------------- | -------------------------------- | + | **key** | String | Attribute which relates to query | + | **value** | String | Value which relates to query | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.contact.read", + "params": { + "method": "assigned_objects_by_contact", + "filter": { + "id": 9 + }, + "apikey": "h3md6u3y", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "1122742661": { + "id": "55", + "title": "CareBear Power Server", + "sysid": "SYSID_2807233812", + "type": "5", + "type_title": "Server", + "primary": "No", + "role": "Administrator" + } + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.dialog.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.dialog.md new file mode 100644 index 00000000..2a5a6d2b --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.dialog.md @@ -0,0 +1,231 @@ +--- +title: cmdb.dialog +description: cmdb.dialog +icon: material/api +#status: updated +lang: de +--- + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.dialog.read", + "params": { + "category": "C__CATG__CPU", + "property": "manufacturer", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.dialog.create", + "params": { + "category": "C__CATG__CPU", + "property": "manufacturer", + "value": "IBM", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "entry_id": 3 + } + } + ``` + +## cmdb.dialog.update + +Update a [dialog](../../../../grundlagen/dialog-admin.md) 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 + +=== "Request body" + + ```json + { + "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 + } + ``` + +=== "Response body" + + ```json + { + "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 + +=== "Request body" + + ```json + { + "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 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "entry_id": 3 + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.filter.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.filter.md new file mode 100644 index 00000000..cad62247 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.filter.md @@ -0,0 +1,54 @@ +--- +title: cmdb.filter +description: cmdb.filter +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress. **Alpha state**" + +## cmdb.filter.read + +For example, get all objects with {Attribute} and {Attribute} which where updated in a specific time frame. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------- | -------------- | -------- | ------------------------------------------ | +| **Key** | String | Yes | Query, for example: **"My little server"** | + +### Response parameters + +JSON key **result** contains an array of JSON objects. Each object contains a search result. + +| Key | JSON data type | Description | +| --------- | -------------- | -------------------------------- | +| **key** | String | Attribute which relates to query | +| **value** | String | Value which relates to query | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.filter.read", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "jsonrpc": "2.0", + "result": [], + "id": 1 + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.impact.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.impact.md new file mode 100644 index 00000000..3386af17 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.impact.md @@ -0,0 +1,112 @@ +--- +title: cmdb.impact +description: cmdb.impact +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.impact.read + +This method is used for impact analysis and recursively returns all relationships of the specified object. The output can be restricted by specifying the relationship type.
+Attention: Depending on the environment and filling of the database this query may take some time and server resources (especially memory). + +### Request parameters + +| Key | JSON data type | Required | Description | +| ----------------- | ----------------- | -------- | ----------------------------------------------------------------------------------- | +| **id** | Integer | Yes | Object identifier, for example: **9** | +| **relation_type** | String or Integer | Yes | Constant of the relationship type or ID of the relationship type, for example **4** | + +Default relation types are: + +| Title | ID | Constant | +| -------------------------- | --- | ---------------------------------------- | +| Software assignment | 1 | C__RELATION_TYPE__SOFTWARE | +| Cluster service assignment | 2 | C__RELATION_TYPE__CLUSTER_SERVICE | +| Backup | 3 | C__RELATION_TYPE__BACKUP | +| Contact assignment | 4 | C__RELATION_TYPE__ADMIN | +| Contact assignment | 5 | C__RELATION_TYPE__USER | +| Cluster memberships | 6 | C__RELATION_TYPE__CLUSTER_MEMBERSHIPS | +| Power consumer | 7 | C__RELATION_TYPE__POWER_CONSUMER | +| Ports | 8 | C__RELATION_TYPE__NETWORK_PORT | +| Virtual machine | 9 | C__RELATION_TYPE__VIRTUAL_MACHINE | +| Location | 10 | C__RELATION_TYPE__LOCATION | +| Interface | 11 | C__RELATION_TYPE__UNIVERSAL_INTERFACE | +| Host address | 12 | C__RELATION_TYPE__IP_ADDRESS | +| FC port | 13 | C__RELATION_TYPE__CONTROLLER_FC_PORT | +| Connectors | 14 | C__RELATION_TYPE__CONNECTORS | +| Logical devices (Client) | 15 | C__RELATION_TYPE__LDEV_CLIENT | +| Group memberships | 16 | C__RELATION_TYPE__GROUP_MEMBERSHIPS | +| Person group memberships | 17 | C__RELATION_TYPE__PERSON_ASSIGNED_GROUPS | +| Dependency | 18 | C__RELATION_TYPE__DEFAULT | +| Database access | 19 | C__RELATION_TYPE__DATABASE_ACCESS | +| Database links | 20 | C__RELATION_TYPE__DATABASE_LINK | +| Database gateway | 21 | C__RELATION_TYPE__DATABASE_GATEWAY | +| Database instance | 22 | C__RELATION_TYPE__DATABASE_INSTANCE | +| Service component | 23 | C__RELATION_TYPE__IT_SERVICE_COMPONENT | +| Replication partner | 24 | C__RELATION_TYPE__REPLICATION_PARTNER | +| SOA-Component | 25 | C__RELATION_TYPE__SOA_COMPONENTS | + +### Response parameters + +JSON key **result** contains an array of JSON objects. Each object contains a search result. + +| Key | JSON data type | Description | +| --------------- | -------------- | ----------- | +| **id** | String | Placeholder | +| **name** | String | Placeholder | +| **data** | String | Placeholder | +| **type** | String | Placeholder | +| **text** | String | Placeholder | +| **relation** | String | Placeholder | +| **statusColor** | String | Placeholder | +| **objTypeID** | String | Placeholder | +| **objectType** | String | Placeholder | +| **objID** | String | Placeholder | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.impact.read", + "params": { + "id": 9, + "relation_type": 4, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "id": 123, + "name": "CareBear Power Client", + "data": { + "relation": { + "type": "Contact assignment", + "text": "administrates" + }, + "color": "B9E1BE", + "statusColor": "33C20A", + "objTypeID": 10, + "objectType": "Client", + "objID": 1122714692 + } + } + ] + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.ip_search.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.ip_search.md new file mode 100644 index 00000000..f266bf67 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.ip_search.md @@ -0,0 +1,53 @@ +--- +title: cmdb.ip_search +description: cmdb.ip_search +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.ip_search.read + +Get all Layer3 Objects (except Global v4/v6, where the IP is in the address range of the Layer3 Network) + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------ | -------------- | -------- | ------------ | +| **ip** | String | Yes | A IP Address | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.ip_search.read", + "params": { + "ip": "10.10.0.1", + "apikey": "h3md6u3y", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + Placeholder + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.location_tree.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.location_tree.md new file mode 100644 index 00000000..902041bf --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.location_tree.md @@ -0,0 +1,78 @@ +--- +title: cmdb.location_tree +description: cmdb.location_tree +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.location_tree + +This method can be used to build the location tree. Always exactly one level is loaded down. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------ | -------------- | -------- | -------------------------------------------- | +| **id** | Integer | Yes | A location object, for example a City **31** | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.location_tree", + "params": { + "id": 31, + "apikey": "h3md6u3y", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "id": 33, + "title": "Building 1", + "sysid": "SYSID_1691739706", + "type": 3, + "type_title": "Building", + "status": 2, + "cmdb_status": 6, + "cmdb_status_title": "in operation" + }, + { + "id": 35, + "title": "Building 2", + "sysid": "SYSID_1691739718", + "type": 3, + "type_title": "Building", + "status": 2, + "cmdb_status": 6, + "cmdb_status_title": "in operation" + } + ] + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.logbook.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.logbook.md new file mode 100644 index 00000000..4b9eaa17 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.logbook.md @@ -0,0 +1,169 @@ +--- +title: cmdb.logbook +description: cmdb.logbook +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.logbook.read + +Read access to the i-doit logbook. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **id** | Integer | No | ID of the global logbook entry from table isys_logbook | +| **object_id** | Integer | No | ID of the object | +| **catg_logbook_id** | Integer | No | ID of the logbook category entry from table sys_catg_logbook_list | +| **since** | String | No | Date to filter for logbook changes since a certain date, for possible values see also [https://www.php.net/manual/de/function.strtotime.php](https://www.php.net/manual/de/function.strtotime.php){:target="_blank"} for example **1660203634** (2022-08-11 09:40:34) | +| **status** | String | No | Filter by status of the objects e.g. Normal or Archived:
- **C__RECORD_STATUS__BIRTH** = Unfinished
- **C__RECORD_STATUS__NORMAL** = Normal
- **C__RECORD_STATUS__ARCHIVED** = Archived
- **C__RECORD_STATUS__DELETED** = Deleted
- **C__RECORD_STATUS__TEMPLATE** = Template
- **C__RECORD_STATUS__MASS_CHANGES_TEMPLATE** = Template for mass changes | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.logbook.read", + "params": { + "id": 2, + "since": "1660203634", + "status": 2, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "logbook_id": "20", + "logbook_catg_id": "17", + "comment": "", + "description": "UPDATE isys_catg_global_list\n SET isys_catg_global_list__isys_purpose__id = NULL,\n isys_catg_global_list__isys_catg_global_category__id = NULL,\n isys_catg_global_list__status = 2\n WHERE isys_catg_global_list__id = 31;", + "changes": { + "isys_cmdb_dao_category_g_global::title": { + "from": "", + "to": "Building 1" + } + }, + "date": "2023-08-11 09:41:16", + "username": "admin", + "event": "C__LOGBOOK_EVENT__CATEGORY_CHANGED", + "object_id": "33", + "object_title": "Building 1", + "object_title_static": "", + "source": "Internal", + "source_constant": "C__LOGBOOK_SOURCE__INTERNAL", + "level_id": "1" + } + ] + } + ``` + +## cmdb.logbook.create + +Write a entry to the i-doit logbook. + +### Request parameters + +| Key | JSON data type | Required | Description | +| --------------- | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | +| **object_id** | Integer | Yes | ID of the object | +| **object_ids** | String or Array | No | List of object identifiers | +| **message** | String | Yes | Message for the entry | +| **description** | String | No | Description for the entry | +| **comment** | String | No | Comment what has changed | +| **source** | String | No | Constant or ID of the source of the logbook entry from table `isys_logbook_source`.
Default is `C__LOGBOOK__ALERT_LEVEL__0` | +| **alert_level** | Integer or String | No | Constant or ID of the alert level, from table `isys_logbook_level`.
Default is `C__LOGBOOK__ALERT_LEVEL__0` | + +=== "Source list" + + | Title | ID | Constant | + | -------------- | ---- | --------------------------- | + | Internal | 1 | C__LOGBOOK_SOURCE__INTERNAL | + | External | 2 | C__LOGBOOK_SOURCE__EXTERNAL | + | Manual entries | 3 | C__LOGBOOK_SOURCE__USER | + | All! | 4 | C__LOGBOOK_SOURCE__ALL | + | RT Ticket | 1001 | C__LOGBOOK_SOURCE__RT | + | JDisc Import | 1004 | C__LOGBOOK_SOURCE__JDISC | + | Import | 1005 | C__LOGBOOK_SOURCE__IMPORT | + +=== "Alert level list" + + | Title | ID | Costant | + | --------------- | --- | -------------------------- | + | 0 (information) | 1 | C__LOGBOOK__ALERT_LEVEL__0 | + | 1 (low) | 2 | C__LOGBOOK__ALERT_LEVEL__1 | + | 2 (middle) | 3 | C__LOGBOOK__ALERT_LEVEL__2 | + | 3 (high) | 4 | C__LOGBOOK__ALERT_LEVEL__3 | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.logbook.create", + "params": { + "object_id": 31, + "message": "message", + "description": "SQL Description / Log", + "comment": "Revisional comment", + "source": "C__LOGBOOK_SOURCE__INTERNAL", + "alert_level": 1, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "id": 135, + "message": "Logbook entry/entries successfully created." + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object.md new file mode 100644 index 00000000..40475050 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object.md @@ -0,0 +1,483 @@ +--- +title: cmdb.object +description: object +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.object.read + +Read common information about an [object](../../../../grundlagen/struktur-it-dokumentation.md) + +### Request parameter + +| Key | JSON data type | Required | Description | +| ------ | -------------- | -------- | -------------------------------------- | +| **id** | Integer | Yes | Object identifier; for example: **42** | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| --------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **id** | String | Object identifier (as numeric string) | +| **title** | String | Object title | +| **sysid** | String | SYSID (see category **Global**) | +| **objecttype** | String | Object type identifier (as numeric string) | +| **created** | String | Date of creation; format: **Y-m-d H:i:s** | +| **updated** | String | Date of last update; format: **Y-m-d H:i:s**
**Note:** This key is optional because not every object has been updated before. | +| **type_title** | String | Translated name of object type | +| **type_icon** | String | Relative URL to object type icon | +| **status** | String | Filter by status of the objects e.g. Normal or Archived:
- **C__RECORD_STATUS__BIRTH** = Unfinished
- **C__RECORD_STATUS__NORMAL** = Normal
- **C__RECORD_STATUS__ARCHIVED** = Archived
- **C__RECORD_STATUS__DELETED** = Deleted
- **C__RECORD_STATUS__TEMPLATE** = Template
- **C__RECORD_STATUS__MASS_CHANGES_TEMPLATE** = Template for mass changes | +| **cmdb_status** | String | CMDB status (see category **Global**; as numeric string) | +| **cmdb_status_title** | String | Translated CMDB status (see category **Global**) | +| **image** | String | URL to object picture | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.read", + "params": { + "id": 1000, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "id": 1000, + "title": "ESXi1", + "sysid": "VHOST_1426338622", + "objecttype": 58, + "type_title": "Virtual host", + "type_icon": "images/icons/silk/server_database.png", + "status": 2, + "cmdb_status": 6, + "cmdb_status_title": "in operation", + "created": "2023-07-11 14:07:04", + "updated": "2023-07-11 14:07:04", + "image": "http://demo.synetics.int/pro/images/objecttypes/server.png" + } + } + ``` + +## cmdb.object.create + +Create new [object](../../../../grundlagen/struktur-it-dokumentation.md) with some optional information + +### Request parameter + +| Key | JSON data type | Required | Description | +| --------------- | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| **type** | String\|Integer | Yes | Object type constant as string, for example: **"C__OBJTYPE__SERVER"**

Alternatively, object type identifier as integer, for example: **5** | +| **title** | String | Yes | Object title, for example: **"My little server"** | +| **category** | String | No | Attribute **Category** in category **Global** | +| **categories** | Object with Array | No | Category constant, for example: **"C__CATG__MODEL"** with keys in a array | +| **purpose** | String | No | Attribute **Purpose** in category Global, for example: **"In production"** | +| **cmdb_status** | String\|Integer | No | Attribute **CMDB status** in category **Global** by its constant (string), for example: **"C__CMDB_STATUS__IN_OPERATION"**

Alternatively, by its identifier (integer), for example: **6** | +| **description** | String | No | Attribute **Description** in category **Global** | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------------------------- | +| **id** | String | Object identifier (as numeric string) | +| **message** | String | Some information | +| **success** | Boolean | Should always be **true** | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.create", + "params": { + "type": "C__OBJTYPE__SERVER", + "title": "My little server", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "id": 28, + "message": "Object was successfuly created", + "success": true + } + } + ``` + +## cmdb.object.update + +Change object e.g title of a object. + +### Request parameter + +| Key | JSON data type | Required | Description | +| --------- | -------------- | -------- | ------------------------------------------------------- | +| **id** | Integer | Yes | Object identifier, for example: **42** | +| **title** | String | Yes | New object title, for example: **"Your little server"** | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | -------------- | +| **message** | String | Should be | +| **success** | Boolean | Should be true | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.update", + "params": { + "id": 42, + "title": "Your little server", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "jsonrpc": "2.0", + "result": { + "message": "Object title was successfuly updated", + "success": true + }, + "id": 1 + } + ``` + +## cmdb.object.delete + +[Deletes](../../../../grundlagen/struktur-it-dokumentation.md) a object also can set a specific record status like Archived. + +### Request parameter + +| Key | JSON data type | Required | Description | +| ---------- | -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **id** | Integer | Yes | Object identifier, for example: **42** | +| **status** | String | Yes | Status constant:
**C__RECORD_STATUS__ARCHIVED**
Archive object
**C__RECORD_STATUS__DELETED**
Mark object as deleted
**C__RECORD_STATUS__PURGE**
Purge object from database | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.delete", + "params": { + "id": 42, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Object 42 has been deleted." + }, + "id": 1 + } + ``` + +## cmdb.object.recycle + +Recycles a object + +### Request parameter + +| Key | JSON data type | Required | Description | +| ---------- | -------------- | -------- | --------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **464** | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.recycle", + "params": { + "object": 28, + "status": "C__RECORD_STATUS__ARCHIVED", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Object 28 has been recycled." + } + } + ``` + +## cmdb.object.archive + +[Archives](../../../../grundlagen/struktur-it-dokumentation.md) a object + +### Request parameter + +| Key | JSON data type | Required | Description | +| ---------- | -------------- | -------- | --------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **464** | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.archive", + "params": { + "object": 464, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Object 464 has been archived." + } + } + ``` + +## cmdb.object.purge + +[Purges](../../../../grundlagen/struktur-it-dokumentation.md) a object when the status is deleted. + +### Request parameter + +| Key | JSON data type | Required | Description | +| ---------- | -------------- | -------- | --------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **464** | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.purge", + "params": { + "object": 464, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Object 464 has been purged." + } + } + ``` + +## cmdb.object.markAsTemplate + +Set the Object condition as a [Template](../../../../effizientes-dokumentieren/templates.md) + +### Request parameter + +| Key | JSON data type | Required | Description | +| ---------- | -------------- | -------- | --------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **465** | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.markAsTemplate", + "params": { + "object": 465, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Object 465 has been marked as template." + } + } + ``` + +## cmdb.object.markAsMassChangeTemplate + +Set the Object condition as a [Mass Change](../../../../effizientes-dokumentieren/massenaenderung.md) [Template](../../../../effizientes-dokumentieren/templates.md) + +### Request parameter + +| Key | JSON data type | Required | Description | +| ---------- | -------------- | -------- | --------------------------------------- | +| **object** | Integer | Yes | Object identifier, for example: **465** | + +### Response parameter + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------ | +| **success** | Boolean | Should be **true** | +| **message** | String | Some information | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object.markAsMassChangeTemplate", + "params": { + "object": 465, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Object 465 has been marked as mass change template." + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_type_categories.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_type_categories.md new file mode 100644 index 00000000..7af4d2c2 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_type_categories.md @@ -0,0 +1,163 @@ +--- +title: cmdb.object_type_categories +description: cmdb.object_type_categories +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.object_type_categories + +Read categories assigned to a object type. + +### Request parameters + +| Key | JSON data type | Required | Description | +| -------- | ----------------- | -------- | -------------------------------------- | +| **type** | Integer or String | Yes | Object type ID or Constant | +| **raw** | Boolean | No | Displayed raw formatting, see example. | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object_type_categories", + "params": { + "type": 14, + "apikey": "h3md6u3y", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "catg": [ + { + "id": "31", + "title": "Overview page", + "const": "C__CATG__OVERVIEW", + "multi_value": "0", + "source_table": "isys_catg_overview" + }, + { + "id": "80", + "title": "Service assignment", + "const": "C__CATG__IT_SERVICE", + "multi_value": "1", + "source_table": "isys_catg_its_components" + }, + { + "id": "82", + "title": "Relationship", + "const": "C__CATG__RELATION", + "multi_value": "1", + "source_table": "isys_catg_relation" + }, + { + "id": "89", + "title": "Status-Planning", + "const": "C__CATG__PLANNING", + "multi_value": "1", + "source_table": "isys_catg_planning" + }, + { + "id": "38", + "title": "Accounting", + "const": "C__CATG__ACCOUNTING", + "multi_value": "0", + "source_table": "isys_catg_accounting" + }, + { + "id": "114", + "title": "Access permissions", + "const": "C__CATG__VIRTUAL_AUTH", + "multi_value": "0", + "source_table": "isys_catg_virtual" + }, + { + "id": "1", + "title": "General", + "const": "C__CATG__GLOBAL", + "multi_value": "0", + "source_table": "isys_catg_global" + }, + { + "id": "21", + "title": "Contact assignment", + "const": "C__CATG__CONTACT", + "multi_value": "1", + "source_table": "isys_catg_contact" + }, + { + "id": "20", + "title": "Files", + "const": "C__CATG__FILE", + "multi_value": "1", + "source_table": "isys_catg_file" + }, + { + "id": "22", + "title": "Logbook", + "const": "C__CATG__LOGBOOK", + "multi_value": "1", + "source_table": "isys_catg_logb" + }, + { + "id": "27", + "title": "Object picture", + "const": "C__CATG__IMAGE", + "multi_value": "0", + "source_table": "isys_catg_image" + } + ], + "cats": [ + { + "id": "8", + "title": "Emergency plan", + "const": "C__CATS__EMERGENCY_PLAN", + "multi_value": "0", + "source_table": "isys_cats_emergency_plan_list" + }, + { + "id": "32", + "title": "Emergency plan properties", + "const": "C__CATS__EMERGENCY_PLAN_ATTRIBUTE", + "parent": "8", + "multi_value": "0", + "source_table": "isys_cats_emergency_plan_list" + }, + { + "id": "33", + "title": "assigned objects", + "const": "C__CATS__EMERGENCY_PLAN_LINKED_OBJECTS", + "parent": "8", + "multi_value": "1", + "source_table": "isys_catg_emergency_plan_list" + } + ] + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_type_groups.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_type_groups.md new file mode 100644 index 00000000..b8b99d24 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_type_groups.md @@ -0,0 +1,106 @@ +--- +title: cmdb.object_type_groups +description: cmdb.object_type_groups +icon: material/api +#status: updated +lang: de +--- + +!!! example "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." + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object_type_groups", + "params": { + "filter": { + "ids": [1,2,3,4,1000] + }, + "raw": false, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "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" + } + ] + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_types.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_types.md new file mode 100644 index 00000000..45e9848d --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.object_types.md @@ -0,0 +1,136 @@ +--- +title: cmdb.object_types +description: cmdb.object_types +icon: material/api +#status: updated +lang: en +--- + +!!! example "Work in Progress" + +## cmdb.object_types + +Read objects type configurations. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ---------------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **countobjects** | Boolean | No | Display object counter | +| **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):

- **"isys_obj_type__id"**,
- **"isys_obj__isys_obj_type__id"**,
- **"type"**,
- **"isys_obj__title"**,
- **"title"**,
- **"isys_obj_type__title"**,
- **"type_title"**,
- **"isys_obj__sysid"**,
- **"sysid"**,
- **"isys_cats_person_list__first_name"**,
- **"first_name"**,
- **"isys_cats_person_list__last_name"**,
- **"last_name"**,
- **"isys_cats_person_list__mail_address"**,
- **"email"**,
- **"isys_obj__id"**, or
- **"id"** | +| **raw** | Boolean | No | Displayed raw formatting, see example. | + +### Filter + +| Key | JSON data type | Required | Description | +| ----------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------- | +| **id** | Integer | No | Object type id or Object type constant | +| **ids** | Array | No | List of object type identifiers (as integers), for example: **[1, 2, 3]** | +| **title** | String | No | Object type language constant, for example: `LC__CMDB__OBJTYPE__SERVER` for Server | +| **titles** | Array | No | List of Object type language constants, for example: `["LC__CMDB__OBJTYPE__SERVER","LC__CMDB__OBJTYPE__CLIENT"]` | +| **enabled** | Boolean | No | Show only object types enabled or disabled in GUI | + +You can use any combination of filters. + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.object_types", + "params": { + "filter": { + "id": 5 + }, + "countobjects": true, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "id": "5", + "title": "Server", + "container": "0", + "const": "C__OBJTYPE__SERVER", + "color": "A2BCFA", + "image": "http://10.10.60.64/testinstance/images/objecttypes/server.png", + "icon": "images/axialis/hardware-network/server-single.svg", + "tree_group": "2", + "status": "2", + "type_group": "2", + "type_group_title": "Infrastructure", + "objectcount": "1" + } + ] + } + ``` + +=== "Response body with RAW" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "isys_obj_type__id": "5", + "isys_obj_type__isys_obj_type_group__id": "2", + "isys_obj_type__isysgui_cats__id": null, + "isys_obj_type__default_template": null, + "isys_obj_type__title": "LC__CMDB__OBJTYPE__SERVER", + "isys_obj_type__description": "", + "isys_obj_type__selfdefined": "0", + "isys_obj_type__container": "0", + "isys_obj_type__idoit_obj_type_number": "", + "isys_obj_type__obj_img_name": "server.png", + "isys_obj_type__icon": "images/axialis/hardware-network/server-single.svg", + "isys_obj_type__const": "C__OBJTYPE__SERVER", + "isys_obj_type__sort": "40", + "isys_obj_type__property": "0", + "isys_obj_type__status": "2", + "isys_obj_type__show_in_tree": "1", + "isys_obj_type__show_in_rack": "1", + "isys_obj_type__overview": "1", + "isys_obj_type__color": "A2BCFA", + "isys_obj_type__class_name": "isys_cmdb_dao_list_objects", + "isys_obj_type__sysid_prefix": null, + "isys_obj_type__relation_master": "0", + "isys_obj_type__isys_jdisc_profile__id": null, + "isys_obj_type__use_template_title": "0", + "isys_obj_type_group__id": "2", + "isys_obj_type_group__title": "LC__CMDB__OBJTYPE_GROUP__INFRASTRUCTURE", + "isys_obj_type_group__description": null, + "isys_obj_type_group__const": "C__OBJTYPE_GROUP__INFRASTRUCTURE", + "isys_obj_type_group__sort": "2", + "isys_obj_type_group__property": "1", + "isys_obj_type_group__status": "2" + } + ] + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.objects.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.objects.md new file mode 100644 index 00000000..d772498f --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.objects.md @@ -0,0 +1,108 @@ +--- +title: cmdb.object +description: cmdb.object +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.objects.read + +Fetch a list of [objects](../../../../grundlagen/struktur-it-dokumentation.md) + +### Request parameters + +| Key | JSON data type | Required | Description | +| -------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **categories** | Array | No | Here you can filter by a list or a category, in the form of category constant/s.
"categories": ["C__CATG__MY_CUSTOM_CATEGORY"]
"categories": ["C__CATG__MY_CUSTOM_CATEGORY", "C__CATG__MY_SECOND_CATEGORY"] | +| **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"** | +| **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"** | +| **sort** | String | No | Only useful in combination with key **order_by**; allowed values are either **"ASC"** (ascending) or **"DESC"** (descending) | + +### Filter + +| Key | JSON data type | Required | Description | +| -------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **ids** | Array | No | List of object identifiers (as integers), for example: **[1, 2, 3]** | +| **type** | Array | No | Object type identifier (as integer), for example: **5**

Alternatively, object type constant (as string), for example: **"C__OBJTYPE__SERVER"** | +| **title** | String | No | Object title (see attribute **Title** in category **Global**), for example: **"My little server"** | +| **type_title** | String | No | Translated name of object type, for example: **"Server"**
**Note:** Set a proper **language** in your request. | +| **sysid** | String | No | **SYSID** (see category **Global**), for example: **"SRV_101010"** | +| **first_name** | String | No | First name of an object of type **Persons** (see attribute **First name** in category **Persons → Master Data**), for example: **"John"** | +| **last_name** | String | No | Last name of an object of type **Persons** (see attribute **Last name** in category **Persons → Master Data**), for example: **"Doe"** | +| **email** | String | No | Primary e-mail address of an object of type **Persons**, **Person groups** or **Organization** (see attribute **E-mail address** in categories **Persons/Person groups/Organization → Master Data**), for example: **""** | +| **type_group** | String | No | Filters by the object type group e.g. Infrastructure or Other:
"**C__OBJTYPE_GROUP__INFRASTRUCTURE**" | +| **status** | String | No | Filter by status of the objects e.g. Normal or Archived:
- **C__RECORD_STATUS__BIRTH** = Unfinished
- **C__RECORD_STATUS__NORMAL** = Normal
- **C__RECORD_STATUS__ARCHIVED** = Archived
- **C__RECORD_STATUS__DELETED** = Deleted
- **C__RECORD_STATUS__TEMPLATE** = Template
- **C__RECORD_STATUS__MASS_CHANGES_TEMPLATE** = Template for mass changes | + +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." + +### Response parameters + +JSON key **result** contains an array of JSON objects. Each object contains a bunch of information about an i-doit object. + +| Key | JSON data type | Description | +| --------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **id** | String | Object identifier (as numeric string) | +| **title** | String | Object title | +| **sysid** | String | SYSID (see category **Global**) | +| **type** | String | Object type identifier (as numeric string) | +| **created** | String | Date of creation; format: **Y-m-d H:i:s** | +| **updated** | String | Date of last update; format: **Y-m-d H:i:s**

**Note:** This key is optional because not every object has been updated before. | +| **type_title** | String | Translated name of object type | +| **type_group_title** | String | Translated name of object type group | +| **status** | String | Object status:

***C__RECORD_STATUS__BIRTH
Status-ID = 1
Title =****Unfinished**
* **C__RECORD_STATUS__NORMAL
Status-ID = 2**
**Title = ****Normal**
* **C__RECORD_STATUS__ARCHIVED
Status-ID = 3**
**Title =** **Archived**
* **C__RECORD_STATUS__DELETED
Status-ID = 4**
**Title =** **Deleted**
* **C__RECORD_STATUS__TEMPLATE
Status-ID = 6**
**Title =** **Template**
* **C__RECORD_STATUS__MASS_CHANGES_TEMPLATE
Status-ID = 7**
**Title =** **Mass change template** | +| **cmdb_status** | String | CMDB status (see category **Global**; as numeric string) | +| **cmdb_status_title** | String | Translated CMDB status (see category **Global**) | +| **image** | String | URL to object picture | +| **categories** | Mixed | Optional attributes with values depending on the requested category | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.objects.read", + "params": { + "filter": { + "type": "C__OBJTYPE__SERVER", + "status": "C__RECORD_STATUS__ARCHIVED" + }, + "limit": "0,10", + "order_by": "title", + "sort": "ASC", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "jsonrpc": "2.0", + "result": [ + { + "id": "123", + "title": "My little server", + "sysid": "SRV_101010", + "type": "5", + "created": "2017-03-07 15:57:48", + "updated": "2017-05-10 15:40:27", + "type_title": "Server", + "type_group_title": "Hardware", + "status": "3", + "cmdb_status": "6", + "cmdb_status_title": "in operation", + "image": "https://demo.i-doit.com/images/objecttypes/empty.png" + }, + […] + ] + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.objects_by_relation.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.objects_by_relation.md new file mode 100644 index 00000000..8dbcc60f --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.objects_by_relation.md @@ -0,0 +1,207 @@ +--- +title: cmdb.objects_by_relation +description: cmdb.objects_by_relation +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.objects_by_relation.read + +Return objects by relation. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ----------------- | ----------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **id** | Integer | Yes | Object identifier | +| **relation_type** | String or Integer | No | Constant of the relationship type or ID of the relationship type, for example **4** | +| **status** | String | No | Filter by status of the objects e.g. Normal or Archived:

- **C__RECORD_STATUS__NORMAL**
**Status ID = 2**
**Designation = Normal**
- **C__RECORD_STATUS__ARCHIVED**
**Status ID = 3**
**Designation = Archived**
- **C__RECORD_STATUS__DELETED**
**Status-ID = 4**
**Description = Deleted**
- **C__RECORD_STATUS__TEMPLATE**
**Status-ID = 6**
**Description = Template**
- **C__RECORD_STATUS__MASS_CHANGES_TEMPLATE**
**Status ID = 7**
**Description = Template for mass changes** | +| **raw** | Boolean | No | Displayed raw formatting, see example. | + +Default relation types are: + +| Title | ID | Constant | +| -------------------------- | --- | ---------------------------------------- | +| Software assignment | 1 | C__RELATION_TYPE__SOFTWARE | +| Cluster service assignment | 2 | C__RELATION_TYPE__CLUSTER_SERVICE | +| Backup | 3 | C__RELATION_TYPE__BACKUP | +| Contact assignment | 4 | C__RELATION_TYPE__ADMIN | +| Contact assignment | 5 | C__RELATION_TYPE__USER | +| Cluster memberships | 6 | C__RELATION_TYPE__CLUSTER_MEMBERSHIPS | +| Power consumer | 7 | C__RELATION_TYPE__POWER_CONSUMER | +| Ports | 8 | C__RELATION_TYPE__NETWORK_PORT | +| Virtual machine | 9 | C__RELATION_TYPE__VIRTUAL_MACHINE | +| Location | 10 | C__RELATION_TYPE__LOCATION | +| Interface | 11 | C__RELATION_TYPE__UNIVERSAL_INTERFACE | +| Host address | 12 | C__RELATION_TYPE__IP_ADDRESS | +| FC port | 13 | C__RELATION_TYPE__CONTROLLER_FC_PORT | +| Connectors | 14 | C__RELATION_TYPE__CONNECTORS | +| Logical devices (Client) | 15 | C__RELATION_TYPE__LDEV_CLIENT | +| Group memberships | 16 | C__RELATION_TYPE__GROUP_MEMBERSHIPS | +| Person group memberships | 17 | C__RELATION_TYPE__PERSON_ASSIGNED_GROUPS | +| Dependency | 18 | C__RELATION_TYPE__DEFAULT | +| Database access | 19 | C__RELATION_TYPE__DATABASE_ACCESS | +| Database links | 20 | C__RELATION_TYPE__DATABASE_LINK | +| Database gateway | 21 | C__RELATION_TYPE__DATABASE_GATEWAY | +| Database instance | 22 | C__RELATION_TYPE__DATABASE_INSTANCE | +| Service component | 23 | C__RELATION_TYPE__IT_SERVICE_COMPONENT | +| Replication partner | 24 | C__RELATION_TYPE__REPLICATION_PARTNER | +| SOA-Component | 25 | C__RELATION_TYPE__SOA_COMPONENTS | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.objects_by_relation", + "params": { + "status": 2, + "id": 62, + "raw": false, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "63": { + "data": { + "id": 63, + "title": "Michael Overkamp is logical unit of Workstation_1", + "cmdb_status_title": "", + "related_object": 60, + "related_title": "Workstation_1", + "related_type": 71, + "related_type_title": "Workplace", + "related_cmdb_status_title": "in operation", + "master": 62, + "slave": 60, + "type": 60, + "type_title": "Relation" + }, + "children": false + }, + "69": { + "data": { + "id": 69, + "title": "Admin has member Michael Overkamp", + "cmdb_status_title": "", + "related_object": 14, + "related_title": "Admin", + "related_type": 54, + "related_type_title": "Person groups", + "related_cmdb_status_title": "in operation", + "master": 14, + "slave": 62, + "type": 60, + "type_title": "Relation" + }, + "children": false + }, + "70": { + "data": { + "id": 70, + "title": "Author has member Michael Overkamp", + "cmdb_status_title": "", + "related_object": 12, + "related_title": "Author", + "related_type": 54, + "related_type_title": "Person groups", + "related_cmdb_status_title": "in operation", + "master": 12, + "slave": 62, + "type": 60, + "type_title": "Relation" + }, + "children": false + }, + "71": { + "data": { + "id": 71, + "title": "MyLittleClient is used by Michael Overkamp", + "cmdb_status_title": "", + "related_object": 58, + "related_title": "MyLittleClient", + "related_type": 10, + "related_type_title": "Client", + "related_cmdb_status_title": "in operation", + "master": 58, + "slave": 62, + "type": 60, + "type_title": "Relation" + }, + "children": false + } + } + } + ``` + +=== "Request body with relation_type" + + ```json + { + "version": "2.0", + "method": "cmdb.objects_by_relation", + "params": { + "status": 2, + "id": 62, + "relation_type": 5, + "raw": false, + "apikey": "h3md6u3y", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "71": { + "data": { + "id": 71, + "title": "MyLittleClient is used by Michael Overkamp", + "cmdb_status_title": "", + "related_object": 58, + "related_title": "MyLittleClient", + "related_type": 10, + "related_type_title": "Client", + "related_cmdb_status_title": "in operation", + "master": 58, + "slave": 62, + "type": 60, + "type_title": "Relation" + }, + "children": false + } + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.reports.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.reports.md new file mode 100644 index 00000000..ade70e7f --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.reports.md @@ -0,0 +1,131 @@ +--- +title: cmdb.reports +description: cmdb.reports +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.reports.read + +Display the result of a report. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ---------- | -------------- | -------- | -------------------------------------------- | +| **id** | String | No | Identifier of the Report | +| **limit** | Integer | No | Limit displayed results | +| **offset** | Integer | No | Start displaying results from defined offset | + +### Response parameters + +JSON key **result** contains the Report result. + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.reports", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "id": "1", + "category": "Global", + "title": "My first Report", + "description": "", + "created": "2023-08-14 13:02:48" + } + ] + } + ``` + +=== "Request boy with Identifier" + + ```json + { + "version": "2.0", + "method": "cmdb.reports", + "params": { + "id": 1, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body with Identifier" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "Title": "admin " + }, + { + "Title": "Admin" + }, + .... + ] + } + ``` + +=== "Request boy with limit and offset" + + ```json + { + "version": "2.0", + "method": "cmdb.reports", + "params": { + "id": 1, + "limit": 2, + "offset": 2, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } { + "Title": "admin " + }, + { + "Title": "Admin" + }, + ``` + +=== "Response body with limit and offset" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "Title": "admin " + }, + { + "Title": "Admin" + }, + ] + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.status.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.status.md new file mode 100644 index 00000000..23c5776b --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.status.md @@ -0,0 +1,284 @@ +--- +title: cmdb.status +description: cmdb.status +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.status.read + +Read all available states. + +### Request parameters + +| Key | JSON data type | Required | Description | +| --- | -------------- | -------- | ----------- | +| - | - | - | - | + +!!! example "WIP" + + ### Response parameters + + JSON key **result** contains an array of JSON objects. Each object contains a search result. + + | Key | JSON data type | Description | + | ------------ | -------------- | ---------------------- | + | **id** | integer | id of the status | + | **title** | string | Title of the status | + | **constant** | string | constant of the status | + | **color** | string | Color code | + | **editable** | bool | Is the status editable | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.status.read", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "id": 1, + "title": "planned", + "constant": "C__CMDB_STATUS__PLANNED", + "color": "EFAA43", + "editable": true + }, + { + "id": 2, + "title": "ordered", + "constant": "C__CMDB_STATUS__ORDERED", + "color": "838683", + "editable": true + }, + { + "id": 3, + "title": "delivered", + "constant": "C__CMDB_STATUS__DELIVERED", + "color": "DDECD5", + "editable": true + }, + { + "id": 4, + "title": "assembled", + "constant": "C__CMDB_STATUS__ASSEMBLED", + "color": "C6DFB9", + "editable": true + }, + { + "id": 5, + "title": "tested", + "constant": "C__CMDB_STATUS__TESTED", + "color": "95C47C", + "editable": true + }, + { + "id": 6, + "title": "in operation", + "constant": "C__CMDB_STATUS__IN_OPERATION", + "color": "33C20A", + "editable": false + }, + { + "id": 7, + "title": "defect", + "constant": "C__CMDB_STATUS__DEFECT", + "color": "BC0A19", + "editable": true + }, + { + "id": 8, + "title": "under repair", + "constant": "C__CMDB_STATUS__UNDER_REPAIR", + "color": "F990BE", + "editable": true + }, + { + "id": 9, + "title": "delivered from repair", + "constant": "C__CMDB_STATUS__DELIVERED_FROM_REPAIR", + "color": "F3EF15", + "editable": true + }, + { + "id": 10, + "title": "inoperative", + "constant": "C__CMDB_STATUS__INOPERATIVE", + "color": "FF0000", + "editable": false + }, + { + "id": 11, + "title": "stored", + "constant": "C__CMDB_STATUS__STORED", + "color": "A2BCFA", + "editable": true + }, + { + "id": 12, + "title": "scrapped", + "constant": "C__CMDB_STATUS__SCRAPPED", + "color": "082B9A", + "editable": true + }, + { + "id": 13, + "title": "i-doit Status", + "constant": "C__CMDB_STATUS__IDOIT_STATUS", + "color": "AAAAAA", + "editable": false + }, + { + "id": 14, + "title": "Template", + "constant": "C__CMDB_STATUS__IDOIT_STATUS_TEMPLATE", + "color": "CCCCCC", + "editable": false + } + ] + } + ``` + +## cmdb.status.save + +Create new or save existing state. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------------ | -------------- | -------- | ------------------------------------------------------ | +| **title** | String | Yes | Status title | +| **constant** | String | Yes | Status constant | +| **color** | String | Yes | Color in hex without leading `#`, for example `FF0000` | + +!!! example "WIP" + + ### Response parameters + + JSON key **result** contains an array of JSON objects. Each object contains a search result. + +| Key | JSON data type | Description | +| ----------- | -------------- | ------------------------------------- | +| **id** | String | Object identifier (as numeric string) | +| **message** | String | Some information | +| **success** | Boolean | Should always be **true** | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.status.save", + "params": { + "title": "MyOwn", + "constant": "C__CMDB__STATUS__MYOWN", + "color": "FF0000", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Status created", + "id": 15 + } + } + ``` + +=== "or update Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.status.save", + "params": { + "id": 15, + "title": "MyOwn", + "constant": "C__CMDB__STATUS__MYOWN", + "color": "0000ff", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +## cmdb.status.delete + +Purge a state. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ------ | -------------- | -------- | --------------------- | +| **id** | Integer | Yes | ID of the CMDB Status | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "cmdb.status.delete", + "params": { + "id": 15, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "message": "Status purged" + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.workstation_components.md b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.workstation_components.md new file mode 100644 index 00000000..4cdc8b44 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/cmdb.workstation_components.md @@ -0,0 +1,193 @@ +--- +title: cmdb.workstation_components.read +description: cmdb.workstation_components.read +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## cmdb.workstation_components.read + +Fetches workplace components for a Person. + +### Request parameters + +| Key | JSON data type | Required | Description | +| ---------- | ------------------ | -------- | ---------------------- | +| **id** | Integer | No | ID of a object | +| **ids** | Array with integer | No | ID of objects | +| **email** | String | No | Person email address | +| **emails** | String | No | Person email addresses | + +!!! example "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 + +=== "Request body with email" + + ```json + { + "version": "2.0", + "method": "cmdb.workstation_components.read", + "params": { + "filter": { + "email": "moverkamp@i-doit.com" + }, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "62": { + "data": { + "id": "62", + "title": "Michael Overkamp", + "sysid": "SYSID_1692080956", + "type": "53", + "type_title": "Persons", + "status": "2", + "email": "moverkamp@i-doit.com", + "first_name": "Michael", + "last_name": "Overkamp" + }, + "children": { + "60": { + "data": { + "id": "60", + "title": "Workstation_1", + "sysid": "SYSID_1692080944", + "type": "71", + "type_title": "Workplace", + "status": "2" + }, + "children": { + "58": { + "data": { + "id": "58", + "title": "MyLittleClient", + "sysid": "SYSID_1692080907", + "type": "10", + "type_title": "Client", + "status": "2" + }, + "children": false + } + } + } + } + } + } + } + ``` + +=== "Request body with ids" + + ```json + { + "version": "2.0", + "method": "cmdb.workstation_components.read", + "params": { + "filter": { + "ids": [62,64] + }, + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "62": { + "data": { + "id": "62", + "title": "Michael Overkamp", + "sysid": "SYSID_1692080956", + "type": "53", + "type_title": "Persons", + "status": "2", + "email": "moverkamp@i-doit.com", + "first_name": "Michael", + "last_name": "Overkamp" + }, + "children": { + "60": { + "data": { + "id": "60", + "title": "Workstation_1", + "sysid": "SYSID_1692080944", + "type": "71", + "type_title": "Workplace", + "status": "2" + }, + "children": { + "58": { + "data": { + "id": "58", + "title": "MyLittleClient", + "sysid": "SYSID_1692080907", + "type": "10", + "type_title": "Client", + "status": "2" + }, + "children": false + } + } + } + } + }, + "64": { + "data": { + "id": "64", + "title": "Michael Overkamp Again", + "sysid": "SYSID_1692081388", + "type": "53", + "type_title": "Persons", + "status": "2", + "email": "2moverkamp@i-doit.com", + "first_name": "Michael", + "last_name": "Overkamp Again" + }, + "children": { + "65": { + "data": { + "id": "65", + "title": "Workstation_2", + "sysid": "SYSID_1692081488", + "type": "71", + "type_title": "Workplace", + "status": "2" + }, + "children": false + } + } + } + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/console.md b/docs/de/i-doit-add-ons/api/methoden/v1/console.md new file mode 100644 index 00000000..9fd9b502 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/console.md @@ -0,0 +1,67 @@ +--- +title: console +description: console +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## console.tenant.list + +Get a list of the tenants. + +### Request parameters + +| Key | JSON data type | Required | Description | +| --- | -------------- | -------- | ----------- | +| - | - | - | - | + +!!! example "WIP" + + ### Response parameters + + JSON key **result** contains an array of JSON objects. Each object contains a search result. + +| Key | JSON data type | Description | +| ----------- | -------------- | ---------------------------- | +| **success** | Boolean | Should always be **true** | +| **output** | String | Table with available tenants | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "console.tenant.list", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "output": [ + "Available tenants:", + "+----+---------------+------------------+--------------------------+----------+", + "| ID | Title | (host:port) | database | [status] |", + "+----+---------------+------------------+--------------------------+----------+", + "| 1 | KnowledgeBase | (localhost:3306) | idoit_data_KnowledgeBase | active |", + "+----+---------------+------------------+--------------------------+----------+", + "" + ] + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/idoit.md b/docs/de/i-doit-add-ons/api/methoden/v1/idoit.md new file mode 100644 index 00000000..d9ca7e24 --- /dev/null +++ b/docs/de/i-doit-add-ons/api/methoden/v1/idoit.md @@ -0,0 +1,537 @@ +--- +title: idoit +description: idoit +icon: material/api +#status: updated +lang: de +--- + +!!! example "Work in Progress" + +## idoit.addons + +Displays a list of installed add-ons + +### Request parameters + +| Key | JSON data type | Description | +| --- | -------------- | ----------- | +| - | - | - | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "idoit.addons", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "success": true, + "result": [ + { + "title": "Api", + "key": "api", + "version": "1.14.1", + "author": { + "name": "synetics GmbH" + }, + "licensed": true, + "active": true, + "installed": true + }, + { + "title": "PRO", + "key": "pro", + "version": "25", + "author": { + "name": "synetics GmbH" + }, + "licensed": true, + "active": true, + "installed": true + } + ] + } + } + ``` + +## idoit.constants + +Fetch defined constants from i-doit. + +### Request parameters + +| Key | JSON data type | Description | +| --- | -------------- | ----------- | +| - | - | - | + +### Response + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ---------------- | -------------- | ----------------------------------------------------------------------------------------------------- | +| **objectTypes** | Object | List of object types

Keys: object type constants

Values: translated object type titles | +| **categories** | Object | List of global and specific categories | +| **categories.g** | Object | List of global categories

Keys: category constants

Values: translated category titles | +| **categories.s** | Object | List of specific categories

Keys: category constants

Values: translated category titles | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "idoit.constants", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "objectTypes": { + "C__OBJTYPE__SERVICE": "System Service", + "C__OBJTYPE__APPLICATION": "Application", + "C__OBJTYPE__BUILDING": "Building", + "C__OBJTYPE__ENCLOSURE": "Rack", + "C__OBJTYPE__SERVER": "Server", + ... + }, + "categories": { + "g": { + "C__CATG__GLOBAL": "General", + "C__CATG__MODEL": "Model", + "C__CATG__FORMFACTOR": "Form factor", + "C__CATG__CPU": "CPU", + "C__CATG__MEMORY": "Memory", + "C__CATG__NETWORK": "Network", + ... + }, + "s": { + "C__CATS__ENCLOSURE": "Rack", + "C__CATS__ROOM": "Room", + "C__CATS__SERVICE": "Services", + "C__CATS__SWITCH_NET": "Switch", + "C__CATS__WAN": "WAN", + ... + }, + "g_custom": { + "C__CATG__CUSTOM_FIELDS_DIALOG_ADMIN_KB": "Dialog-Admin KB" + } + }, + "recordStates": { + "C__RECORD_STATUS__NORMAL": "Normal", + "C__RECORD_STATUS__ARCHIVED": "Archived", + "C__RECORD_STATUS__DELETED": "Deleted", + "C__RECORD_STATUS__PURGE": "LC__CMDB__RECORD_STATUS__PURGE" + }, + "relationTypes": { + "C__RELATION_TYPE__SOFTWARE": "Software assignment", + "C__RELATION_TYPE__CLUSTER_SERVICE": "Cluster service assignment", + "C__RELATION_TYPE__BACKUP": "Backup", + "C__RELATION_TYPE__ADMIN": "Contact assignment", + "C__RELATION_TYPE__USER": "Contact assignment", + ... + }, + "staticObjects": { + "C__OBJ__ROOT_LOCATION": "Root location", + "C__OBJ__PERSON_GUEST": "guest ", + "C__OBJ__PERSON_READER": "reader ", + "C__OBJ__PERSON_EDITOR": "editor ", + "C__OBJ__PERSON_AUTHOR": "author ", + "C__OBJ__PERSON_ARCHIVAR": "archivar ", + "C__OBJ__PERSON_ADMIN": "admin ", + "C__OBJ__PERSON_GROUP_READER": "Reader", + "C__OBJ__PERSON_GROUP_EDITOR": "Editor", + "C__OBJ__PERSON_GROUP_AUTHOR": "Author", + "C__OBJ__PERSON_GROUP_ARCHIVAR": "Archivar", + "C__OBJ__PERSON_GROUP_ADMIN": "Admin", + "C__OBJ__NET_GLOBAL_IPV4": "Global v4", + "C__OBJ__NET_GLOBAL_IPV6": "Global v6", + "C__OBJ__PERSON_API_SYSTEM": "Api System", + "C__OBJ__RACK_SEGMENT__4SLOT": "4-Slot", + "C__OBJ__RACK_SEGMENT__8SLOT": "8-Slot", + "C__OBJ__RACK_SEGMENT__2SLOT": "2-Slot" + } + } + } + ``` + +## idoit.license + +Displays information about the installed license. + +### Request parameters + +| Key | JSON data type | Required | Description | +| --------------- | -------------- | -------- | ----------- | +| **Placeholder** | Placeholder | Yes | Placeholder | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "idoit.license", + "params": { + "apikey": "{{apikey}}", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "objectCapacity": { + "total": 5002, + "inUse": 1 + }, + "addons": { + "iso27001": { + "licensed": true, + "label": "i-doit Add-on ISMS medium" + }, + "viva": { + "label": "VIVA", + "licensed": false + }, + "viva2": { + "licensed": true, + "label": "i-doit Add-on VIVA medium" + }, + "cmk2": { + "licensed": true, + "label": "i-doit Add-on Checkmk2" + }, + "document": { + "licensed": true, + "label": "i-doit Add-on Documents medium" + }, + ... + }, + "licenses": [ + { + "id": 2, + "label": "i-doit Add-on Checkmk2", + "licenseType": "Add-on", + "registrationDate": "2023-08-01 00:00:00", + "validUntil": "2023-08-31 00:00:00", + "objects": 0, + "tenants": 0, + "environment": "i-doit Eval", + "valid": true + }, + ... + ] + } + } + ``` + +## idoit.login + +Create new session with X-RPC-Auth headers. + +### Request parameters + +| Key | JSON data type | Required | Description | +| --- | -------------- | -------- | ----------- | +| - | - | - | - | + +### Response parameters + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| --------------- | -------------- | ------------------------------------------------------------------ | +| **result** | Boolean | Should be **true** | +| **userid** | String | Object identifier of logged-in user (as numeric string) | +| **name** | String | Object title of logged-in user | +| **mail** | String | Attribute **E-mail address** in category **Persons → Master Data** | +| **username** | String | Attribute **User name** in category **Persons → Login** | +| **session-id** | String | Generated session identifier | +| **client-id** | String | Tenant identifier (as numeric string) | +| **client-name** | String | Tenant name | + +### Example + +=== "Request body with set header" + + ``` + X-RPC-Auth-Username: admin + X-RPC-Auth-Password: admin + ``` + + ```json + { + "version": "2.0", + "method": "idoit.login", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body with header" + + ``` + X-RPC-Auth-Session: d1obs9m3d2pd8651grptjhdjg3 + ``` + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "result": true, + "userid": "9", + "name": "admin ", + "mail": "", + "username": "admin", + "session-id": "d1obs9m3d2pd8651grptjhdjg3", + "client-id": 1, + "client-name": "KnowledgeBase" + } + } + ``` + +## idoit.logout + +Close current session + +### Request parameters + +| Key | JSON data type | Description | +| --- | -------------- | ----------- | +| - | - | - | + +### Response parameters + +JSON key **result** contains a JSON object. + +| Key | JSON data type | Description | +| ------- | -------------- | --------------------------------- | +| message | String | Should be **"Logout successful"** | +| result | Boolean | Should be **true** | + +### Example + +See method [idoit.login](#idoitlogin) before. + +=== "Request body" + + ``` + X-RPC-Auth-Session: d1obs9m3d2pd8651grptjhdjg3 + ``` + + ```json + { + "version": "2.0", + "method": "idoit.logout", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 3 + } + ``` + +=== "Response body" + + ``` + X-RPC-Auth-Session: d1obs9m3d2pd8651grptjhdjg3 + ``` + + ```json + { + "jsonrpc": "2.0", + "result": { + "message": "Logout successful", + "result": true + }, + "id": 3 + } + ``` + +## idoit.search + +[Search](../../../../effizientes-dokumentieren/suche.md) in i-doit + +### Request parameters + +| Key | JSON data typ | Required | Description | +| ----- | ------------- | -------- | ------------------------------------------ | +| **q** | String | Yes | Query, for example: **"My little server"** | + +### Response parameters + +JSON key **result** contains an array of JSON objects. Each object contains a search result. + +| Key | JSON data type | Description | +| -------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **documentID** | String | Identifier | +| **key** | String | Attribute which relates to query | +| **value** | String | Value which relates to query | +| **type** | String | Add-on or core feature | +| **link** | String | Relative URL which directly links to search result | +| **score** | Integer | Scoring (deprecated) | +| **status** | String | Object status:

***C__RECORD_STATUS__BIRTH
Status-ID = 1
Title =****Unfinished**
* **C__RECORD_STATUS__NORMAL
Status-ID = 2**
**Title = ****Normal**
* **C__RECORD_STATUS__ARCHIVED
Status-ID = 3**
**Title =** **Archived**
* **C__RECORD_STATUS__DELETED
Status-ID = 4**
**Title =** **Deleted**
* **C__RECORD_STATUS__TEMPLATE
Status-ID = 6**
**Title =** **Template**
* **C__RECORD_STATUS__MASS_CHANGES_TEMPLATE
Status-ID = 7**
**Title =** **Mass change template** | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "idoit.search", + "params": { + "q": "My little server", + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": [ + { + "documentId": "1000", + "key": "Virtual Host > Global > Title", + "value": "My little server", + "type": "cmdb", + "link": "/?objID=1000&catgID=1&cateID=1029&highlight=My%20little%20server", + "score": "100", + "status": "Normal" + }, + […] + ], + } + ``` + +## idoit.version + +Fetch information about i-doit and the current user + +### Request parameters + +| Key | JSON data type | Description | +| --- | -------------- | ----------- | +| - | - | - | + +### Response parameters + +JSON key **result** contains an JSON object with various information about i-doit itself and the current user. + +| Key | JSON data type | Description | +| ------------------ | -------------- | ------------------------------------------------------------------------------- | +| **login** | Array | Information about the user who has performed the request; see below for details | +| **login.userid** | String | Object identifier (as numeric string) | +| **login.name** | String | Object title | +| **login.mail** | String | E-mail address (see category **Persons → Master Data**) | +| **login.username** | String | User name (see category **Persons → Login**) | +| **login.mandator** | String | Tenant name | +| **login.language** | String | Language: **"en"** or **"de"** | +| **version** | String | Version of installed i-doit | +| **step** | String | Dev, alpha or beta release | +| **type** | String | Release variant: **"OPEN"** or **"PRO"** | + +### Example + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "idoit.version", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "login": { + "userid": "9", + "name": "admin ", + "mail": "", + "username": "admin", + "tenant": "KnowledgeBase", + "language": "en" + }, + "version": "25", + "step": "", + "type": "PRO" + } + } + ``` diff --git a/docs/de/i-doit-add-ons/api/methoden/v1/index.md b/docs/de/i-doit-add-ons/api/methoden/v1/index.md index 405e0909..d24e535c 100644 --- a/docs/de/i-doit-add-ons/api/methoden/v1/index.md +++ b/docs/de/i-doit-add-ons/api/methoden/v1/index.md @@ -1,6 +1,8 @@ # API Methoden -In diesem Artikel erläutern wir die i-doit [JSON-RPC API](../../index.md) im Detail. Wenn Sie wissen wollen, welche Parameter für jede Methode gesetzt werden müssen/können und wie eine typische Antwort aussieht, ist dies die richtige Ressource. +In dieser Sektion erläutern wir die i-doit [JSON-RPC API](../../index.md). Wenn Sie wissen wollen, welche Parameter für die jeweilige Methode gesetzt werden müssen/können und wie eine typische Antwort aussieht, ist dies die richtige Ressource. + +Einige Beispiele findest du hier. Mehr Informationen zu jeder Methode ist auf der jeweiligen Seite zu finden. ## Namespace [idoit] @@ -8,197 +10,197 @@ Dieser Namensraum ist für gängige Methoden reserviert. ### idoit.search -??? example "idoit.search" +Über die API suchen - Suchen in i-doit +#### Anfrage Parameter - **Anfrage Parameter** +| Key | JSON Datentyp | Erforderlich | Beschreibung | +| ----- | ------------- | ------------ | --------------------------------------------- | +| **q** | String | Ja | Abfrage, zum Beispiel: **"My little server"** | - | Key | JSON Datentyp | Erforderlich | Beschreibung | - | ----- | ------------- | ------------ | --------------------------------------------- | - | **q** | String | Ja | Abfrage, zum Beispiel: **"My little server"** | +#### Antwort - **Antwort** +JSON-Schlüsselergebnis enthält ein Array von JSON-Objekten. Jedes Objekt enthält ein Suchergebnis. - JSON-Schlüsselergebnis enthält ein Array von JSON-Objekten. Jedes Objekt enthält ein Suchergebnis. +| Key | JSON Datentyp | Beschreibung | +| -------------- | ------------- | ------------------------------------------------ | +| **documentID** | String | Identifikationsnummer | +| **key** | String | Attribut, das sich auf die Abfrage bezieht | +| **value** | String | Wert, der sich auf die Abfrage bezieht | +| **type** | String | [Add-on](../../index.md) oder Kernfunktionalität | +| **link** | String | Relative URL, die direkt zum Suchergebnis führt | +| **score** | Integer | Punktevergabe (veraltet) | - | Key | JSON Datentyp | Beschreibung | - | -------------- | ------------- | ------------------------------------------------ | - | **documentID** | String | Identifikationsnummer | - | **key** | String | Attribut, das sich auf die Abfrage bezieht | - | **value** | String | Wert, der sich auf die Abfrage bezieht | - | **type** | String | [Add-on](../../index.md) oder Kernfunktionalität | - | **link** | String | Relative URL, die direkt zum Suchergebnis führt | - | **score** | Integer | Punktevergabe (veraltet) | +#### Anfrage - **Anfrage**
- Body: +Body: - ```json - { - "version": "2.0", - "method": "idoit.search", - "params": { - "q": "My little server", - "apikey": "xxx", - "language": "en" - }, - "id": 1 - } - ``` +```json +{ + "version": "2.0", + "method": "idoit.search", + "params": { + "q": "My little server", + "apikey": "xxx", + "language": "en" + }, + "id": 1 +} +``` - **Antwort**
- Body: +#### Antwort - ```json - { - "jsonrpc": "2.0", - "result": [ - { - "documentId": "1000", - "key": "Virtual Host > Global > Title", - "value": "My little server", - "type": "cmdb", - "link": "/?objID=1000&catgID=1&cateID=1029&highlight=My%20little%20server", - "score": 0 - }, - […] - ], - "id": 1 - } - ``` +Body: + +```json +{ + "jsonrpc": "2.0", + "result": [ + { + "documentId": "1000", + "key": "Virtual Host > Global > Title", + "value": "My little server", + "type": "cmdb", + "link": "/?objID=1000&catgID=1&cateID=1029&highlight=My%20little%20server", + "score": 0 + }, + […] + ], + "id": 1 +} +``` ### idoit.version -??? example "idoit.version" +Informationen über i-doit und den aktuellen Benutzer abrufen - Informationen über i-doit und den aktuellen Benutzer abrufen +#### Anfrage Parameter - Anfrage Parameter +Keine - Keine +#### Antwort - Antwort +Das JSON-Schlüsselergebnis enthält ein JSON-Objekt mit verschiedenen Informationen über i-doit selbst und den aktuellen Benutzer. - Das JSON-Schlüsselergebnis enthält ein JSON-Objekt mit verschiedenen Informationen über i-doit selbst und den aktuellen Benutzer. - - | Key | JSON Datentyp | Beschreibung | - | ------------------ | ------------- | ------------------------------------------------------------------------------------------- | - | **login** | Array | Informationen über den Benutzer, der die Anfrage durchgeführt hat; Einzelheiten siehe unten | - | **login.userid** | String | Objekt-Identifikator (als numerische Zeichenfolge) | - | **login.name** | String | ObjektBezeichnung | - | **login.mail** | String | E-Mail-Adresse (siehe Kategorie Personen → Stammdaten) | - | **login.username** | String | Benutzername (siehe Kategorie Personen → Login) | - | **login.tenant** | String | Name des Mandanten | - | **login.language** | String | Sprache: "en" oder "de" | - | **version** | String | Version des installierten i-doit | - | **step** | String | Dev, alpha oder beta release | - | **type** | String | Variante: "OPEN" oder "PRO". | +| Key | JSON Datentyp | Beschreibung | +| ------------------ | ------------- | ------------------------------------------------------------------------------------------- | +| **login** | Array | Informationen über den Benutzer, der die Anfrage durchgeführt hat; Einzelheiten siehe unten | +| **login.userid** | String | Objekt-Identifikator (als numerische Zeichenfolge) | +| **login.name** | String | ObjektBezeichnung | +| **login.mail** | String | E-Mail-Adresse (siehe Kategorie Personen → Stammdaten) | +| **login.username** | String | Benutzername (siehe Kategorie Personen → Login) | +| **login.tenant** | String | Name des Mandanten | +| **login.language** | String | Sprache: "en" oder "de" | +| **version** | String | Version des installierten i-doit | +| **step** | String | Dev, alpha oder beta release | +| **type** | String | Variante: "OPEN" oder "PRO". | - Beispiel +#### Anfrage - **Anfrage**
- Body: +Body: - ```json - { - "version": "2.0", - "method": "idoit.version", - "params": { - "apikey": "xxx", - "language": "en" - }, - "id": 1 - } - ``` +```json +{ + "version": "2.0", + "method": "idoit.version", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 +} +``` - **Antwort**
- Body: +#### Antwort - ```json - { - "jsonrpc": "2.0", - "result": { - "login": { - "userid": "9", - "name": "i-doit Systemadministrator ", - "mail": "i-doit@acme-it.example", - "username": "admin", - "mandator": "ACME IT Solutions", - "language": "en" - }, - "version": "1.10.2", - "step": "", - "type": "PRO" +Body: + +```json +{ + "jsonrpc": "2.0", + "result": { + "login": { + "userid": "9", + "name": "i-doit Systemadministrator ", + "mail": "i-doit@acme-it.example", + "username": "admin", + "mandator": "ACME IT Solutions", + "language": "en" }, - "id": 1 - } - ``` + "version": "1.10.2", + "step": "", + "type": "PRO" + }, + "id": 1 +} +``` ### idoit.constants -??? example "idoit.constants" +Abrufen definierter Konstanten aus i-doit - Abrufen definierter Konstanten aus i-doit +#### Anfrage Parameter - Anfrage Parameter +Keine - Keine +#### Antwort - Antwort +JSON-Schlüsselergebnis enthält ein JSON-Objekt. - JSON-Schlüsselergebnis enthält ein JSON-Objekt. +| Key | JSON Datentyp | Beschreibung | +| ---------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- | +| **objectTypes** | Object | Liste der Objekttypen

Schlüssel: Objekttyp-Konstanten

Werte: Bezeichnung der übersetzten Objekttypen | +| **categories** | Object | Liste der globalen und spezifischen Kategorien | +| **categories.g** | Object | Liste der globalen Kategorien

Schlüssel: Kategorie-Konstanten

Werte: übersetzte Kategorie Bezeichnung | +| **categories.s** | Object | Liste spezifischer Kategorien

Schlüssel: Kategorie-Konstanten

Werte: übersetzte Kategorie Bezeichnung | - | Key | JSON Datentyp | Beschreibung | - | ---------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- | - | **objectTypes** | Object | Liste der Objekttypen

Schlüssel: Objekttyp-Konstanten

Werte: Bezeichnung der übersetzten Objekttypen | - | **categories** | Object | Liste der globalen und spezifischen Kategorien | - | **categories.g** | Object | Liste der globalen Kategorien

Schlüssel: Kategorie-Konstanten

Werte: übersetzte Kategorie Bezeichnung | - | **categories.s** | Object | Liste spezifischer Kategorien

Schlüssel: Kategorie-Konstanten

Werte: übersetzte Kategorie Bezeichnung | +#### Anfrage - Beispiel - **Anfrage**
- Body: - ``` - { - "version": "2.0", - "method": "idoit.constants", - "params": { - "apikey": "xxx", - "language": "en" +Body: + +```json +{ + "version": "2.0", + "method": "idoit.constants", + "params": { + "apikey": "xxx", + "language": "en" + }, + "id": 1 +} +``` + +#### Antwort + +Body: + +```json +{ + "jsonrpc": "2.0", + "result": { + "objectTypes": { + "C__OBJTYPE__SERVER": "Server", + […] }, - "id": 1 - } - ``` - **Antwort** -
Body: - ``` - { - "jsonrpc": "2.0", - "result": { - "objectTypes": { - "C__OBJTYPE__SERVER": "Server", + "categories": { + "g": { + "C__CATG__GLOBAL": "General", + "C__CATG__MODEL": "Model", […] }, - "categories": { - "g": { - "C__CATG__GLOBAL": "General", - "C__CATG__MODEL": "Model", - […] - }, - "s": { - "C__CATS__MONITOR": "Monitor", - […] - } + "s": { + "C__CATS__MONITOR": "Monitor", + […] } - }, - "id": 1 - } - ``` + } + }, + "id": 1 +} +``` ### idoit.login -??? example "idoit.login" +??? example "idoit.login (Zum aufklappen anklicken)" Neue Sitzung erstellen @@ -333,7 +335,7 @@ Dieser Namensraum ist für gängige Methoden reserviert. { "jsonrpc": "2.0", "result": { - "message": "Logout successfull", + "message": "Logout successful", "result": true }, "id": 3 @@ -342,7 +344,7 @@ Dieser Namensraum ist für gängige Methoden reserviert. ### idoit.logout -??? example "idoit.logout" +??? example "idoit.logout (Zum aufklappen anklicken)" Aktuelle Sitzung schließen Anfrage Parameter @@ -353,10 +355,10 @@ Dieser Namensraum ist für gängige Methoden reserviert. JSON-Schlüsselergebnis enthält ein JSON-Objekt. - | Key | JSON Datentyp | Beschreibung | - | ------- | ------------- | ------------------------------------ | - | message | String | Sollte **"Logout successfull" **sein | - | result | Boolean | Sollte **true **sein | + | Key | JSON Datentyp | Beschreibung | + | ------- | ------------- | ----------------------------------- | + | message | String | Sollte **"Logout successful" **sein | + | result | Boolean | Sollte **true **sein | Beispiel @@ -369,7 +371,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.create -??? example "cmdb.object.create" +??? example "cmdb.object.create (Zum aufklappen anklicken)" Erstelle ein neues Objekt mit einigen optionalen Informationen @@ -418,7 +420,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "id": "42", - "message": "Object was successfully created", + "message": "Object was successfuly created", "success": true }, "id": 1 @@ -427,7 +429,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.read -??? example "cmdb.object.read" +??? example "cmdb.object.read (Zum aufklappen anklicken)" Lesen Sie allgemeine Informationen über eine Objekt @@ -497,7 +499,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.update -??? example "cmdb.object.update" +??? example "cmdb.object.update (Zum aufklappen anklicken)" Objekt ändern, z.B. Bezeichnung eines Objekts @@ -512,10 +514,10 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan JSON-Schlüsselergebnis enthält ein JSON-Objekt. - | Key | JSON Datentyp | Beschreibung | - | ----------- | ------------- | --------------------------------------------------- | - | **message** | String | Sollte "Object title was successfully updated" sein | - | **success** | Boolean | Sollte true sein | + | Key | JSON Datentyp | Beschreibung | + | ----------- | ------------- | -------------------------------------------------- | + | **message** | String | Sollte "Object title was successfuly updated" sein | + | **success** | Boolean | Sollte true sein | Beispiel @@ -540,7 +542,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan { "jsonrpc": "2.0", "result": { - "message": "Object title was successfully updated", + "message": "Object title was successfuly updated", "success": true }, "id": 1 @@ -549,7 +551,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.delete -??? example "cmdb.object.delete" +??? example "cmdb.object.delete (Zum aufklappen anklicken)" Löscht ein Objekt @@ -587,7 +589,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan { "jsonrpc": "2.0", "result": { - "message": "Object(s) successfully archived!", + "message": "Object(s) successfuly archived!", "success": true }, "id": 1 @@ -596,7 +598,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.recycle -??? example "cmdb.object.recycle" +??? example "cmdb.object.recycle (Zum aufklappen anklicken)" Wiederherstellen eines Objekts @@ -646,7 +648,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.archive -??? example "cmdb.object.archive" +??? example "cmdb.object.archive (Zum aufklappen anklicken)" [Archiviert](../../../../grundlagen/lebens-und-dokumentationszyklus.md) ein Objekt @@ -695,7 +697,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.purge -??? example "cmdb.object.purge" +??? example "cmdb.object.purge (Zum aufklappen anklicken)" [Löscht](../../../../grundlagen/lebens-und-dokumentationszyklus.md) ein Objekt @@ -745,7 +747,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.markAsTemplate -??? example "cmdb.object.markAsTemplate" +??? example "cmdb.object.markAsTemplate (Zum aufklappen anklicken)" Setze den Objekt Zustand auf [Vorlage](../../../../effizientes-dokumentieren/templates.md) @@ -795,7 +797,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.object.markAsMassChangeTemplate -??? example "cmdb.object.markAsMassChangeTemplate" +??? example "cmdb.object.markAsMassChangeTemplate (Zum aufklappen anklicken)" Setze den Objekt Zustand auf [Massenänderung](../../../../effizientes-dokumentieren/massenaenderung.md) [Template](../../../../effizientes-dokumentieren/templates.md) @@ -845,7 +847,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.objects.read -??? example "cmdb.objects.read" +??? example "cmdb.objects.read (Zum aufklappen anklicken)" Hole eine Liste von Objekten @@ -945,7 +947,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.category.save -??? example "cmdb.category.save" +??? example "cmdb.category.save (Zum aufklappen anklicken)" Kategorieeintrag eines Objekts erstellen oder aktualisieren. @@ -999,7 +1001,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Category entry successfully saved", + "message": "Category entry successfuly saved", "entry": 35 } } @@ -1033,7 +1035,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Category entry successfully saved", + "message": "Category entry successfuly saved", "entry": 24 } } @@ -1041,7 +1043,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.category.create -??? example "cmdb.category.create" +??? example "cmdb.category.create (Zum aufklappen anklicken)" Einen neuen Kategorieeintrag erstellen @@ -1092,7 +1094,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "id": "123", - "message": "Category entry successfully created.", + "message": "Category entry successfuly created.", "success": true }, "id": 1 @@ -1101,7 +1103,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.category.read -??? example "cmdb.category.read" +??? example "cmdb.category.read (Zum aufklappen anklicken)" Lesen Sie einen oder mehrere Kategorieeinträge für ein Objekt @@ -1188,7 +1190,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.category.update -??? example "cmdb.category.update" +??? example "cmdb.category.update (Zum aufklappen anklicken)" Kategorieeintrag eines Objekts aktualisieren @@ -1205,10 +1207,10 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan JSON-Schlüsselergebnis enthält ein JSON-Objekt. - | Key | JSON Datentyp | Beschreibung | - | ----------- | ------------- | --------------------------------------------------------- | - | **success** | Boolean | Sollte true sein | - | **message** | String | Sollte "**Category entry successfully** **saved**" lauten | + | Key | JSON Datentyp | Beschreibung | + | ----------- | ------------- | -------------------------------------------------------- | + | **success** | Boolean | Sollte true sein | + | **message** | String | Sollte "**Category entry successfuly** **saved**" lauten | Beispiel @@ -1237,7 +1239,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Category entry successfully saved" + "message": "Category entry successfuly saved" }, "id": 1 } @@ -1245,7 +1247,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.category.delete -??? example "cmdb.category.delete" +??? example "cmdb.category.delete (Zum aufklappen anklicken)" Einen Kategorieeintrag für ein Objekt archivieren, als gelöscht markieren oder aus der Datenbank bereinigen @@ -1298,7 +1300,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Category entry '3' successfully deleted" + "message": "Category entry '3' successfuly deleted" }, "id": 1 } @@ -1306,7 +1308,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.category.quickpurge -??? example "cmdb.category.quickpurge" +??? example "cmdb.category.quickpurge (Zum aufklappen anklicken)" Wenn [Quickpurge](../../../../grundlagen/objekt-liste/erweiterte-einstellungen.md) aktiviert ist, bereinigen Sie einen Kategorieeintrag eines Objekts direkt aus der Datenbank. @@ -1352,7 +1354,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Category entry '3' successfully purged" + "message": "Category entry '3' successfuly purged" }, "id": 1 } @@ -1360,7 +1362,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.category.purge -??? example "cmdb.category.purge" +??? example "cmdb.category.purge (Zum aufklappen anklicken)" Bereinigen eines Kategorieeintrags eines Objekts. Es funktioniert bei multi-value Kategorien und single-value Kategorien. @@ -1408,7 +1410,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Entry 33 has been successfully purged from 4 to 5." + "message": "Entry 33 has been successfuly purged from 4 to 5." } } ``` @@ -1439,14 +1441,14 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Entry 24 has been successfully purged from 2 to 5." + "message": "Entry 24 has been successfuly purged from 2 to 5." } } ``` ### cmdb.category.recycle -??? example "cmdb.category.recycle" +??? example "cmdb.category.recycle (Zum aufklappen anklicken)" Einschränkungen @@ -1496,14 +1498,14 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Entry 32 has been successfully recycled from 4 to 2." + "message": "Entry 32 has been successfuly recycled from 4 to 2." } } ``` ### cmdb.category.archive -??? example "cmdb.category.archive" +??? example "cmdb.category.archive (Zum aufklappen anklicken)" Limitations @@ -1553,14 +1555,14 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan "jsonrpc": "2.0", "result": { "success": true, - "message": "Entry 32 has been successfully archived from 2 to 3." + "message": "Entry 32 has been successfuly archived from 2 to 3." } } ``` ### cmdb.dialog.read -??? example "cmdb.dialog.read" +??? example "cmdb.dialog.read (Zum aufklappen anklicken)" Lese die Dialoginformationen. @@ -1621,7 +1623,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.dialog.create -??? example "cmdb.dialog.create" +??? example "cmdb.dialog.create (Zum aufklappen anklicken)" Dialoge erstellen @@ -1675,7 +1677,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.dialog.update -??? example "cmdb.dialog.update" +??? example "cmdb.dialog.update (Zum aufklappen anklicken)" Einen [Dialogeintrag](../../../../grundlagen/dialog-admin.md) aktualisieren @@ -1731,7 +1733,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.dialog.delete -??? example "cmdb.dialog.delete" +??? example "cmdb.dialog.delete (Zum aufklappen anklicken)" Löscht Dialoge @@ -1785,7 +1787,7 @@ Dieser Namensraum bezieht sich auf alle CMDB-spezifischen Methoden wie die Behan ### cmdb.reports.read -??? example "cmdb.reports.read" +??? example "cmdb.reports.read (Zum aufklappen anklicken)" Bericht anzeigen. diff --git a/docs/en/i-doit-add-ons/api/methods/addons.md b/docs/en/i-doit-add-ons/api/methods/addons.md index b225243c..7e7280d1 100644 --- a/docs/en/i-doit-add-ons/api/methods/addons.md +++ b/docs/en/i-doit-add-ons/api/methods/addons.md @@ -14,9 +14,9 @@ lang: en ### Request parameters -| Key | JSON data typ | Required | Description | -| --- | --- | --- | --- | -| **profileId** | Integer | Yes | Profile identifier, for example: 1 | +| Key | JSON data typ | Required | Description | +| ------------- | ------------- | -------- | ---------------------------------- | +| **profileId** | Integer | Yes | Profile identifier, for example: 1 | !!! example "WIP" @@ -24,10 +24,10 @@ lang: en 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 | + | Key | JSON data type | Description | + | --------------- | -------------- | ----------- | + | **Placeholder** | Placeholder | Placeholder | + | **Placeholder** | Placeholder | Placeholder | ### Example @@ -58,3 +58,101 @@ lang: en } } ``` + +## Documents + +### document.documents.read + +#### Request parameters + +| Key | JSON data typ | Required | Description | +| --------- | ------------- | ------------ | ----------------------------------- | +| **docID** | Integer | Yes or objID | Document identifier, for example: 1 | +| **objID** | Integer | Yes or docID | Object identifier, for example: 1 | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "document.documents.read", + "params": { + "apikey": "h3md6u3y", + "language": "en", + "docID": 1337 + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + + } + } + ``` + +### document.documents.delete + +| Key | JSON data typ | Required | Description | +| ---------- | ------------- | -------- | ----------------------------------- | +| **delete** | Integer | Yes | Document identifier, for example: 1 | + +!!! example "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 + +=== "Request body" + + ```json + { + "version": "2.0", + "method": "document.documents.read", + "params": { + "apikey": "h3md6u3y", + "language": "en", + "docID": 1337 + }, + "id": 1 + } + ``` + +=== "Response body" + + ```json + { + "id": 1, + "jsonrpc": "2.0", + "result": { + "message": "Document successfully deleted.", + "success": true + } + } + ```