Versions Compared

Key

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

...

Sv translation
languageit


Premium Server consente di implementare la gestione di contenuti, la gestione di programmazioni, la gestione di dispositivi e altre funzioni chiamando Open API (v2.0). 

 Prima di poter usare Open API (v2.0) sarà necessario seguire un processo di autenticazione. Usare una pagina Swagger a parte per testare ciascuna API.

Autenticazione

Se si chiamano tutti gli elementi di Open API (v2.0), è necessario includere api_token nell'intestazione. Se non lo si include, restituirà un errore “401 Unauthorized”. 

I token ottenuti scadono e diventano indisponibili per l'uso dopo un determinato periodo di tempo. In tal caso, sarà necessario ottenere un nuovo token.

È possibile ottenere api_token chiamando la seguente api.

Nome servizio assistenza

Chiamata API

Tipo di chiamataDescrizione
authenticationRequest

/auth

POSTImporta il valore di un token per l'autenticazione usando l'ID utente e la password.
authenticationRequest

/auth/refresh

GETCrea un nuovo token per ampliare il tempo di scadenza. È possibile chiamare REST API senza effettuare nuovamente l'accesso

OPEN API (v2.0)

Premium Server Open API (v2.0) fornisce una varietà di funzioni. Di seguito si mostra la configurazione di ciascuna funzione. 

CategoriaControllerDescrizione
Contenutocontenuto-controllerGestione contenuti
contenuto-gruppo-controllerGestione del gruppo di contenuti
Playlistplaylist-controllerGestione di una playlist
playlist-gruppo-controllerGestione del gruppo di playlist
Programmacontenuto-programmazione-controllerGestione programmazione di contenuti
contenuto-programmazione-gruppo-controllerGestione del gruppo di programmazioni di contenuti
messaggio-programmazione-controllerGestione dei programmi messaggio
messaggio-programmazione-gruppo-controllerGestione del gruppo di programmazioni di messaggi
Dispositivodispositivo-controllerGestione dispositivo
dispositivo-gruppo-controllerGestione del gruppo di dispositivi
Utenteutente-controllerGestione utente
utente-gruppo-controllerGestione gruppo utente
Impostazioniambiente-controllerImpostazioni

Contenuto

Caricare, approvare o eliminare contenuto. Gestire elenchi di contenuti. Sono accessibili servizi relazionati con i contenuti per gli utenti autenticati con privilegi di lettura, scrittura e gestione di contenuti.

I servizi di gestione dei contenuti disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamataDescrizione
listAllContent

/restapi/v1.0/cms/contents

GETImporta un elenco di contenuto aggiornato. Si includono nell'elenco anteprime di contenuti, nomi, tipi di file e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
listDashboardContentInfo

/restapi/v1.0/cms/contents/dashboard

GETImporta le informazioni dei contenuti generali da visualizzare sulla dashboard.
listContent

/restapi/v1.0/cms/contents/filter

POSTImporta un elenco di contenuti filtrato in base alle condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
forceDeleteContent

/restapi/v1.0/cms/contents/force/{contentId}

DELETEElimina contenuto, a prescindere dal fatto che sia incluso in una playlist o in una programmazione.
deleteContent

/restapi/v1.0/cms/contents/{contentId}

DELETEElimina contenuto dopo aver verificato che non è incluso in una playlist o in una programmazione. Se si cerca di eliminare del contenuto incluso in una playlist o in una programmazione, il contenuto non sarà eliminato e si restituirà un codice di errore.
getActiveContentInfo

/restapi/v1.0/cms/contents/{contentId}

GETImporta dettagli di una versione attivata del contenuto. La versione del contenuto si aggiorna ogni volta che si modifica il contenuto.
approveContents

/restapi/v1.0/cms/contents/{contentId}/approval

PUTApprova/respinge il contenuto. Il contenuto approvato viene spostato nell'elenco del contenuto generale e può essere usato in playlist e programmazioni.
uploadContent

/restapi/v1.0/cms/contents/{groupId}

POSTEsegue l'upload di contenuto nuovo.

listDefaultGroup

