Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Comment: Content imported from a Scroll Translations translation file.

...

Sv translation

language	de

MagicInfo-Server ermöglicht es Ihnen, Content Management, Terminmanagement, Gerätemanagement und andere Funktionen zu implementieren, indem Sie Open API (v2.0) aufrufen.

Für die Verwendung von Open API (v2.0) müssen Sie zuerst einen Authentifizierungsprozess durchlaufen. Verwenden Sie eine separate Swagger-Seite, um jedes einzelne API zu testen.

Authentifizierung

Beim Aufrufen aller Open API (v2.0)-Elemente muss api_token im Header enthalten sein. Wenn dies nicht enthalten ist, wird ein „401 Unauthorized“-Fehler zurückgegeben.

Ein erhaltener Token läuft nach einem bestimmten Zeitraum ab und wird nicht mehr verfügbar. In diesem Fall sollten Sie einen neuen Token erhalten.

api_token können durch Aufrufen der folgenden Api abgerufen werden.

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
authenticationRequest	/auth	POST	Importiert einen Token-Wert für die Authentifizierung unter Verwendung der Benutzer-ID und des Kennworts.
authenticationRequest	/auth/refresh	GET	Erstellt ein neues Token, um die Ablaufzeit zu verlängern. Es ist möglich, REST API aufzurufen, ohne sich erneut anzumelden

OPEN API (v2.0)

MagicInfo Server Open API (v2.0) bietet eine Vielzahl von Funktionen. Die Konfiguration der einzelnen Funktionen wird unten dargestellt.

Kategorie	Controller	Beschreibung
Inhalt	Inhalte-Controller	Content Management
Inhalt	Inhalte-Gruppe-Controller	Inhaltsgruppen-Verwaltung
Wiedergabeliste	Wiedergabeliste-Controller	Verwalten einer Wiedergabeliste
Wiedergabeliste	Wiedergabeliste-Gruppe-Controller	Wiedergabelistengruppen-Verwaltung
Zeitplan	Inhalte-Zeitplan-Controller	Inhaltszeitplan-Verwaltung
	Inhalte-Zeitplan-Gruppe-Controller	Inhaltszeitplan-Gruppenverwaltung
	Nachricht-Zeitplan-Controller	Verwalten von Nachrichtenzeitplänen
	Nachricht-Zeitplan-Gruppe-Controller	Nachrichten-Zeitplan-Gruppenverwaltung
Gerät	Gerät-Controller	Gerätemanagement
Gerät	Gerät-Gruppe-Controller	Gerätegruppen-Verwaltung
Benutzer	Benutzer-Controller	Benutzerverwaltung
Benutzer	Benutzer-Gruppe-Controller	Benutzergruppen-Verwaltung
Einstellung	Umgebung-Controller	Einstellung

Inhalt

Hochladen, Genehmigen oder Löschen von Inhalten. Verwalten von Inhaltsdateizeitplänen Inhaltsbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Inhalten zugänglich.

Die folgenden Inhaltsverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllContent	/restapi/v1.0/cms/contents	GET	Importiert eine Liste mit hochgeladenen Inhalten. In der Liste sind Inhalts-Miniaturen, Namen, Dateitypen und andere grundlegende Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Importiert allgemeine Inhaltsinformationen, die auf dem Dashboard angezeigt werden.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importiert eine Liste mit anhand der Bedingungen gefilterten Inhalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Löscht Inhalte, unabhängig davon, ob die Inhalte in einer Wiedergabeliste oder einem Zeitplan enthalten sind.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Löscht Inhalte, nachdem überprüft wurde, dass die Inhalte nicht in einer Wiedergabeliste oder einem Zeitplan enthalten sind. Wenn Sie versuchen, Inhalte zu löschen, die in einer Wiedergabeliste oder einem Zeitplan enthalten sind, werden die Inhalte nicht gelöscht und es wird ein Fehlercode zurückgegeben.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Importiert Details einer aktivierten Version von Inhalten. Die Version der Inhalte wird jedes Mal aktualisiert, wenn die Wiedergabeliste bearbeitet wird.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Genehmigt Inhalte/lehnt Inhalte ab. Genehmigte Inhalte werden in die allgemeine Inhaltsliste bewegt und können in Wiedergabelisten oder Zeitplänen verwendet werden.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Lädt neue Inhalte hoch.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importiert eine Liste der Standard-Inhaltsgruppen.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Wiedergabeliste

