Zeitplan-Import-API

Liefert eine Tabelle mit den Spalten, die ein Zeitplan-Import liest, und drei Beispielzeilen (ein Bildschirmcode, ein Bildschirmordner und ein Tag) als CSV oder, mit format=xlsx, als XLSX-Arbeitsmappe.

Liest eine Tabelle mit Zeitplanzeilen gegen das Projekt und liefert, was ihr Commit bewirken würde, ohne etwas zu schreiben.

Jede Zeile nennt ein Ziel (einen Bildschirm per ID, per Wert eines Bildschirmfelds wie eines Raumcodes oder per Namen; folder:NAME; tag:NAME; mehrere getrennt durch ; oder |), Inhalt (einen Mediendateinamen oder playlist:NAME oder eine Playlist-ID), einen Beginn und ein Ende (ein Datum allein als Ende schließt diesen Tag) und optional timezone, days (Mon-Fri), ein Tagesfenster (daily_start, daily_end), priority 0 bis 100, einen Namen und Display-Nummern.

Zeiten werden auf der eigenen Uhr jedes Bildschirms gelesen; eine timezone-Spalte rechnet sie aus einer anderen Zone um.

Jede Zeile wird geprüft und meldet ihre Fehler nach Spalte: unbekannter oder mehrdeutiger Bildschirm, Ordner oder Tag, fehlende oder mehrdeutige Datei, eine Datei, die einen Bildschirm nicht füllen kann, ungültige oder umgekehrte Zeiten, ein Ende in der Vergangenheit, keine Zeitangabe, ein Bildschirm ohne Zeitzone oder Standard-Playlist, zwei Zeilen, die auf einem Bildschirm gleichzeitig mit derselben Priorität gelten, und mehr Ebenen, als ein Bildschirm fasst (32), oder mehr Kampagnen, als seine Organisation über alle ihre Projekte fasst (100; jede gemeinsame Ebene ist eine davon).

Zeilen, die in Inhalt, Zeiten, Priorität und Name übereinstimmen, werden zu einer Ebene: Ein Bildschirm ist ein Eintrag im eigenen Zeitplan dieses Bildschirms; mehrere Bildschirme, ein Ordner oder ein Tag sind eine gemeinsame Ebene (eine Kampagne), die Vorrang vor den eigenen Ebenen eines Bildschirms hat.

Die Antwort listet die Ebenen auf, mit dem, was ein Commit mit jeder tut (create, update, unchanged), die Ebenen, die ein früherer Lauf desselben Imports angelegt hat und die die Tabelle nicht mehr enthält (removals), die Stapel der Bildschirme, wie sie wären (calendar), und einen Fingerprint, der an den Commit gesendet wird. Die Tabelle besteht aus JSON-Zeilen, CSV oder XLSX, höchstens 5,000 Zeilen.

Für einen auf Bildschirme beschränkten Aufrufer nicht verfügbar (outside_screen_scope). Der Zeitplan-Import ist Teil des Enterprise-Plans; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. Die Vorlage ist in jedem Plan offen.

Führt einen in der Vorschau angezeigten Import als Commit aus: dieselbe Tabelle und der Fingerprint, den ihre Vorschau geliefert hat. Jede Ebene wird angelegt, aktualisiert oder entfernt, die Zeitpläne der Bildschirme und die gemeinsamen Ebenen werden in einer Transaktion geschrieben, und das Importereignis schedule.imported wird angehängt: Alle Zeilen werden angewendet oder keine.

Die Ein-Datei-Playlists, die die Dateien der Tabelle benötigen, werden zuerst angelegt (sie ändern nichts auf einem Bildschirm). Eine Tabelle, deren Zeilen Fehler haben, wird abgelehnt (schedule_import_invalid); ein Projekt, das sich seit der Vorschau geändert hat, oder Zeilen, die anders gelesen werden, werden abgelehnt (schedule_import_stale), und der Client ruft die Vorschau erneut auf.

Wird dieselbe Tabelle unter demselben Namen erneut importiert, ändert sich nichts; eine geänderte Zeile aktualisiert ihre Ebene, und eine entfernte Zeile entfernt ihre Ebene. Erfordert eine Person, die im Dashboard genehmigen kann, und für einen Agenten Zugangsdaten mit Schreibzugriff.

Ein Commit, der eine reservierte Kampagne aktualisieren oder löschen würde, wird mit reserved_item (403) beantwortet und schreibt nichts, es sei denn, eine Person, die genehmigen kann, führt den Commit aus.

Ein Commit, der einen geschützten Bildschirm erreicht, wird vollständig mit protected_target abgelehnt, auch wenn der Import keine levels hat, aber Importeinträge eines geschützten Bildschirms entfernt oder eine Import-Kampagne löscht, deren Zielgruppe einen solchen erreicht.

In einem Projekt mit geschützten Bildschirmordnern wird ein Commit, dessen Vorschau an einem Dienst scheitert, nicht am Blatt, mit dependency_unavailable beantwortet und schreibt nichts: Senden Sie dieselbe Anfrage nach kurzer Wartezeit erneut. Ein Validierungsfehler bei Blatt, Kampagne oder Bildschirm wird so beantwortet, wie es der Commit täte (invalid_request und die anderen oben genannten Probleme).

Für einen auf Bildschirme beschränkten Aufrufer nicht verfügbar. Der Zeitplan-Import ist Teil des Enterprise-Plans; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. Die Vorlage ist in jedem Plan offen.