/restapi/v1.0/cms/contents/groups

GETImporta un elenco di gruppi di contenuti predefiniti.
getGroup

/restapi/v1.0/cms/contents/groups/{groupId}

GETImporta dettagli del gruppo {groupId}.
listChildGroup

/restapi/v1.0/cms/contents/groups/{groupId}/child

GETImporta un elenco di sottogruppi nel gruppo {groupId}.


Playlist

Usare contenuto per creare, modificare o eliminare playlist. Sono accessibili servizi relazionati con le playlist per gli utenti autenticati con privilegi di lettura, scrittura e gestione di contenuti.

I servizi di gestione delle playlist disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamataDescrizione
listAllPlaylist

/restapi/v1.0/cms/playlists

GETImporta un elenco di tutte le playlist. Si includono nell'elenco nomi di playlist, anteprime di contenuti principali, tipi di playlist e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
createPlaylist

/restapi/v1.0/cms/playlists

POSTCrea una nuova playlist.

getDashboardPlaylistInfo

/restapi/v1.0/cms/playlists/dashboard

GETImporta informazioni necessarie sulla playlist dalla dashboard.

listPlaylist

/restapi/v1.0/cms/playlists/filter

POSTImporta un elenco di playlist filtrato in base alle condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

deletePlaylist

/restapi/v1.0/cms/playlists/{playlistId}

DELETEElimina la playlist selezionata. Se si cerca di eliminare una playlist inclusa in una programmazione, la playlist non sarà eliminata e si restituirà un codice di errore.

getActivePlaylistInfo

/restapi/v1.0/cms/playlists/{playlistId}

GETImporta dettagli di una versione attivata di una playlist. La versione di una playlist si aggiorna ogni volta che si modifica la playlist stessa.

editPlaylist

/restapi/v1.0/cms/playlists/{playlistId}

PUTModifica la playlist {playlistId}. Se si modifica una playlist si aggiorna la versione della playlist e, di conseguenza, il dispositivo che riproduce la playlist riproduce automaticamente la playlist aggiornata.

copyPlaylist

/restapi/v1.0/cms/playlists/{playlistId}/copy

PUTCopia la playlist {playlistId}. Si crea una copia duplicata della playlist.
listDefaultGroup

/restapi/v1.0/cms/playlists/groups

GETImporta un elenco di gruppi di playlist predefinite.

getGroup

/restapi/v1.0/cms/playlists/groups/{groupId}

GETImporta dettagli del gruppo {groupId}.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET

Importa un elenco di sottogruppi nel gruppo {groupId}.

Programma

Creare nuove programmazioni di contenuto o messaggi. Pubblicare programmazioni sui dispositivi per la riproduzione. Modificare o eliminare programmazioni.

Sono accessibili servizi relazionati con le programmazioni per gli utenti autenticati con privilegi di lettura, scrittura e gestione di programmazioni.

I servizi di gestione delle programmazioni disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamataDescrizione
listContentScheduleAll

/restapi/v1.0/dms/schedule/contents

GETImporta un elenco di tutte le programmazioni di contenuti. Si includono nell'elenco nomi di programmazioni di contenuti, date di creazione, tipi di dispositivi e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
createContentSchedule

/restapi/v1.0/dms/schedule/contents

POSTCrea una nuova programmazione di contenuti. Una programmazione di contenuti può contenere vari canali e cornici. Pubblicare una programmazione sui dispositivi e riprodurre il contenuto desiderato o la playlist ad un'ora specificata.
listDashboardScheduleInfo

/restapi/v1.0/dms/schedule/contents/dashboard

GETImporta informazioni necessarie sulla programmazione di contenuti dalla dashboard.
listContentScheduleByGroup

/restapi/v1.0/dms/schedule/contents/filter

POSTImporta un elenco di programmazioni di contenuti filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
deleteContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

DELETEElimina una programmazione di contenuti. Se si elimina una programmazione precedentemente pubblicata su un dispositivo, il dispositivo riproduce automaticamente il contenuto predefinito.
getProgramInfo

/restapi/v1.0/dms/schedule/contents/{programId}

