-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #812 from i-doit/384-documents-api-method-is-missing
384-documents-api-method-is-missing
- Loading branch information
Showing
26 changed files
with
6,647 additions
and
211 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
134
docs/de/i-doit-add-ons/api/methoden/v1/cmdb.categories.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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": "[email protected]", | ||
| "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": "" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` |
Oops, something went wrong.