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
languagefr

MagicINFO Server vous permet de mettre en place une gestion du contenu, une gestion des programmes, une gestion des périphériques et d’autres fonctions comme Open API (v2.0). 

Pour utiliser Open API (v2.0), vous devez d’abord effectuer un processus d’authentification. Utilisez une page Swagger distincte pour tester chaque API.

Authentification

Lorsque vous appelez tous les éléments Open API (v2.0), vous devez inclure api_token dans l’en-tête. Si ceci n’est pas inclus, une erreur « 401 Unauthorized. » est renvoyée.

Un jeton obtenu expire et devient inutilisable après une durée définie. Si tel est le cas, vous devez obtenir un nouveau jeton.

Il est possible d’obtenir api_token en appelant l’API suivante.

Nom du service

Requête API

Type de requête

Description

authenticationRequest

/auth

POST

Importe une valeur de jeton pour l’authentification à l’aide de l’identifiant d’utilisateur et du mot de passe.

authenticationRequest

/auth/refresh

GET

Crée un nouveau jeton pour étendre le délai d’expiration. Il est possible d’appeler REST API sans se reconnecter

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) fournit diverses fonctions. La configuration de chaque fonction est indiquée ci-dessous.

Catégorie

Contrôleur

Description

Contenu :

content-controller

Gestion du contenu

content-group-controller

Gestion du groupe de contenu

Liste de lecture

playlist-controller

Gestion des listes de lecture

playlist-group-controller

Gestion du groupe de listes de lecture

Programme

content-schedule-controller

Gestion du programme de contenu

content-schedule-group-controller

Gestion du groupe de programmes de contenu

message-schedule-controller

Gestion des programmes de messages

message-schedule-group-controller

Gestion du groupe de programmes de message

Périphérique

device-controller

Gestion des périphériques

device-group-controller

Gestion du groupe de périphériques

Utilisateur

user-controller

Gestion des utilisateurs

user-group-controller

Gestion du groupe d’utilisateurs

Réglage

environment-controller

Réglage

Contenu :

Téléchargez, approuvez ou supprimez du contenu. Gérez des listes de contenu. Les services relatifs au contenu sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de contenu sont comme suit :

Nom du service

Requête API

Type de requête

Description

listAllContent

/restapi/v1.0/cms/contents

GET

Permet d’importer une liste du contenu téléchargé. La liste inclut les vignettes de contenu, les noms, les types de fichiers et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

listDashboardContentInfo

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

GET

Permet d’importer des informations de contenu générales à afficher sur le tableau de bord.

listContent

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

POST

Permet d’importer une liste de contenu filtré selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

forceDeleteContent

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

DELETE

Supprime du contenu, que le contenu soit inclus ou non dans une liste de lecture ou un programme.

deleteContent

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

DELETE

Supprime du contenu après avoir vérifié que le contenu n’est pas inclus dans une liste de lecture ou un programme. Si vous tentez de supprimer du contenu inclus dans une liste de lecture ou un programme, le contenu n’est pas supprimé et un code d’erreur est renvoyé.

getActiveContentInfo

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

GET

Lorsqu’un contenu est modifié, sa version est mise à jour. La version actuelle des détails du contenu est récupérée.

approveContents

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

PUT

Permet d’approuver/de rejeter du contenu. Le contenu approuvé est déplacé dans la liste de contenu général et peut être utilisé dans des listes de lecture ou des programmes.

uploadContent

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

POST

Permet de télécharger du nouveau contenu.

listDefaultGroup

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

GET

Permet d’importer une liste des groupes de contenu par défaut.

getGroup

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

GET

Récupère les détails du groupe {groupId}.

listChildGroup

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

GET

Récupère une liste de sous-groupes dans le groupe {groupId}.


Liste de lecture

Utilisez du contenu pour créer, modifier ou supprimer des listes de lecture. Les services relatifs aux listes de lecture sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de liste de lecture sont comme suit :

Nom du service

Requête API

Type de requête

Description

listAllPlaylist

