Kunden-Objekt-Verknüpfungen
6 Endpunkte unter /api/rest/2.0
Customer-object links
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/objects/{type_id}/customer-links |
List all customer-links |
POST |
/objects/{type_id}/customer-links |
Create a customer-link |
GET |
/objects/{type_id}/customer-links/{id} |
Get a customer-link |
PUT |
/objects/{type_id}/customer-links/{id} |
Update a customer-link |
PATCH |
/objects/{type_id}/customer-links/{id} |
Partially update a customer-link |
DELETE |
/objects/{type_id}/customer-links/{id} |
Delete a customer-link |
Felder
Diese Felder liefert die API zu Kunden-Objekt-Verknüpfungen. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
customer_id |
integer | Customer ID |
index_id |
integer | Object index ID (links to object entry) |
relation_id |
integer | Relation ID |
type_id |
integer | Type ID (must belong to relation_id) |
project_id |
integer | Customer project ID |
sale_id |
integer | Sale/opportunity ID (only present if the object type has "sale" enabled) |
user_id |
integer | Assigned user ID (only present if the object type has "customeruser" enabled) |
start_date |
date-time | Start date/time of assignment |
end_date |
date-time | End date/time of assignment |
created_at |
date-time | Creation timestamp |
created_by |
integer | Creator user ID |
updated_at |
date-time | Last update timestamp |
updated_by |
integer | Last updater user ID |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.