API - Data Dictionary (Endpoints)

Data Dictionary

In the MKG Client, the Data Dictionary module is available with information about the endpoints. This module can be accessed within the MKG Client by searching for "Data dictionary" in the search field at the top right corner.

Within the Data dictionary module, all endpoints are visible on the left side. After selecting an endpoint, various data are available on the right side such as:

- Fields
The fields that can be requested for the endpoint. It is important to note that all calculated fields (where the checkbox "Is database field" is unchecked) are only returned via the API once they are included in the FieldList.

- Collections
From an endpoint, it is possible to open an underlying collection. This collection always pertains to the selected item of the endpoint. For example, retrieving all debtors associated with a relation:
GET {{restUrl}}/Documents/rela/{{rela_num}}/rela_debi/

- API Actions
These are all actions within MKG that can be addressed via the API. Consider, for example, changing the status of a sales order line or reporting production quantities as complete.
In the module, the specific call for executing the action is documented. 

- Indexes
The primary key is particularly important here. It is necessary to request a specific record. For example, retrieving a specific article:
GET {{restUrl}}/Documents/arti/{{admi_num}}+{{arti_code}}