Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

384-documents-api-method-is-missing #812

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

384-documents-api-method-is-missing #812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions config/de/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
160 changes: 160 additions & 0 deletions docs/de/i-doit-add-ons/api/methoden/v1/addons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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": {
<!--TODO-->
}
}
```

### 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
}
}
```
134 changes: 134 additions & 0 deletions docs/de/i-doit-add-ons/api/methoden/v1/cmdb.categories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.<br>
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": ""
}
}
}
}
```
Loading
Loading