GETImporta dettagli della programmazione selezionata.
editContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

PUTModifica una programmazione di contenuti. Se si modifica una programmazione precedentemente pubblicata su un dispositivo, il dispositivo riproduce automaticamente la programmazione modificata.
copyContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/copy

PUTCopia la programmazione di contenuti {programId}. Si crea una copia duplicata della programmazione di contenuti {programId}.
deployContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/deploy

PUTPubblica una programmazione di contenuti su un gruppo specifico di dispositivi.
getPublishStatus

/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus

GETImporta lo stato di download in tempo reale di una programmazione di contenuti dal dispositivo.
getRootGroups

/restapi/v1.0/dms/schedule/contents/groups

GETImporta un elenco di gruppi principali per una programmazione di contenuti.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GETImporta dettagli del gruppo {groupId}.
listAllMessageSchedule

/restapi/v1.0/dms/schedule/messages

GETImporta un elenco di tutte le programmazioni di messaggi.
createMessageSchedule

/restapi/v1.0/dms/schedule/messages

POSTCrea una nuova programmazione di messaggi.
listMessage

/restapi/v1.0/dms/schedule/messages/filter

POST 

Importa un elenco di programmazioni di messaggi filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
deleteMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

DELETEElimina la programmazione di messaggi selezionata. Se si elimina una programmazione di messaggi precedentemente pubblicata su un dispositivo, il cambio si applica automaticamente al dispositivo.
getMessageInfo

/restapi/v1.0/dms/schedule/messages/{messageId}

GETImporta dettagli della programmazione di messaggi selezionata.
editMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

PUTModifica la programmazione di messaggi selezionata. Se si modifica una programmazione di messaggi precedentemente pubblicata su un dispositivo, il cambio si applica automaticamente al dispositivo.
copyMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/copy

PUTCopia la programmazione di messaggi selezionata. Si crea una copia duplicata della programmazione di messaggi.
deployMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/deploy

PUTPubblica la programmazione di messaggi selezionata su un gruppo di dispositivi.
getRootGroups

/restapi/v1.0/dms/schedule/messages/groups

GETImporta un elenco di gruppi principali per una programmazione di contenuti.
listMessageScheduleGroupInfo

/restapi/v1.0/dms/schedule/messages/groups/{groupId}

GETImporta dettagli del gruppo {groupId}.
getChildGroups

/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child

GETImporta un elenco di sottogruppi in un gruppo specifico.

Dispositivo

Controllare e gestire dispositivi. Sono accessibili servizi relazionati con i dispositivi per gli utenti autenticati con privilegi di lettura, scrittura e gestione di dispositivi.

I servizi di gestione dei dispositivi disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamataDescrizione
listAllDevice

/restapi/v1.0/rms/devices

GETImporta un elenco di tutti i dispositivi. Si includono nell'elenco lo stato di alimentazione del dispositivo, info di anteprima, stato dell'errore del dispositivo e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
getDashboardDeviceInfo

/restapi/v1.0/rms/devices/dashboard

GETImporta informazioni necessarie sul dispositivo dalla dashboard.
filterDeviceList

/restapi/v1.0/rms/devices/filter

POSTImporta un elenco di dispositivi filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
deleteDevice

/restapi/v1.0/rms/devices/{deviceId}

DELETEElimina il dispositivo selezionato.
getDevice

/restapi/v1.0/rms/devices/{deviceId}

GETImporta dettagli del dispositivo selezionato.
approveDevice

/restapi/v1.0/rms/devices/{deviceId}/approval

PUTApprova il dispositivo selezionato su un gruppo specifico.
getCabinetList

/restapi/v1.0/rms/devices/{deviceId}/cabinet

POSTImporta informazioni sui case collegati a un dispositivo LED. Le informazioni importate sono valide solo fino a quando il case è collegato a un dispositivo LED.
updateCabinetInfo

/restapi/v1.0/rms/devices/{deviceId}/cabinet

PUTModifica informazioni sui case collegati a un dispositivo LED.
getDisplayControlInfo