/restapi/v1.0/cms/playlists

GET

Permet d’importer une liste de toutes les listes de lecture. La liste inclut les noms des listes de lecture, les vignettes de contenu principales, les types de listes de lecture et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

createPlaylist

/restapi/v1.0/cms/playlists

POST

Crée une nouvelle liste de lecture.

getDashboardPlaylistInfo

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

GET

Permet d’importer depuis le tableau de bord des informations de liste de lecture indispensables.

listPlaylist

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

POST

Permet d’importer une liste des listes de lecture filtrées selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

deletePlaylist

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

DELETE

Supprime la liste de lecture sélectionnée. Si vous tentez de supprimer une liste de lecture incluse dans un programme, la liste de lecture n’est pas supprimée et un code d’erreur est renvoyé.

getActivePlaylistInfo

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

GET

Permet d’importer les détails d’une version activée d’une liste de lecture. La version d’une liste de lecture est mise à jour à chaque fois que cette liste de lecture est modifiée.

editPlaylist

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

PUT

Modifie la liste de lecture {playlistId}. La modification d’une liste de lecture actualise la version de cette liste de lecture. Ainsi, le périphérique lisant la liste de lecture lit automatiquement la version mise à jour.

copyPlaylist

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

PUT

Copie la liste de lecture {playlistId}. Un duplicata de la liste de lecture est créé.

listDefaultGroup

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

GET

Permet d’importer une liste des groupes de listes de lecture par défaut.

getGroup

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

GET

Récupère les détails du groupe {groupId}.

listChildGroup

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

GET

Récupère une liste de sous-groupes dans le groupe {groupId}.

Programme

Créez de nouveaux programmes de contenu ou de message. Publiez des programmes sur des périphériques pour la lecture. Modifiez ou supprimez des programmes.

Les services relatifs aux programmes sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des programmes.

Les services disponibles de gestion de programme sont comme suit :

Nom du service

Requête API

Type de requête

Description

listContentScheduleAll

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

GET

Permet d’importer une liste de tous les programmes de contenu. La liste inclut les noms des programmes de contenu, les dates de création, les types de périphériques et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

createContentSchedule

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

POST

Permet de créer un nouveau programme de contenu. Un programme de contenu peut contenir plusieurs canaux et cadres. Publiez un programme sur des périphériques et lisez le contenu souhaité ou la liste de lecture à un moment spécifié.

listDashboardScheduleInfo

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

GET

Permet d’importer depuis le tableau de bord des informations de programme de contenu indispensables.

listContentScheduleByGroup

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

POST

Permet d’importer une liste de programmes de contenu filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

deleteContentSchedule

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

DELETE

Supprime un programme de contenu. En cas de suppression d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le contenu par défaut.

getProgramInfo

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

GET

Permet d’importer les détails du programme sélectionné.

editContentSchedule

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

PUT

Permet de modifier un programme de contenu. En cas de modification d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le programme modifié.

copyContentSchedule

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

PUT

Copie le programme de contenu {programId}. Le programme de contenu comme {programId} est maintenant créé.

deployContentSchedule

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

PUT

Permet de publier un programme de contenu sur un groupe de périphériques spécifique.

getPublishStatus

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

GET

Permet d’importer le statut de téléchargement en temps réel d’un programme de contenu depuis un périphérique.

getRootGroups

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

GET

Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.

listContentScheduleGroupInfo

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

GET

Récupère les détails du groupe {groupId}.

listAllMessageSchedule

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

GET

Permet d’importer une liste de tous les programmes de message.

createMessageSchedule

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

POST

Permet de créer un nouveau programme de message.

listMessage

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

POST

Permet d’importer une liste de programmes de message filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

deleteMessageSchedule

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

DELETE

Supprime le programme de message sélectionné. En cas de suppression d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.

getMessageInfo

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

GET

Permet d’importer les détails du programme de message sélectionné.

editMessageSchedule

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

PUT

Permet d’éditer le programme de message sélectionné. En cas de modification d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.

copyMessageSchedule

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

