Aktivitäten
6 Endpunkte unter /api/rest/2.0
Activity entries for customers
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 |
/actions |
List all actions |
POST |
/actions |
Create a action |
GET |
/actions/{id} |
Get a action |
PUT |
/actions/{id} |
Update a action |
PATCH |
/actions/{id} |
Partially update a action |
DELETE |
/actions/{id} |
Delete a action |
Felder
Diese Felder liefert die API zu Aktivitäten. 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 | Associated customer ID |
person_id |
integer | Associated person ID (0 if none) |
user_id |
integer | User ID who performed the action |
project_id |
integer | Associated project ID |
sale_id |
integer | Associated sale ID |
activity_id |
integer | Activity type ID (from tbl_activity) |
finding_id |
integer | Finding/result ID |
date |
date-time | Date and time of the activity |
subject |
string | Subject/title of the activity |
notice |
string | Detailed notes/description |
history_id |
integer | Related history entry ID |
sheet_data_id |
integer | Related sheet data ID |
matching_results_id |
integer | Related matching results ID |
created_at |
date-time | Creation timestamp |
created_by |
integer | ID of user who created the record |
updated_at |
date-time | Last modification timestamp |
updated_by |
integer | ID of user who last modified the record |
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.