/restapi/v1.0/rms/devices/{deviceId}/display

GETImporta informazioni sul controllo della visualizzazione di un dispositivo dal database. Se non sono presenti informazioni sul controllo, si dovrà inviare al dispositivo una richiesta di informazioni.
updateDisplayInfo

/restapi/v1.0/rms/devices/{deviceId}/display

PUTInvia informazioni modificate sul controllo della visualizzazione a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni di visualizzazione.
getUpdatedDisplayInfoResult

/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}

GETRiceve informazioni modificate sul controllo della visualizzazione da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API updateDisplayInfo.
getGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general

GETImporta informazioni generali sul dispositivo dal database. Le informazioni generali sul dispositivo vengono aggiornate quando si collega il dispositivo al server.
updateGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general/info

PUTInvia informazioni modificate sul dispositivo a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni di base del dispositivo.
getUpdatedGeneralInfoResult

/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}

GETRiceve informazioni modificate sul dispositivo da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API updateGeneralInfo.
moveDevice

/restapi/v1.0/rms/devices/{deviceId}/move

PUTSposta un dispositivo su un altro gruppo.
startRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/start

GETInvia un protocollo di avvio RM a un dispositivo. Il dispositivo che riceve il protocollo di avvio RM invia quindi periodicamente informazioni mediante il server RM.
stopRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop

GETInvia un protocollo di interruzione RM a un dispositivo. Il dispositivo che riceve il protocollo interruzione interrompe immediatamente la funzione corrispondente.
getSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

GETImporta le impostazioni del dispositivo. Le impostazioni del dispositivo vengono aggiornate quando si collega il dispositivo al server.
updateSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

PUTInvia impostazioni modificate del dispositivo a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle impostazioni.
getUpdatedSetupInfoResult

/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}

GETRiceve impostazioni modificate del dispositivo da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API updateSetupInfo.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display

GETInvia una richiesta di informazioni sul controllo della visualizzazione attuale a un dispositivo. Se si chiama questa API, si restituisce requestId come valore di risposta.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}

GETImporta informazioni sul controllo della visualizzazione inviate da un dispositivo. Questa opzione è usata per due azioni: inviare una richiesta di informazioni a un dispositivo e ricevere informazioni sul dispositivo reale.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time

GETInvia una richiesta di informazioni sull'orario attuale a un dispositivo. Se si chiama questa API, si restituisce requestId come valore di risposta.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}

GETImporta informazioni sull'orario inviate da un dispositivo. Questa opzione è usata per due azioni: inviare una richiesta di informazioni a un dispositivo e ricevere informazioni sul dispositivo reale.
getTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

GETImporta informazioni sull'orario di un dispositivo dal database. Se non sono presenti informazioni sul controllo, si dovrà inviare al dispositivo una richiesta di informazioni.
updateTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

PUTInvia informazioni modificate sull'orario a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni sull'orario.
getUpdatedTimeInfoResult

/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}

GET

Riceve informazioni modificate sull'orario del dispositivo da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API getUpdatedTimeInfoResult.

listDeviceGroupOrgan

/restapi/v1.0/rms/devices/groups

GETImporta un elenco di organizzazioni.
listDeviceGroupInfo

/restapi/v1.0/rms/devices/groups/{groupId}

GETImporta dettagli del gruppo {groupId}.
listDeviceGroupChild

/restapi/v1.0/rms/devices/groups/{groupId}/child

GETImporta informazioni sui sottogruppi di {groupId}.

Utente

Aggiungere utenti e gestire le informazioni utente. Sono accessibili servizi relazionati con gli utenti per gli utenti autenticati con privilegi di lettura, scrittura e gestione di informazioni utente.

I servizi di gestione degli utenti disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamataDescrizione
createUser/restapi/v1.0/ums/usersPOSTAggiunge un utente.
listDashboardUserInfo

/restapi/v1.0/ums/users/dashboard

GETImporta informazioni necessarie sull'utente dalla dashboard.
updateMyInfo

/restapi/v1.0/ums/users/me

PUTModifica le informazioni utente.
listUserOrgan

