Datenquellen-API

Listet die Quellen-Voreinstellungen auf: fertige, getestete Konfigurationen der json-Datenquelle (docs/sources.md, Presets). Jede nennt, welche Karten sie füllt, die Felder, die eine Person ausfüllt (mit Hilfe, einem Muster und einem Beispiel), die Secrets, die sie braucht, und wie man jedes erhält, wie oft sie aktualisiert und wie lange eine Karte ihre letzten Daten behält, und wessen Daten sie unter welchen Bedingungen liest.

Legen Sie mit POST /api/sources und preset, settings und secrets eine Datenquelle daraus an und sehen Sie sich mit POST /api/sources/test eine Vorschau an.

Eine Quellen-Voreinstellung, so wie die Liste sie zeigt.

Listet die Datenquellen des Projekts auf, die neuesten zuerst, höchstens 200 pro Seite. Eine Datenquelle hält die dynamischen Eigenschaften einer Karte nach Zeitplan aus einer externen Adresse aktuell (docs/sources.md). Jede Datenquelle zeigt ihren Status: den letzten Versuch, den letzten Erfolg, die letzte geschriebene Änderung, den nächsten Lauf, die Fehlerzahl und den letzten Fehler.

Geheimnisse werden nie zurückgegeben; jedes erscheint als gesetzt mit einem maskierten Hinweis. next_cursor wird als after für die nächste Seite zurückgegeben, null, wenn es keine weiteren gibt.

Legt eine Datenquelle an, die die dynamischen Eigenschaften einer Karte aus einer externen Adresse schreibt. kind wählt den Adapter (ics liest eine iCalendar- oder webcal://-Adresse); config enthält die Einstellungen der Art und secrets deren Zugangsdaten, die verschlüsselt gespeichert und nur als maskierter Hinweis angezeigt werden.

Oder nennen Sie eine Voreinstellung (GET /api/source-presets) und geben Sie deren settings und secrets statt kind und config an: Die Datenquelle ist eine json-Datenquelle, deren Konfiguration die Voreinstellung aufbaut, mit ihrem preset und ihren settings zurückgegeben, und Aktualisierungsintervall und Ablaufzeitraum übernehmen standardmäßig die der Voreinstellung. Eine Voreinstellung füllt nur die Karten, die sie auflistet (source_target_unsupported).

Die Datenquelle läuft innerhalb von Sekunden und danach alle refresh_seconds. Ein fehlgeschlagener Lauf schreibt nie: Die Karte behält ihr letztes gutes Dokument, und der Status der Datenquelle zeigt den Fehler. Eine Datenquelle füllt eine Karte (source_target_taken), die Karte muss eine sein, die die Art füllen kann (source_target_unsupported), und eine Organisation hat höchstens 200 Datenquellen (source_limit_reached).

Verwenden Sie zuerst POST /api/sources/test, um das Dokument zu sehen, das die Datenquelle schreiben würde. Hängt source.created an. Eine exakte Wiederholung mit demselben Idempotency-Key liefert vierundzwanzig Stunden lang dieselbe Antwort.

Zeigt eine Vorschau einer Datenquelle, ohne etwas zu speichern oder zu schreiben: ruft die Adresse ab, bereitet die Antwort für die Zielkarte auf und prüft das Dokument gegen die Karte, und liefert dann das Dokument, ob die Karte es akzeptiert (valid, mit validation_error, das andernfalls den Pfad nennt) sowie die Warnungen und Zähler des Laufs.

Übergeben Sie source_id, um eine gespeicherte Datenquelle mit den übrigen Mitgliedern als Überschreibungen zu testen (settings überschreiben die einer aus einer Voreinstellung erstellten Datenquelle); andernfalls sind target und entweder kind und config oder preset, settings und secrets erforderlich. Ein Geheimnis, das eine gespeicherte Datenquelle hält, wird wie gespeichert verwendet, es sei denn, die Überschreibung ändert, worauf es zeigt (source_secret_required).

Ein Abruf- oder Aufbereitungsfehler ist source_test_failed mit dem festen source_error. Höchstens 30 Vorschauen pro Minute und Organisation.

Eine Datenquelle mit ihrem Status. ETag ist die Revision, für If-Match bei der nächsten Änderung.

Ändert eine Datenquelle. config ersetzt die gesamte Konfiguration; secrets wird zusammengeführt (ein String setzt oder ersetzt eines, null entfernt es).

Eine aus einer Voreinstellung erstellte Datenquelle nimmt settings statt config: Jede genannte Einstellung ersetzt ihren Wert, null entfernt eine optionale, die übrigen behalten ihren, und die Konfiguration wird aus der Voreinstellung neu aufgebaut (config bei einer solchen Datenquelle ist invalid_request bei config, und settings bei einer anderen ist invalid_request bei settings). Ihre Geheimnisse werden so benannt, wie die Voreinstellung sie benennt.

Ein nicht gesendetes Geheimnis behält seinen Wert, es sei denn, die Änderung richtet die Datenquelle auf etwas, das sein gespeicherter Geltungsbereich nicht abdeckt (source_secret_required bei secrets.<name>: erneut eingeben).

Eine Änderung an Ziel, config, Geheimnissen, refresh_seconds oder enabled setzt die Fehlerzahl zurück und führt die Datenquelle innerhalb von Sekunden aus; eine Umbenennung nicht. enabled false hält den Zeitplan an und behält das letzte Dokument der Karte. If-Match schützt die Revision. Hängt source.updated an.

Löscht die Datenquelle. Die Karte behält das letzte Dokument, das die Datenquelle geschrieben hat. If-Match schützt die Revision. Hängt source.deleted an.

Die Raumzuordnung einer Datenquelle, die die Räume eines Buchungssystems liest (Art momentus): welche Räume sie anbietet, die kein Bildschirm anzeigt (summary.unmapped_rooms), und welche Bildschirme ein Raum- oder Bereichsdokument lesen, ohne einen Wert, der einen nennt (Bildschirme mit Status missing oder unknown, mit einem Vorschlag, wenn der Wert ein anders geschriebener Raum ist).

Die Räume sind die der letzten guten Aktualisierung der Quelle; es wird nichts abgerufen. Eine Art ohne Räume antwortet mit source_has_no_rooms.

Synchronisiert die Datenquelle sofort, inline (bis zu 60 Sekunden), und liefert sie mit ihrem neuen Status zurück. Eine fehlgeschlagene Synchronisierung antwortet mit 200, status.state error und dem Fehler; sie schreibt nie. Eine Aktualisierung beginnt von vorn: Die Fehlerzahl wird zurückgesetzt und die Adresse vollständig gelesen. source_busy (Retry-After), solange eine geplante Synchronisierung die Datenquelle hält.

Höchstens 6 Aktualisierungen pro Minute und Datenquelle.