PUT

Permet de copier le programme de message sélectionné. Un duplicata du programme de message est créé.

deployMessageSchedule

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

PUT

Permet de publier le programme de message sélectionné sur un groupe de périphériques.

getRootGroups

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

GET

Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.

listMessageScheduleGroupInfo

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

GET

Récupère les détails du groupe {groupId}.

getChildGroups

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

GET

Permet d’importer une liste de sous-groupes dans un groupe spécifique.

Périphérique

Contrôlez et gérez les périphériques. Les services relatifs aux périphériques sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des périphériques.

Les services disponibles de gestion de périphérique sont comme suit :

Nom du service

Requête API

Type de requête

Description

listAllDevice

/restapi/v1.0/rms/devices

GET

Permet d’importer une liste de tous les périphériques. La liste inclut l’état d’alimentation du périphérique, les informations de vignette, le statut d’erreur du périphérique et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

getDashboardDeviceInfo

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

GET

Permet d’importer depuis le tableau de bord des informations de périphérique indispensables.

filterDeviceList

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

POST

Permet d’importer une liste de périphériques filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

deleteDevice

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

DELETE

Supprime le périphérique sélectionné.

getDevice

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

GET

Permet d’importer les détails du périphérique sélectionné.

approveDevice

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

PUT

Permet d’approuver le périphérique sélectionné sur un groupe spécifique.

getCabinetList

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

POST

Permet d’importer des informations sur les cabinets connectés à un périphérique LED. Les informations importées sont valides uniquement lorsque les cabinets sont connectés à un périphérique LED.

updateCabinetInfo

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

PUT

Permet de modifier des informations sur les cabinets connectés à un périphérique LED.

getDisplayControlInfo

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

GET

Permet d’importer des informations de contrôle d’affichage du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.

updateDisplayInfo

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

PUT

Permet d’envoyer sur un périphérique des informations de contrôle d’affichage modifiées. Seules les valeurs modifiées dans les informations d’affichage sont envoyées au périphérique en tant que protocole.

getUpdatedDisplayInfoResult

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

GET

Permet de recevoir depuis un périphérique des informations de contrôle d’affichage modifiées. Cette API est exécutée après l’exécution de l’API updateDisplayInfo.

getGeneralInfo

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

GET

Permet d’importer des informations de périphérique générales depuis la base de données. Les informations de périphérique générales sont actualisées lorsque le périphérique se connecte au serveur.

updateGeneralInfo

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

PUT

Permet d’envoyer sur un périphérique des informations de périphérique modifiées. Seules les valeurs modifiées dans les informations de périphérique de base sont envoyées au périphérique en tant que protocole.

getUpdatedGeneralInfoResult

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

GET

Permet de recevoir depuis un périphérique des informations de périphérique modifiées. Cette API est exécutée après l’exécution de l’API updateGeneralInfo.

moveDevice

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

PUT

Permet de déplacer un périphérique sur un autre groupe.

startRmServerVnc

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

GET

Permet d’envoyer sur un périphérique un protocole de démarrage RM. Un périphérique ayant reçu un protocole de démarrage RM envoie régulièrement des informations via le serveur de la télécommande.

stopRmServerVnc

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

GET

Permet d’envoyer sur un périphérique un protocole d’arrêt RM. Un périphérique ayant reçu un protocole d’arrêt arrête immédiatement la fonction correspondante.

getSetupInfo

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

GET

Permet d’importer des paramètres relatifs à un périphérique. Les paramètres de périphérique sont actualisés lorsque le périphérique se connecte au serveur.

updateSetupInfo

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

PUT

Permet d’envoyer sur un périphérique des paramètres de périphérique modifiés. Seules les valeurs modifiées dans les paramètres sont envoyées au périphérique en tant que protocole.

getUpdatedSetupInfoResult

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

GET

Permet de recevoir depuis un périphérique des paramètres de périphérique modifiés. Cette API est exécutée après l’exécution de l’API updateSetupInfo.

getCurrentStatusDisplay

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