/restapi/v1.0/ums/users/organization

GETImporta un elenco di organizzazioni. È possibile usare questa opzione per configurare un albero dei gruppi.
listUserGroupOrgan

/restapi/v1.0/ums/users/groups

GETImporta un elenco di organizzazioni.
listUserGroupInfo

/restapi/v1.0/ums/users/groups/{groupId}

GETImporta dettagli del gruppo {groupId}.
listUserGroupChild

/restapi/v1.0/ums/users/groups/{groupId}/child

GETImporta un elenco di sottogruppi nel gruppo {groupId}.

Impostazioni

Oltre alle funzioni principali, è possibile usare molte altre funzioni per creare e gestire tag e categorie e modificare la dashboard.

Nome servizio assistenza

Chiamata API

Tipo di chiamataDescrizione
getCategoryInfo

/restapi/v1.0/ems/category/{categoryId}

GETImporta un elenco di categorie.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETEElimina specifiche informazioni della dashboard.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GETImporta contenuti da visualizzare sulla dashboard personalizzata. È possibile visualizzare solo informazioni specifiche sulla dashboard.
updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUTCambia l'ordine degli elementi visualizzati sulla dashboard.
createDashboard

/restapi/v1.0/ems/dashboard/create

GETAttiva una dashboard inattiva.

listDashboardLoginInfo

/restapi/v1.0/ems/dashboard/login

GETImporta le informazioni di accesso da visualizzare sulla dashboard.
listDashboardNoticeInfo

/restapi/v1.0/ems/dashboard/notice

GETImporta le informazioni della bacheca da visualizzare sulla dashboard.
deleteNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

DELETEElimina una pubblicazione dalla bacheca.
listEditNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

GETImporta dettagli della pubblicazione selezionata.
createNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

POSTAggiunge pubblicazioni alla bacheca.
updateNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

PUTModifica la pubblicazione selezionata sulla bacheca.
listDashboardStorageInfo

/restapi/v1.0/ems/dashboard/storage

GETImporta le informazioni di archiviazione da visualizzare sulla dashboard.

listLicense

/restapi/v1.0/ems/license

GETImporta un elenco di licenze registrate sul server.
getServerSetupInfo

/restapi/v1.0/ems/setup

GETImporta le impostazioni del server. Gli elementi di impostazione del server includono opzioni che possono attivare o disattivare funzioni diverse sul server.
getTagListInfo

/restapi/v1.0/ems/tag

POSTImporta un elenco di tag registrati sul server.


Dettagli Open API (swagger UI)

Open API Documentation
docExpansionnessuno
validatorUrlnessuno
operationsSortermetodo
urlhttp://184.169.167.38:7001/MagicInfo/v2/api-docs/




Sv translation
languagede


Premium 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

EreignistypBeschreibung
authenticationRequest

/auth

POSTImportiert einen Token-Wert für die Authentifizierung unter Verwendung der Benutzer-ID und des Kennworts.
authenticationRequest

/auth/refresh

GETErstellt ein neues Token, um die Ablaufzeit zu verlängern. Es ist möglich, REST API aufzurufen, ohne sich erneut anzumelden

OPEN API (v2.0)

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

KategorieControllerBeschreibung
InhaltInhalte-ControllerContent Management
Inhalte-Gruppe-ControllerInhaltsgruppen-Verwaltung
WiedergabelisteWiedergabeliste-ControllerVerwalten einer Wiedergabeliste
Wiedergabeliste-Gruppe-ControllerWiedergabelistengruppen-Verwaltung
ZeitplanInhalte-Zeitplan-ControllerInhaltszeitplan-Verwaltung
Inhalte-Zeitplan-Gruppe-ControllerInhaltszeitplan-Gruppenverwaltung
Nachricht-Zeitplan-ControllerVerwalten von Nachrichtenzeitplänen
Nachricht-Zeitplan-Gruppe-ControllerNachrichten-Zeitplan-Gruppenverwaltung
GerätGerät-ControllerGerätemanagement
Gerät-Gruppe-ControllerGerätegruppen-Verwaltung
BenutzerBenutzer-ControllerBenutzerverwaltung
Benutzer-Gruppe-ControllerBenutzergruppen-Verwaltung
EinstellungUmgebung-ControllerEinstellung

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

