Api

Tabellen-Felder abfragen

/api/columns

Parameter:

Parameter Default value Beschreibung Required Beispiel
model Das abzufragende Model * /api/columns?model=customer

Mögliches Ergebnis:

[
  {"type":"integer", "null":false, "limit":4,  "name":"id"},
  {"type":"string",  "null":false, "limit":32, "name":"username"},
  {"type":"string",  "null":true,  "limit":64, "name":"first_name"},
  {"type":"integer", "null":false, "limit":4,  "name":"eos_entity_id", "reflection":"eos_entity"},
  ...
]
Feld Beschreibung
type Typ des Feldes (String, Integer, …)
null Darf das Feld leer bleiben
limit Maximale Länge des Feldes
name Name des Feldes
reflection Bezug auf eine andere Tabelle (Relation)

Objekte abfragen

/api/f
Parameter Default value Beschreibung Required Beispiel
model Das abzufragende Model * /api/f?model=customer
limit 25 Das Limit der Ergebnisse /api/f?model=customer&limit=30
ids Die abzufragenden IDs (Komma-getrennt) /api/f?model=customer&ids=1,2,3
order Sortierung der Ergebnisse /api/f?model=customer&order=id desc
include Relations-Tabellen, welche hinzugefügt werden sollen /api/f?model=customer&include[company]
/api/f?model=customer&include[company][company_addresses]&include[documents]
select Felder, die Abgefragt werden sollen (Komma-getrennt) /api/f?model=customer&select[customer]=id
/api/f?model=customer&include[company]&select[company]=company_name,id
select_type In Verbindung mit „select“. Wie die Felder abgefragt werden sollen (exclude,only) /api/f?model=customer&select[customer]=id&select_type=only
/api/f?model=customer&select[customer]=id&select_type=exclude

Mögliches Ergebnis:

/api/f?model=customer&include[company]&limit=1
[{
  "id":1,
  "company_id":2,
  "sporadic":false,
  "sale_type_id":null,
  "company":{
    "id":2
    "company_name":"Testkunde 1",
    "company_ext":null,
    "contact_frequency":90
  }
}]