GET

Permet d’envoyer sur un périphérique une requête d’informations actuelles de contrôle d’affichage. Lorsque vous appelez cette API, vous recevez requestId comme valeur de response.

getCurrentStatusDisplay

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

GET

Permet d’importer depuis un périphérique des informations de contrôle d’affichage. Cette option est utilisée pour deux actions : envoyer une requête d’informations à un périphérique et recevoir des informations actuelles sur le périphérique.

getCurrentStatusTime

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

GET

Permet d’envoyer sur un périphérique une requête d’informations actuelles concernant l’heure. Lorsque vous appelez cette API, vous recevez requestId comme valeur de response.

getCurrentStatusTime

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

GET

Permet d’importer des informations sur l’heure envoyées depuis un périphérique. requestId reçu en appelant getCurrentStatusTime doit être envoyé en tant que paramètre.

getTimeInfo

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

GET

Permet d’importer des informations sur l’heure du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.

updateTimeInfo

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

PUT

Permet d’envoyer sur un périphérique des informations modifiées concernant l’heure. Seules les valeurs modifiées dans les informations sur l’heure sont envoyées au périphérique en tant que protocole.

getUpdatedTimeInfoResult

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

GET

Permet de recevoir depuis un périphérique des informations modifiées sur l’heure du périphérique. Cette API est exécutée après l’exécution de l’API getUpdatedTimeInfoResult.

listDeviceGroupOrgan

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

GET

Permet d’importer une liste d’organisations.

listDeviceGroupInfo

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

GET

Récupère les détails du groupe {groupId}.

listDeviceGroupChild

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

GET

Récupère les sous-groupes sous {groupId}.

Utilisateur

Ajoutez des utilisateurs et gérez les informations d’utilisateur. Les services relatifs aux utilisateurs sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer les informations d’utilisateur.

Les services disponibles de gestion d’utilisateur sont comme suit :

Nom du service

Requête API

Type de requête

Description

createUser

/restapi/v1.0/ums/users

POST

Permet d’ajouter un utilisateur.

listDashboardUserInfo

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

GET

Permet d’importer depuis le tableau de bord des informations d’utilisateur indispensables.

updateMyInfo

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

PUT

Permet de modifier les informations relatives à l’utilisateur.

listUserOrgan

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

GET

Permet d’importer une liste d’organisations. Cette option peut être utilisée pour configurer une arborescence de groupes.

listUserGroupOrgan

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

GET

Permet d’importer une liste d’organisations.

listUserGroupInfo

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

GET

Récupère les détails du groupe {groupId}.

listUserGroupChild

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

GET

Récupère une liste de sous-groupes dans le groupe {groupId}.

Réglage

En plus des fonctions principales, vous pouvez utiliser de nombreuses autres fonctions pour créer et gérer des tags et des catégories, et modifier le tableau de bord.

Nom du service

Requête API

Type de requête

Description

getCategoryInfo

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

GET

Permet d’importer une liste de catégories.

deleteDashboard

/restapi/v1.0/ems/dashboard

DELETE

Permet de supprimer des informations de tableau de bord spécifiques.

listDashboardInfo

/restapi/v1.0/ems/dashboard

GET

Permet d’importer du contenu à afficher sur le tableau de bord personnalisé. Vous ne pouvez afficher que des informations spécifiques sur le tableau de bord.

updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUT

Permet de changer l’ordre des éléments affichés sur le tableau de bord.

createDashboard

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

GET

Permet d’activer un tableau de bord inactif.

listDashboardLoginInfo

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

GET

Permet d’importer des informations de connexion à afficher sur le tableau de bord.

listDashboardNoticeInfo

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

GET

Permet d’importer des informations de tableau d’affichage à afficher sur le tableau de bord.

deleteNoticeInfo

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

DELETE

Permet de supprimer une publication du tableau d’affichage.

listEditNoticeInfo

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

GET

Permet d’importer les détails de la publication sélectionnée.

createNoticeInfo

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

POST