EreignistypBeschreibung
listAllContent

/restapi/v1.0/cms/contents

GETImportiert 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

GETImportiert allgemeine Inhaltsinformationen, die auf dem Dashboard angezeigt werden.
listContent

/restapi/v1.0/cms/contents/filter

POSTImportiert 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}

DELETELöscht Inhalte, unabhängig davon, ob die Inhalte in einer Wiedergabeliste oder einem Zeitplan enthalten sind.
deleteContent

/restapi/v1.0/cms/contents/{contentId}

DELETELö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}

GETImportiert 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

PUTGenehmigt 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}

POSTLädt neue Inhalte hoch.

listDefaultGroup

/restapi/v1.0/cms/contents/groups

GETImportiert eine Liste der Standard-Inhaltsgruppen.
getGroup

/restapi/v1.0/cms/contents/groups/{groupId}

GETImportiert Details der {groupId}-Gruppe.
listChildGroup

/restapi/v1.0/cms/contents/groups/{groupId}/child

GETImportiert 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

EreignistypBeschreibung
listAllPlaylist

/restapi/v1.0/cms/playlists

GETImportiert 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

POSTErstellt eine neue Wiedergabeliste.

getDashboardPlaylistInfo

/restapi/v1.0/cms/playlists/dashboard

GETImportiert notwendige Wiedergabelisteninformationen vom Dashboard.

listPlaylist

/restapi/v1.0/cms/playlists/filter

POSTImportiert 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}

DELETELö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}

GETImportiert 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}

PUTBearbeitet 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

PUTKopiert die {playlistId} Wiedergabeliste. Ein Duplikat der Wiedergabeliste wurde erstellt.
listDefaultGroup

/restapi/v1.0/cms/playlists/groups

GETImportiert eine Liste der Standard-Wiedergabelistengruppen.

getGroup

/restapi/v1.0/cms/playlists/groups/{groupId}

GETImportiert Details der {groupId}-Gruppe.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET

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

EreignistypBeschreibung
listContentScheduleAll

/restapi/v1.0/dms/schedule/contents

GETImportiert 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

POSTErstellt 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

GETImportiert notwendige Inhaltszeitplaninformationen vom Dashboard.
listContentScheduleByGroup

/restapi/v1.0/dms/schedule/contents/filter

POSTImportiert 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}

DELETELö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}

GETImportiert Details des ausgewählten Zeitplans.
editContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

PUTBearbeitet 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

PUTKopiert 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

GETImport den Echtzeit-Inhaltszeitplan-Downloadstatus von einem Gerät.
getRootGroups

/restapi/v1.0/dms/schedule/contents/groups

GETImportiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GETImportiert Details der {groupId}-Gruppe.
listAllMessageSchedule

/restapi/v1.0/dms/schedule/messages

GETImportiert eine Liste aller Nachrichtenzeitpläne.
createMessageSchedule

/restapi/v1.0/dms/schedule/messages

POSTErstellt 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}

DELETELö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}

GETImportiert Details des ausgewählten Nachrichtenzeitplans.
editMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

PUTBearbeitet 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

PUTKopiert 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

GETImportiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.
listMessageScheduleGroupInfo

/restapi/v1.0/dms/schedule/messages/groups/{groupId}

GETImportiert Details der {groupId}-Gruppe.
getChildGroups

/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child

GETImportiert 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

EreignistypBeschreibung
listAllDevice

/restapi/v1.0/rms/devices

GETImportiert 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

GETImportiert notwendige Geräteinformationen aus dem Dashboard.
filterDeviceList

/restapi/v1.0/rms/devices/filter

POSTImportiert 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}

DELETELöscht das ausgewählte Gerät.
getDevice

/restapi/v1.0/rms/devices/{deviceId}

GETImportiert Details des ausgewählten Geräts.
approveDevice

/restapi/v1.0/rms/devices/{deviceId}/approval

