Request
URL-Endpunkt | https://<Cameleon-URL>/api/<Cameleon-Client-Id>/data/<Cameleon-Modulname> |
Methode | GET |
Header | { “x-access-token”: “<Cameleon-Anmeldetoken>”, } |
Body | – |
Query-Parameter (optional) | attributes=<Feld>,<Feld>,…|ALL_ATTRIBUTES offset=<Offset-Wert> limit=<Limit-Wert> sort=<Feld> order=desc|asc filter=<Filter 1> and <Filter 2> … |
Ein Filter setzt sich aus einem Feldnamen, einem Abfrageoperator sowie einem Wert zusammen. Abfrageoperatoren können in Abhängigkeit vom Feldtyp verwendet werden.
Abfrageoperator | Beschreibung | Feldtypen |
eq | entspricht | STRING, BOOLEAN, DOUBLE, DATE, DATETIME, INTEGER, TEXT |
like | enthält | STRING, TEXT |
notLike | enthält nicht | STRING, TEXT |
ne | entspricht nicht | STRING, BOOLEAN, DOUBLE, DATE, DATETIME, INTEGER, TEXT |
gt | größer als | DATE, DOUBLE, DATETIME, INTEGER |
gte | größer als oder gleich | DATE, DOUBLE, DATETIME, INTEGER |
lt | kleiner als | DATE, DOUBLE, DATETIME, INTEGER |
lte | kleiner als oder gleich | DATE, DOUBLE, DATETIME, INTEGER |
in | in | SELECT, ENUM, MULTISELECT |
notIn | nicht in | SELECT, ENUM, MULTISELECT |
Beispiele
https://<Cameleon-URL>/api/<Cameleon-Client-Id>/data/<Cameleon-Modulname>?filter=displayName like Incident |
https://<Cameleon-URL>/api/<Cameleon-Client-Id>/data/<Cameleon-Modulname>?filter=multiselect in ‘f2c9a0a0-bdaf-11ed-9aae-73ce0c0a48c3′,’1a12f590-bdaf-11ed-9aae-73ce0c0a48c3’ |
https://<Cameleon-URL>/api/<Cameleon-Client-Id>/data/<Cameleon-Modulname>?filter=createdAt gte 1656157305739 and createdAt lt 1656157305739 |
Response
Das System sendet die Anzahl der Datensätze sowie die Datensätze zurück.
Body | { “count”: “<Anzahl der Datensätze>”, “rows”: [{<Datensatz>},{<Datensatz>},…] } |