Objecten, endpoints & veldnamen

Vier namen die je uit elkaar houdt

Het label is de naam die je in MANE ziet. De object-ID benoemt het type dossier. Het endpoint is de route naar die dossiers. Een veld-ID is de sleutel van een eigenschap binnen één dossier. Neem technische sleutels letterlijk over; verzin geen contact.email als de catalogus een andere sleutel geeft.

Onderdeel	Voorbeeld	Waarvoor
Label	Cliënten	Herkenbare naam in de interface.
Object-ID	contacts (alleen als jouw catalogus dit aangeeft)	Type dossier; kan afwijken van het label.
Endpoint	/api/v1/objects/contacts/records	De verzameling dossiers.
Record-ID	api_…	Eén specifieke cliënt.
Veldpad	properties["E-mail"]	De eigenschap in de JSON-body en respons.

De catalogus van jouw werkruimte

Open Instellingen → API & webhooks → Wat spreek je aan? Kies het object, zoek op veldnaam en kopieer het endpoint of JSON-pad. Je ziet veldtype, verplichte eigenschappen en eventuele omschrijving.

Via GET /schema ontvang je dezelfde inrichting. Iedere catalogusrij bevat id, name, endpoint, readScope, writeScope, attributes en fields. attributes zijn directe JSON-velden zoals name en status; fields zijn de ingerichte eigenschappen onder properties. Een specifiek object lees je via GET /objects/<object-id>.

De catalogus toont bruikbare basisattributen en alle ingerichte eigenschappen. Complexe financiële documentstructuren vragen daarnaast hun eigen documentvalidatie; de veldlijst is geen mogelijkheid om beschermd akkoord of een vastgelegde factuur te omzeilen.

Een cliënt of bedrijf benaderen

Relaties en eigen objecten staan onder /objects/<object-id>/records. GET /records is de brede verzameling en vereist records:read. De precieze relatie-object-ID vind je in jouw catalogus, niet in dit voorbeeld.

Als jouw object contacts heet en een veld-ID E-mail heeft, ziet een aanmaakbody er zo uit. Gebruik ook de verplichte velden van je eigen object. Neem properties als object op in JSON; zet niet letterlijk een veld met de naam properties.E-mail in de body.

json

{
  "name": "Fictieve cliënt",
  "properties": {
    "E-mail": "voorbeeld@example.com"
  }
}

javascript

// Voorbeeld: het eerste dossier uit een lijstantwoord
response.data[0].id
response.data[0].name
response.data[0].properties["E-mail"]

Standaardobjecten en eigen eigenschappen

Projecten en trajecten gebruiken allebei /projects. De naam van het werktype verandert je endpoint niet. Een projecttitel kun je direct schrijven als name. Ingerichte eigenschappen kun je ook via properties aanleveren. Stuur hetzelfde veld niet tweemaal met verschillende waarden.

GET-antwoorden kunnen bestaande opslagvelden zoals values en customValues bevatten. Gebruik voor jouw veldmapping properties: dat houdt de lees- en schrijfroute gelijk. customValues is geen toegestane schrijfbody; MANE bewaart de eigenschap na validatie op de juiste plek.

Typen en lege waarden

Tekst en e-mail zijn JSON-strings. Getallen zijn JSON-getallen, dus 1.5 en niet "1,5". Een checkbox is true of false. Een datum is YYYY-MM-DD. Een keuzelijst gebruikt een bestaande optie; multiselect is een array van bestaande opties. Een relation-veld verwijst naar een bestaand relatie-ID.

Een ontbrekend PATCH-veld blijft staan. Een expliciete lege waarde kan een niet-verplicht veld leegmaken. Een verplicht veld mag niet leeg worden. Gebruik bij lege tekst ""; verwacht niet dat null overal een apart opgeslagen type is.

Uren zijn decimale uren. Bedragseenheden zijn niet overal gelijk: amountCents en shippingCents zijn centen, terwijl de genoemde price, cost en invoice amount eurovelden zijn. Controleer de veldomschrijving en het dossiermodel.

Eigen objecten en verbanden

Je kunt eigen objecten en eigenschappen inrichten, bijvoorbeeld Installaties met serienummer en onderhoudsdatum. De nieuwe technische sleutel verschijnt in de catalogus en krijgt een eigen objectroute.

Kom je er niet uit? Stel Jerryt je vraag.