Verwenden Sie Inhalte zum Erstellen, Bearbeiten oder Löschen von Wiedergabelisten. Wiedergabelistenbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Inhalten zugänglich.

Die folgenden Wiedergabelistenverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importiert eine Liste mit allen Wiedergabelisten. In der Liste sind Namen von Wiedergabelisten, Miniaturen von Hauptinhalten, Typen von Wiedergabelisten und andere grundlegende Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Erstellt eine neue Wiedergabeliste.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importiert notwendige Wiedergabelisteninformationen vom Dashboard.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importiert eine Liste mit anhand der Bedingungen gefilterten Wiedergabelisten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Löscht die ausgewählte Wiedergabeliste. Wenn Sie versuchen, eine Wiedergabeliste zu löschen, die in einem Zeitplan enthalten ist, wird die Wiedergabeliste nicht gelöscht und es wird ein Fehlercode zurückgegeben.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Importiert Details einer aktivierten Version einer Wiedergabeliste. Die Version einer Wiedergabeliste wird jedes Mal aktualisiert, wenn die Wiedergabeliste bearbeitet wird.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Bearbeitet die {playlistId}-Wiedergabeliste. Das Bearbeiten einer Wiedergabeliste aktualisiert die Wiedergabelistenversion und bewirkt, dass das Gerät, das die Wiedergabeliste abspielt, die aktualisierte Wiedergabeliste automatisch abspielt.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Kopiert die {playlistId} Wiedergabeliste. Ein Duplikat der Wiedergabeliste wurde erstellt.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importiert eine Liste der Standard-Wiedergabelistengruppen.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Zeitplan

Neue Inhalte oder Nachrichtenzeitpläne erstellen. Zeitpläne an Geräte für die Wiedergabe übermitteln. Zeitpläne löschen oder bearbeiten.

Den Zeitplan betreffende Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Zeitplänen zugänglich.

Die folgenden Zeitplanverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importiert eine Liste aller Inhaltszeitpläne. In der Liste sind Namen von Inhaltszeitplänen, Erstellungsdaten und andere grundlegenden Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Erstellt einen neuen Inhaltszeitplan. Ein Inhaltszeitplan kann mehrere Kanäle und Rahmen enthalten. Einen Zeitplan an Geräte übermitteln und die gewünschten Inhalte oder die Wiedergabeliste zu einer bestimmten Zeit wiedergeben.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Importiert notwendige Inhaltszeitplaninformationen vom Dashboard.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Inhaltszeitplänen. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Löscht einen Inhaltszeitplan. Wenn ein Zeitplan gelöscht wird, der zuvor an ein Gerät übermittelt wurde, spielt das Gerät automatisch die Standard-Inhalte ab.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Importiert Details des ausgewählten Zeitplans.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Bearbeitet einen Inhaltszeitplan. Wenn ein Zeitplan bearbeitet wird, der zuvor an ein Gerät übermittelt wurde, spielt das Gerät automatisch den bearbeiteten Zeitplan ab.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Kopiert den {programId}-Inhaltszeitplan. Ein Duplikat des {programId}-Inhaltszeitplans wird erstellt.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Übermittelt einen Inhaltszeitplan an eine bestimmte Gerätegruppe.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Import den Echtzeit-Inhaltszeitplan-Downloadstatus von einem Gerät.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importiert eine Liste aller Nachrichtenzeitpläne.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Erstellt einen neuen Nachrichtenzeitplan.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Nachrichtenzeitpläne. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Löscht den ausgewählten Nachrichtenzeitplan. Wenn ein Nachrichtenzeitplan gelöscht wird, der zuvor an ein Gerät übermittelt wurde, wird die Änderung automatisch auf das Gerät angewendet.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Importiert Details des ausgewählten Nachrichtenzeitplans.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Bearbeitet den ausgewählten Nachrichtenzeitplan. Wenn ein Nachrichtenzeitplan bearbeitet wird, der zuvor an ein Gerät übermittelt wurde, wird die Änderung automatisch auf das Gerät angewendet.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Kopiert den ausgewählten Nachrichtenzeitplan. Ein Duplikat des Nachrichtenzeitplans wird erstellt.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Übermittelt den ausgewählten Nachrichtenzeitplan an eine Gerätegruppe.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter einer bestimmten Gruppe.

