Objektarten
10 Endpunkte unter /api/rest/2.0
Object type definitions for custom objects
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 |
/object-types |
List all object-types |
POST |
/object-types |
Create a object-type |
POST |
/object-types/blueprint |
Import a object type from a blueprint |
GET |
/object-types/blueprint/schema |
Get the object type blueprint JSON Schema |
GET |
/object-types/{id} |
Get a object-type |
PUT |
/object-types/{id} |
Update a object-type |
PATCH |
/object-types/{id} |
Partially update a object-type |
DELETE |
/object-types/{id} |
Delete a object-type |
GET |
/object-types/{id}/blueprint |
Export a object type as a blueprint |
POST |
/object-types/{id}/blueprint |
Update a object type from a blueprint |
Felder
Diese Felder liefert die API zu Objektarten. 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 |
|---|---|---|
name |
string | Object type name/label |
token |
string | Internal table name token (tbl_object_{token}) |
mode |
string | Object mode: unique (1:1), single (1:n), multi (n:m), independant (no customer link) |
color |
string | Color code for visual identification |
sort |
integer | Sort order |
useObjectTitle |
boolean | Whether objects have a title field |
useObjectUser |
boolean | Whether objects have an assigned user |
requireObjectUser |
boolean | Whether object user is required |
useObjectAgent |
boolean | Whether objects use agent groups |
useCustomerUser |
boolean | Whether customer-object links have an assigned user |
useStateProgress |
boolean | Whether states have progress percentage |
useTypeProgress |
boolean | Whether types have progress percentage |
useSale |
boolean | Whether customer-object can link to sales |
saleRequired |
boolean | Whether sale link is required |
useMemo |
boolean | Whether objects have memo/notes feature |
useScreen |
boolean | Whether objects have detail screen |
useActionRemind |
boolean | Whether objects can link to actions/reminds |
relationUnique |
boolean | Whether customer-object relation must be unique per customer/object/relation |
searchIndex |
boolean | Whether objects are included in quick search |
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.