PUTGenehmigt das ausgewählte Video für eine bestimmte Gruppe.
getCabinetList

/restapi/v1.0/rms/devices/{deviceId}/cabinet

POSTImportiert 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

PUTBearbeitet Informationen über Schränke, die mit einem LED-Gerät verbunden sind.
getDisplayControlInfo

/restapi/v1.0/rms/devices/{deviceId}/display

GETImportiert 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

PUTSendet 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}

GETEmpfä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

GETImportiert 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

PUTSendet 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}

GETErhä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

PUTBewegt ein Gerät in eine andere Gruppe.
startRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/start

GETSendet 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 Remote control Server .
stopRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop

GETSendet 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

GETImportiert Geräteeinstellungen. Geräteeinstellungen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.
updateSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

PUTSendet 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}

GETErhä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

GETSendet 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}

GETImportiert 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

GETSendet 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}

GETImportiert 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

GETImportiert 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

PUTSendet 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

GETImportiert eine Liste der Organisationen.
listDeviceGroupInfo

/restapi/v1.0/rms/devices/groups/{groupId}

GETImportiert Details der {groupId}-Gruppe.
listDeviceGroupChild

/restapi/v1.0/rms/devices/groups/{groupId}/child

GETImportiert 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

EreignistypBeschreibung
createUser/restapi/v1.0/ums/usersPOSTFügt einen Benutzer hinzu.
listDashboardUserInfo

/restapi/v1.0/ums/users/dashboard

GETImportiert notwendige Benutzerinformationen aus dem Dashboard.
updateMyInfo

/restapi/v1.0/ums/users/me

PUTBearbeitet Benutzerinformationen.
listUserOrgan

/restapi/v1.0/ums/users/organization

GETImportiert eine Liste der Organisationen. Diese Option kann verwendet werden, um eine Gruppenstruktur zu konfigurieren.
listUserGroupOrgan

/restapi/v1.0/ums/users/groups

GETImportiert eine Liste der Organisationen.
listUserGroupInfo

/restapi/v1.0/ums/users/groups/{groupId}

GETImportiert Details der {groupId}-Gruppe.
listUserGroupChild

/restapi/v1.0/ums/users/groups/{groupId}/child

GETImportiert 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

EreignistypBeschreibung
getCategoryInfo

/restapi/v1.0/ems/category/{categoryId}

GETImportiert eine Liste der Kategorien.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETELöscht bestimmte Dashboard-Informationen.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GETImportiert 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

GETAktiviert ein inaktives Dashboard.

listDashboardLoginInfo

/restapi/v1.0/ems/dashboard/login

GETImportiert Anmeldeinformationen, die auf dem Dashboard angezeigt werden.
listDashboardNoticeInfo

/restapi/v1.0/ems/dashboard/notice

GETImportiert Anzeigetafel-Informationen, die auf dem Dashboard angezeigt werden.
deleteNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

DELETELöscht einen Beitrag von der Anzeigetafel.
listEditNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

GETImportiert Details des ausgewählten Beitrags.
createNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

POSTFügt einen Beitrag zur Anzeigetafel hinzu.
updateNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

PUTBearbeitet den ausgewählten Beitrag auf der Anzeigetafel.
listDashboardStorageInfo

/restapi/v1.0/ems/dashboard/storage

GETImportiert Speicherinformationen, die auf dem Dashboard angezeigt werden.

listLicense

/restapi/v1.0/ems/license

GETImportiert eine Liste der Lizenzen, die auf dem Server registriert werden.
getServerSetupInfo

/restapi/v1.0/ems/setup

GETImportiert Servereinstellungen. Servereinstellelemente enthalten Optionen, die verschiedene Funktionen auf dem Server aktivieren oder deaktivieren können.
getTagListInfo

/restapi/v1.0/ems/tag

POSTImportiert eine Liste der Tags, die auf dem Server registriert werden.


Open API-Details (Swagger UI)

Open API Documentation
docExpansionkeine
validatorUrlkeine
operationsSorterMethode
urlhttp://184.169.167.38:7001/MagicInfo/v2/api-docs/




...