Gerät

Geräte steuern und verwalten. Gerätebezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Geräten zugänglich.

Die folgenden Geräteverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllDevice	/restapi/v1.0/rms/devices	GET	Importiert eine Liste mit allen Geräten. Gerät-Energieversorgungsstatus, Miniaturansichtsinformationen, Gerätefehlerstatus und andere grundlegende Informationen sind in der Liste enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Importiert notwendige Geräteinformationen aus dem Dashboard.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Geräten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Löscht das ausgewählte Gerät.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importiert Details des ausgewählten Geräts.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Genehmigt das ausgewählte Video für eine bestimmte Gruppe.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importiert Informationen über Schränke, die mit einem LED-Gerät verbunden sind. Die importierten Informationen gelten nur, wenn die Schränke mit einem LED-Gerät verbunden sind.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Bearbeitet Informationen über Schränke, die mit einem LED-Gerät verbunden sind.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importiert Geräteanzeigesteuerungsinformationen aus der Datenbank. Falls keine Steuerungsinformationen vorhanden sind, sollte eine Informationsanfrage an das Gerät gesendet werden.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Sendet bearbeitete Anzeigesteuerungsinformationen an ein Gerät. Nur bearbeitete Werte in den Anzeigeinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Empfängt bearbeitete Anzeigesteuerungsinformationen von einem Gerät. Diese API ist ausführbar, nachdem updateDisplayInfo API ausgeführt wurde.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Importiert allgemeine Geräteinformationen aus der Datenbank. Allgemeine Geräteinformationen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Sendet bearbeitete Geräteinformationen an ein Gerät. Nur bearbeitete Werte in grundlegenden Geräteinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Erhält bearbeitete Geräteinformationen von einem Gerät. Diese API ist ausführbar, nachdem updateGeneralInfo API ausgeführt wurde.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Bewegt ein Gerät in eine andere Gruppe.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Sendet ein RM-Startprotokoll an ein Gerät. Ein Gerät, das ein RM-Startprotokoll empfangen hat, sendet in regelmäßigen Abständen Informationen über den RM-Server.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Sendet ein RM-Stoppprotokoll an ein Gerät. Ein Gerät, das ein Stoppprotokoll empfangen hat, stoppt sofort die entsprechende Funktion.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Importiert Geräteeinstellungen. Geräteeinstellungen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Sendet bearbeitete Geräteeinstellungen an ein Gerät. Nur bearbeitete Werte in den Einstellungen werden als Protokoll an das Gerät gesendet.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Erhält bearbeitete Geräteeinstellungen von einem Gerät. Diese API ist ausführbar, nachdem updateSetupInfo API ausgeführt wurde.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Sendet eine aktuelle Anzeigesteuerungsinformationsanfrage an ein Gerät. Wenn diese API aufrufen, wird requestId als der Antwortwert zurückgegeben.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importiert eine Anzeigesteuerungsinformation, die von einem Gerät gesendet wurde. Diese Option wird für zwei Aktionen verwendet: Das Senden einer Anforderung für Informationen an ein Gerät und das Empfangen von tatsächlichen Geräteinformationen.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Sendet eine aktuelle Zeitinformationsanfrage an ein Gerät. Wenn diese API aufrufen, wird requestId als der Antwortwert zurückgegeben.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importiert Zeitinformationen, die von einem Gerät gesendet wurden. Diese Option wird für zwei Aktionen verwendet: Das Senden einer Anforderung für Informationen an ein Gerät und das Empfangen von tatsächlichen Geräteinformationen.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Importiert Gerätezeitinformationen aus der Datenbank. Falls keine Steuerungsinformationen vorhanden sind, sollte eine Informationsanfrage an das Gerät gesendet werden.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Sendet bearbeitete Zeitinformationen an ein Gerät. Nur bearbeitete Werte in den Zeitinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Erhält bearbeitete Zeitinformationen von einem Gerät. Diese API ist ausführbar, nachdem getUpdatedTimeInfoResult API ausgeführt wurde.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Importiert eine Liste der Organisationen.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importiert Informationen über Untergruppen unter {groupId}.

