API - Data Dictionary (Endpoints)

Data Dictionary

In de MKG Client is de module Data dictionary beschikbaar met informatie over de endpoints. Deze module kan binnen de MKG Client geopend worden door in het zoekveld rechts bovenin te zoeken op "Data dictionary".

Binnen de module Data dictionary zijn aan de linkerzijde alle endpoints zichtbaar. Na selectie van een endpoint zijn vervolgens aan de rechterzijde diverse gegevens beschikbaar zoals:

- Velden
De velden welke opgevraagd kunnen worden voor het endpoint. Belangrijk hierbij is dat alle berekende velden (waar het vinkje "Is databaseveld" uit staat) alleen teruggeven worden via de API, zodra deze in de FieldList zijn opgenomen.

- Verzamelingen
Vanuit een endpoint is het mogelijk om een onderliggende verzameling te openen. Deze verzameling heeft altijd betrekking op het geselecteerde item van het endpoint. Bijvoorbeeld het opvragen van alle debiteuren behorend bij een relatie:
GET {{restUrl}}/Documents/rela/{{rela_num}}/rela_debi/

- API acties
Dit zijn alle acties binnen MKG welke via de API aangesproken kunnen worden. Denk hierbij aan bijvoorbeeld het wijzigen van een status van een verkooporderregel of het gereed melden van productieaantallen.
In de module is ook de specifieke aanroep.

- Indexen
Vooral de primary key is hierbij van belang. Deze is namelijk nodig om een specifiek record op te vragen. Bijvoorbeeld het opvragen een specifiek artikel:
GET {{restUrl}}/Documents/arti/{{admi_num}}+{{arti_code}}