logo:8:api

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung		 Vorhergehende Überarbeitung
logo:8:api [2017/01/04 11:22] – Johannes Vogtlogo:8:api [2021/04/15 10:53] (aktuell) – Externe Bearbeitung 127.0.0.1
Zeile 8: Zeile 8:
 ^ Parameter ^ Default value ^ Beschreibung ^ Required ^ Beispiel ^ ^ Parameter ^ Default value ^ Beschreibung ^ Required ^ Beispiel ^
 | model |  | Das abzufragende Model | * | /api/columns?model=customer | | model |  | Das abzufragende Model | * | /api/columns?model=customer |
 +
 Mögliches Ergebnis: Mögliches Ergebnis:
 <code> <code>
 [ [
-  {"type":"integer","null":false,"limit":4, "name":"id"}, +  {"type":"integer", "null":false, "limit":4,  "name":"id"}, 
-  {"type":"string", "null":false,"limit":32,"name":"username"}, +  {"type":"string",  "null":false, "limit":32, "name":"username"}, 
-  {"type":"string", "null":true, "limit":64,"name":"first_name"}, +  {"type":"string",  "null":true,  "limit":64, "name":"first_name"}, 
-  {"type":"integer","null":false,"limit":4, "name":"eos_entity_id","reflection":"eos_entity"},+  {"type":"integer", "null":false, "limit":4,  "name":"eos_entity_id", "reflection":"eos_entity"},
   ...   ...
 ] ]
Zeile 20: Zeile 21:
 ^ Feld ^ Beschreibung ^ ^ Feld ^ Beschreibung ^
 | type | Typ des Feldes (String, Integer, ...) | | type | Typ des Feldes (String, Integer, ...) |
 +| null | Darf das Feld leer bleiben |
 | limit | Maximale Länge des Feldes | | limit | Maximale Länge des Feldes |
 | name | Name des Feldes | | name | Name des Feldes |
Zeile 36: Zeile 38:
 | 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 | | 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 | | 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:
 +<code>/api/f?model=customer&include[company]&limit=1</code>
 +<code>
 +[{
 +  "id":1,
 +  "company_id":2,
 +  "sporadic":false,
 +  "sale_type_id":null,
 +  "company":{
 +    "id":2
 +    "company_name":"Testkunde 1",
 +    "company_ext":null,
 +    "contact_frequency":90
 +  }
 +}]
 +</code>