Benutzer

Benutzer hinzufügen und Benutzerinformationen verwalten. Benutzerbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Benutzerinformationen zugänglich.

Die folgenden Benutzerverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
createUser	/restapi/v1.0/ums/users	POST	Fügt einen Benutzer hinzu.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importiert notwendige Benutzerinformationen aus dem Dashboard.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Bearbeitet Benutzerinformationen.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importiert eine Liste der Organisationen. Diese Option kann verwendet werden, um eine Gruppenstruktur zu konfigurieren.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importiert eine Liste der Organisationen.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Einstellung

Neben den Hauptfunktionen können Sie viele weitere Funktionen zum Erstellen und Verwalten von Tags und Kategorien verwenden und das Dashboard bearbeiten.

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importiert eine Liste der Kategorien.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Löscht bestimmte Dashboard-Informationen.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importiert Inhalte, die auf dem angepassten Dashboard angezeigt werden. Es ist möglich, nur bestimmte Informationen auf dem Dashboard anzuzeigen.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Ändert die Reihenfolge der Elemente, die auf dem Dashboard angezeigt werden.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Aktiviert ein inaktives Dashboard.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importiert Anmeldeinformationen, die auf dem Dashboard angezeigt werden.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importiert Anzeigetafel-Informationen, die auf dem Dashboard angezeigt werden.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Löscht einen Beitrag von der Anzeigetafel.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importiert Details des ausgewählten Beitrags.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Fügt einen Beitrag zur Anzeigetafel hinzu.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Bearbeitet den ausgewählten Beitrag auf der Anzeigetafel.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importiert Speicherinformationen, die auf dem Dashboard angezeigt werden.
listLicense	/restapi/v1.0/ems/license	GET	Importiert eine Liste der Lizenzen, die auf dem Server registriert werden.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importiert Servereinstellungen. Servereinstellelemente enthalten Optionen, die verschiedene Funktionen auf dem Server aktivieren oder deaktivieren können.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Importiert eine Liste der Tags, die auf dem Server registriert werden.

Open API-Details (Swagger UI)

Open API Documentation

docExpansion	keine
validatorUrl	keine
operationsSorter	Methode
url	http://184.169.167.38:7001/MagicInfo/v2/api-docs/

Sv translation

language	zh_TW

MagicInfo Server 可讓您呼叫 Open API (v2.0)，藉此執行內容管理、排程管理、裝置管理和其他功能。

若要使用 Open API (v2.0)，您首先需要經過驗證程序。使用獨立 Swagger 頁面以測試每個 API。

驗證

呼叫所有 Open API (v2.0) 項目時，標頭中必須納入 api_token。若沒有納入此，就會回傳「401 Unauthorized」(未獲授權) 錯誤。

在指定期限後，取得的權杖會過期並變成無法使用。在此情況下，您應取得新的權杖。

呼叫下列 API 可取得 api_token。

服務名稱	API 呼叫	呼叫類型	描述
authenticationRequest	/auth	發佈	使用使用者 ID 和密碼匯入權杖值以進行驗證。
authenticationRequest	/auth/refresh	取得	建立新權杖以延長到期時間。若沒有再次登入，就無法呼叫其餘 API

OPEN API (v2.0)

MagicInfo Server Open API (v2.0) 提供各種功能。每項功能的設定顯示如下。