Permet d’ajouter des publications au tableau d’affichage.

updateNoticeInfo

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

PUT

Permet de modifier la publication sélectionnée sur le tableau d’affichage.

listDashboardStorageInfo

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

GET

Permet d’importer des informations de stockage à afficher sur le tableau de bord.

listLicense

/restapi/v1.0/ems/license

GET

Permet d’importer une liste de licences enregistrées sur le serveur.

getServerSetupInfo

/restapi/v1.0/ems/setup

GET

Permet d’importer des paramètres relatifs au serveur. Les éléments de réglage du serveur incluent des options qui peuvent activer ou désactiver différentes fonctions sur le serveur.

getTagListInfo

/restapi/v1.0/ems/tag

POST

Permet d’importer une liste de tags enregistrés sur le serveur.

Détails sur Open API (interface utilisateur Swagger)

http://184.169.167.38:7001/MagicInfo/swagger-ui.html

Sv translation
languagede

MagicINFO Server ermöglicht es Ihnen, Content Management, Terminmanagement, Gerätemanagement usw. 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

content-controller

Content Management

content-group-controller

Inhaltsgruppen-Verwaltung

Wiedergabeliste

playlist-controller

Verwalten einer Wiedergabeliste

playlist-group-controller

Wiedergabelistengruppen-Verwaltung

Zeitplan

content-schedule-controller

Inhaltszeitplan-Verwaltung

content-schedule-group-controller

Inhaltszeitplan-Gruppenverwaltung

message-schedule-controller

Verwalten von Nachrichtenzeitplänen

message-schedule-group-controller

Nachrichten-Zeitplan-Gruppenverwaltung

Gerät

device-controller

Gerätemanagement

device-group-controller

Gerätegruppen-Verwaltung

Benutzer

user-controller

Benutzerverwaltung

user-group-controller

Benutzergruppen-Verwaltung

Einstellung

environment-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

Bei jedem Abändern des Inhalts wird die Version aktualisiert. Die aktive Version der Inhaltsangaben wird abgerufen.

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

Abrufungsdetails der {groupId}-Gruppe.

listChildGroup

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

GET

Ruft eine Liste der Untergruppen unter der {groupId}-Gruppe ab.


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

Ändert die {playlistId}-Wiedergabeliste ab. 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

Abrufungsdetails der {groupId}-Gruppe.

listChildGroup

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

GET

Ruft eine Liste der Untergruppen unter der {groupId}-Gruppe ab.

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. Der Inhaltszeitplan, wie etwa {programId}, wird neu 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

Abrufungsdetails 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

Abrufungsdetails 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 nach dem Ausführen der updateDisplayInfo-API ausführbar.

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 nach dem Ausführen der updateGeneralInfo-API ausführbar.

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 Fernbedienungs-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 nach dem Ausführen der updateSetupInfo-API ausführbar.

getCurrentStatusDisplay

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

GET

Sendet eine aktuelle Anzeigesteuerungsinformationsanfrage an ein Gerät. Wenn Sie diese API aufgerufen, wird requestId als response-Wert 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 Sie diese API aufgerufen, wird requestId als response-Wert zurückgegeben.

getCurrentStatusTime

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

GET

Importiert Zeitinformationen, die von einem Gerät gesendet wurden. Die requestId, die bei einer Anfrage bei getCurrentStatusTime erhalten wurde, muss als Parameter gesendet werden.

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 nach dem Ausführen der getUpdatedTimeInfoResult-API ausführbar.

listDeviceGroupOrgan

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

GET

Importiert eine Liste der Organisationen.

listDeviceGroupInfo

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

GET

Abrufungsdetails der {groupId}-Gruppe.

listDeviceGroupChild

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

GET

Ruft Untergruppen unter {groupId} ab.

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

Abrufungsdetails der {groupId}-Gruppe.

listUserGroupChild

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

GET

Ruft eine Liste der Untergruppen unter der {groupId}-Gruppe ab.

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)

http://184.169.167.38:7001/MagicInfo/swagger-ui.html