Mit den regulären API-Routen für den Abruf von Datensätzen kann ich zwar Datensätze für unterschiedliche Versionen abrufen (und damit auch einen gewissen Zeitraum eingrenzen). Möchte ich aber gezielt Datensätzen innerhalb bestimmter Zeiträume abrufen, helfen die Standardrouten hier nicht.
Genau für diesen Fall gibt es in der sogenannten Preview-API aber die Möglichkeit, nach Datumswerten zu filtern und damit die Suche gleich auf spezifizierbare Zeiträume zu beschränken. Aber wie genau geht das?
Zunächst einmal ist es erforderlich, dass wir uns für einen Datumswert entscheiden, denn ein Datensatz hat verschiedene Zeitstempel, nach denen wir filtern können (es kann auch nach mehreren, unterschiedlichen Zeitstempeln gleichzeitig gefiltert werden):
clientCreatedDate ist der Zeitpunkt, zu dem der Entwurf vom User auf dem Endgerät geöffnet wurde
sendDate ist der Zeitpunkt, zu dem der Datensatz vom User abgesendet wurde
recievedDate ist der Zeitpunkt, zu dem der Datensatz an den smapOne-Servern empfangen wurde
completedDate ist der Zeitpunkt, zu dem der Datensatz von den smapOne-Servern verarbeitet wurde (Daten gespeichert, alle Assets hochgeladen etc.)
lastExportDate zeigt den Zeitpunkt an, zu dem der Datensatz exportiert wurde (sofern er auch schon exportiert wurde, sonst null)
Und in der Preview-API kann ich nun nach Datensätzen suchen und hierbei den Zeitraum definieren, in dem die Datensätze liegen. Zum Beispiel im folgenden Fall einfach und simpel alle Datensätze, die nach dem 10. November um 11:05 Uhr (UTC) an der Plattform angekommen ("received") wurden. "gt" steht in hierbei für "greater than", sinngemäß "später als":
/Backend/preview/Smaps/{smapId}/Records?$filter=ReceivedDate gt 2020-11-10T11:05:00Z
Mit Hilfe dieser Filtermöglichkeiten in den API-Routen der Preview-API können also sehr gezielt Metadaten von smap-Daten gefiltert werden - in diesem Fall nach Zeitstempeln. Aber auch weitere Filtermöglichkeiten sind vorhanden. Weitere Beispiele können direkt in der Preview-API eingesehen werden.
zur Swagger-API-Dokumentation
zur FAQ: "Wie wähle ich in der Swagger API-Dokumentation die Preview-API aus?"
Falls ihr weitere Fragen zur Preview-API habt, haut sie gerne als Kommentare unter diesen Beitrag. Wenn es andersgeartete Fragen sind, macht gerne einen eigenen Beitrag hier im Forum auf.