類別	控制器	描述
內容	內容-控制器	內容檔案管理
內容	內容-群組-控制器	內容群組管理
播放清單	播放清單-控制器	管理播放清單
播放清單	播放清單-群組-控制器	播放清單群組管理
排程	內容-排程-控制器	內容排程管理
	內容-排程-群組-控制器	內容排程群組管理
	訊息-排程-控制器	訊息排程管理
	訊息-排程-群組-控制器	訊息排程群組管理
裝置	裝置-控制器	裝置管理
裝置	裝置-群組-控制器	裝置群組管理
使用者	使用者-控制器	使用者管理
使用者	使用者-群組-控制器	使用者群組管理
設定	環境-控制器	設定

內容

上傳、核准或刪除內容。管理內容清單。接受驗證的使用者可透過權限存取內容相關服務，以讀取、寫入和管理內容。

可用的內容管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
listAllContent	/restapi/v1.0/cms/contents	取得	匯入上傳的內容清單。內容縮圖、名稱、檔案類型和其他基本資訊皆包括在清單中。可使用分頁資訊每頁匯入清單。
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	取得	匯入要顯示在儀表板上的一般內容資訊。
listContent	/restapi/v1.0/cms/contents/filter	發佈	匯入根據條件篩選的內容清單。可使用分頁資訊每頁匯入清單。
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	刪除	刪除內容，無論內容是否納入播放清單或排程中。
deleteContent	/restapi/v1.0/cms/contents/{contentId}	刪除	在確認內容未納入播放清單或排程後刪除內容。若嘗試刪除已納入播放清單或排程的內容，該內容將不會被刪除，並回傳錯誤代碼。
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	取得	匯入已啟動內容版本的詳細資訊。內容版本會在每次編輯內容時更新。
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	放置	核准/拒絕內容。核准的內容會移到一般內容清單，且能在播放清單或排程中使用。
uploadContent	/restapi/v1.0/cms/contents/{groupId}	發佈	上傳新內容。
listDefaultGroup	/restapi/v1.0/cms/contents/groups	取得	匯入預設內容群組清單。
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	取得	匯入 {groupId} 群組之下的子群組清單。

播放清單

使用內容以建立、編輯或刪除播放清單。接受驗證的使用者可透過權限存取播放清單相關服務，以讀取、寫入和管理內容。

可用的播放清單管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
listAllPlaylist	/restapi/v1.0/cms/playlists	取得	匯入所有播放清單。播放清單名稱、主要內容縮圖、播放清單類型和其他基本資訊皆包括在清單中。可使用分頁資訊每頁匯入清單。
createPlaylist	/restapi/v1.0/cms/playlists	發佈	建立一個新的播放清單。
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	取得	從儀表板匯入必要的播放清單資訊。
listPlaylist	/restapi/v1.0/cms/playlists/filter	發佈	匯入根據條件篩選的播放清單。可使用分頁資訊每頁匯入清單。
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	刪除	刪除所選播放清單。若嘗試刪除已納入排程的播放清單，該播放清單將不會被刪除，並回傳錯誤代碼。
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	取得	匯入已啟動播放清單版本的詳細資訊。播放清單版本會在每次編輯播放清單時更新。
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	放置	編輯 {playlistId} 播放清單。編輯播放清單會更新播放清單版本，並造成播放播放清單的裝置自動播放更新的播放清單。
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	放置	複製 {playlistId} 播放清單。會建立重複的播放清單副本。
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	取得	匯入預設播放清單群組的清單。
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	取得	匯入 {groupId} 群組之下的子群組清單。

排程

建立新的內容或訊息排程。將排程發佈到裝置以播放。編輯或刪除排程。

接受驗證的使用者可透過權限存取排程相關服務，以讀取、寫入和管理排程。

可用的排程管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	取得	匯入所有內容排程清單。內容排程名稱、建立日期、裝置類型和其他基本資訊皆包括在清單中。可使用分頁資訊每頁匯入清單。
createContentSchedule	/restapi/v1.0/dms/schedule/contents	發佈	建立新的內容排程。內容排程可包含多個頻道和畫面。將排程發佈到裝置並在指定時間播放所需內容或播放清單。
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	取得	從儀表板匯入必要的內容排程資訊。
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	發佈	匯入根據不同條件篩選的內容排程清單。可使用分頁資訊每頁匯入清單。
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	刪除	刪除內容排程。若刪除先前發佈到裝置的排程，則裝置會自動播放預設內容。
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	取得	匯入所選排程的詳細資訊。
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	放置	編輯內容排程。若編輯先前發佈到裝置的排程，則裝置會自動播放編輯的排程。
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	放置	複製 {programId} 內容排程。會建立重複的 {programId} 內容排程副本。
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	放置	將內容排程發佈到特定裝置群組。
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	取得	從裝置匯入即時內容排程下載狀態。
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	取得	匯入內容排程的根群組清單。
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	取得	匯入所有訊息排程清單。
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	發佈	建立新的訊息排程。
listMessage	/restapi/v1.0/dms/schedule/messages/filter	發佈	匯入根據不同條件篩選的訊息排程清單。可使用分頁資訊每頁匯入清單。
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	刪除	刪除所選訊息排程。若刪除先前發佈到裝置的訊息排程，則該變更會自動套用至裝置。
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	取得	匯入所選訊息排程的詳細資訊。
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	放置	編輯所選訊息排程。若編輯先前發佈到裝置的訊息排程，則該變更會自動套用至裝置。
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	放置	複製所選訊息排程。會建立重複的訊息排程副本。
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	放置	將所選訊息排程發佈到裝置群組。
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	取得	匯入內容排程的根群組清單。
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	取得	匯入特定群組之下的子群組清單。

裝置

控制並管理裝置。接受驗證的使用者可透過權限存取裝置相關服務，以讀取、寫入和管理裝置。

可用的裝置管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
listAllDevice	/restapi/v1.0/rms/devices	取得	匯入所有裝置清單。裝置電源狀態、縮圖資訊、裝置錯誤狀態和其他基本資訊皆包括在清單中。可使用分頁資訊每頁匯入清單。
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	取得	從儀表板匯入必要的裝置資訊。
filterDeviceList	/restapi/v1.0/rms/devices/filter	發佈	匯入根據不同條件篩選的裝置清單。可使用分頁資訊每頁匯入清單。
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	刪除	刪除所選裝置。
getDevice	/restapi/v1.0/rms/devices/{deviceId}	取得	匯入所選裝置的詳細資訊。
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	放置	向特定群組核准所選裝置。
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	發佈	匯入關於連接至 LED 裝置之機櫃的資訊。只有在機櫃已連接至 LED 裝置時，匯入的資訊才有效。
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	放置	編輯關於連接至 LED 裝置之機櫃的資訊。
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	取得	從資料庫匯入裝置顯示控制資訊。若沒有顯示控制資訊，資訊請求應傳送至裝置。
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	放置	將編輯的顯示控制資訊傳送至裝置。只有顯示資訊中已編輯的值會作為通訊協定傳送至裝置。
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	取得	從裝置接收已編輯的顯示控制資訊。在執行 updateDisplayInfo (更新顯示資訊) API 後，即可執行此 API。
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	取得	從資料庫匯入一般裝置資訊。一般裝置資訊會在裝置連線至伺服器時更新。
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	放置	將編輯的裝置資訊傳送至裝置。只有基本裝置資訊中已編輯的值會作為通訊協定傳送至裝置。
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	取得	從裝置接收已編輯的裝置資訊。在執行 updateGeneralInfo (更新一般資訊) API 後，即可執行此 API。
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	放置	將裝置移動至另一個群組。
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	取得	將 RM 啟動通訊協定傳送至裝置。接收 RM 啟動通訊協定的裝置會透過 RM 伺服器定期傳送資訊。
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	取得	將 RM 停止通訊協定傳送至裝置。接收停止通訊協定的裝置會立刻停止相應的功能。
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	取得	匯入裝置設定。裝置設定會在裝置連線至伺服器時更新。
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	放置	將編輯的裝置設定傳送至裝置。只有設定中已編輯的值會作為通訊協定傳送至裝置。
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	取得	從裝置接收已編輯的裝置設定。在執行 updateSetupInfo (更新設定資訊) API 後，即可執行此 API。
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	取得	將目前的顯示控制資訊請求傳送至裝置。若呼叫此 API，就會回傳請求 ID 作為回應值。
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	取得	匯入從裝置傳送的顯示控制資訊。此選項用於兩個動作：將資訊請求傳送至裝置並接收實際裝置資訊。
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	取得	將目前的時間資訊請求傳送至裝置。若呼叫此 API，就會回傳請求 ID 作為回應值。
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	取得	匯入從裝置傳送的時間資訊。此選項用於兩個動作：將資訊請求傳送至裝置並接收實際裝置資訊。
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	取得	從資料庫匯入裝置時間資訊。若沒有顯示控制資訊，資訊請求應傳送至裝置。
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	放置	將編輯的時間資訊傳送至裝置。只有時間資訊中已編輯的值會作為通訊協定傳送至裝置。
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	取得	從裝置接收已編輯的裝置時間資訊。在執行 getUpdatedTimeInfoResult (取得已更新的時間資訊結果) API 後，即可執行此 API。
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	取得	匯入組織清單。
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	取得	匯入 {groupId} 之下的子群組相關資訊。

使用者

新增使用者並管理使用者資訊。接受驗證的使用者可透過權限存取使用者相關服務，以讀取、寫入和管理使用者資訊。

可用的使用者管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
createUser	/restapi/v1.0/ums/users	發佈	新增使用者。
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	取得	從儀表板匯入必要的使用者資訊。
updateMyInfo	/restapi/v1.0/ums/users/me	放置	編輯使用者資訊。
listUserOrgan	/restapi/v1.0/ums/users/organization	取得	匯入組織清單。此選項可用來設定群組樹狀結構。
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	取得	匯入組織清單。
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	取得	匯入 {groupId} 群組之下的子群組清單。

設定

除了主要功能，您也可以使用許多其他功能，以建立並管理標籤和類別，並編輯儀表板。

服務名稱	API 呼叫	呼叫類型	描述
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	取得	匯入類別清單。
deleteDashboard	/restapi/v1.0/ems/dashboard	刪除	刪除特定儀表板資訊。
listDashboardInfo	/restapi/v1.0/ems/dashboard	取得	匯入要顯示在自訂儀表板上的內容。可以在儀表板上只顯示特定資訊。
updateDashboardPriority	/restapi/v1.0/ems/dashboard	放置	變更顯示在儀表板上的項目順序。
createDashboard	/restapi/v1.0/ems/dashboard/create	取得	啟動閒置儀表板。
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	取得	匯入要顯示在儀表板上的登入資訊。
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	取得	匯入要顯示在儀表板上的佈告欄資訊。
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	刪除	從佈告欄刪除發佈內容。
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	取得	匯入所選發佈內容的詳細資訊。
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	發佈	將發佈內容新增至佈告欄。
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	放置	在佈告欄上編輯所選發佈內容。
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	取得	匯入要顯示在儀表板上的儲存資訊。
listLicense	/restapi/v1.0/ems/license	取得	匯入在伺服器上註冊的授權清單。
getServerSetupInfo	/restapi/v1.0/ems/setup	取得	匯入伺服器設定。伺服器設定項目包括可在伺服器上開啟或關閉不同功能的選項。
getTagListInfo	/restapi/v1.0/ems/tag	發佈	匯入在伺服器上註冊的標籤清單。

Open API 詳細資訊 (swagger UI)

Open API Documentation

docExpansion	無
validatorUrl	無
operationsSorter	方法
url	http://184.169.167.38:7001/MagicInfo/v2/api-docs/

Content

Space Tools

Versions Compared

Old Version 55

New Version 56

Key

Authentifizierung

OPEN API (v2.0)

Inhalt

Wiedergabeliste

Zeitplan

Gerät

Benutzer

Einstellung

Open API-Details (Swagger UI)

驗證

OPEN API (v2.0)

內容

播放清單

排程

裝置

使用者

設定

Open API 詳細資訊 (swagger UI)