Versions Compared

Old Version 12

changes.mady.by.user AST01

Saved on

compared with

New Version 13

changes.mady.by.user AST01

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.

...

Sv translation
languageen

MagicINFO Server allows you to implement content management, schedule management, device management, and such by calling Open API (v2.0). 

To use Open API (v2.0), you will first need to go through an authentication process. Use a separate swagger page to test each API.

Authentication

When calling all Open API (v2.0) items, api_token must be included in the header. If this is not included, a "401 Unauthorized." error is returned.

An obtained token expires and becomes unavailable for use after a specified period of time. If this is the case, you should obtain a new token.

api_token can be obtained by calling the following api.

Service Name

API call

Call Type

Description

authenticationRequest

/auth

POST

Imports a token value for authentication using the user ID and password.

authenticationRequest

/auth/refresh

GET

Creates a new token to extend the expire time. It is possible to call REST API without logging in again

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) provides a variety of functions. Configuration of each function is shown below.

Category

Controller

Description

Content

content-controller

Content file management

content-group-controller

Content group management

Playlist

playlist-controller

Managing Playlists

playlist-group-controller

Playlist group management

Schedule

content-schedule-controller

Content schedule management

content-schedule-group-controller

Content schedule group management

message-schedule-controller

Managing Message Schedules

message-schedule-group-controller

Message schedule group management

Device

device-controller

Device management

device-group-controller

Device group management

User

user-controller

User management

user-group-controller

User group management

Setting

environment-controller

Setting

Content

Upload, approve, or delete content. Manage content lists. Content-related services are accessible to authenticated users with privileges to read, write, and manage content.

Available content management services are as follows:

Service Name

API call

Call Type

Description

listAllContent

/restapi/v1.0/cms/contents

GET

Imports a list of uploaded content. Content thumbnails, names, file types, and other basic information are included in the list. Lists can be imported per page, using paging information.

listDashboardContentInfo

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

GET

Imports general content information to be displayed on the dashboard.

listContent

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

POST

Imports a list of content filtered based on conditions. Lists can be imported per page, using paging information.

forceDeleteContent

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

DELETE

Deletes content, whether or not the content is included in a playlist or schedule.

deleteContent

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

DELETE

Deletes content after checking that the content is not included in a playlist or schedule. If attempting to delete content included in a playlist or schedule, the content will not be deleted and an error code will be returned.

getActiveContentInfo

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

GET

Whenever content is modified, its version is updated. The active version of content details is fetched.

approveContents

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

PUT

Approves/rejects content. Approved content is moved to the general content list and can be used in playlists or schedules.

uploadContent

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

POST

Uploads new content.

listDefaultGroup

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

GET

Imports a list of default content groups.

getGroup

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

GET

Fetches details of the {groupId} group.

listChildGroup

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

GET

Fetches a list of sub groups under the {groupId} group.


Playlist

Use content to create, edit, or delete playlists. Playlist-related services are accessible to authenticated users with privileges to read, write, and manage content.

Available playlist management services are as follows:

Service Name

API call

Call Type

Description

listAllPlaylist

/restapi/v1.0/cms/playlists

GET

Imports a list of all playlists. Playlist names, main content thumbnails, playlist types, and other basic information are included in the list. Lists can be imported per page, using paging information.

createPlaylist

/restapi/v1.0/cms/playlists

POST

Creates a new playlist.

getDashboardPlaylistInfo

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

GET

Imports necessary playlist information from the dashboard.

listPlaylist

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

POST

Imports a list of playlists filtered based on conditions. Lists can be imported per page, using paging information.

deletePlaylist

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

DELETE

Deletes the selected playlist. If attempting to delete a playlist included in a schedule, the playlist will not be deleted and an error code will be returned.

getActivePlaylistInfo

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

GET

Imports details of an activated version of a playlist. The version of a playlist is updated each time the playlist is edited.

editPlaylist

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

PUT

Modifies the {playlistId} playlist. Editing a playlist updates the playlist version, and causes the device playing the playlist to automatically play the updated playlist.

copyPlaylist

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

PUT

Copies the {playlistId} playlist. A duplicate copy of the playlist is created.

listDefaultGroup

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

GET

Imports a list of default playlist groups.

getGroup

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

GET

Fetches details of the {groupId} group.

listChildGroup

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

GET

Fetches a list of sub groups under the {groupId} group.

Schedule

Create new content or message schedules. Publish schedules to devices for playback. Edit or delete schedules.

Schedule-related services are accessible to authenticated users with privileges to read, write, and manage schedules.

Available schedule management services are as follows:

Service Name

API call

Call Type

Description

listContentScheduleAll

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

GET

Imports a list of all content schedules. Content schedule names, dates of creation, device types, and other basic information are included in the list. Lists can be imported per page, using paging information.

createContentSchedule

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

POST

Creates a new content schedule. A content schedule may contain multiple channels and frames. Publish a schedule to devices and play the desired content or playlist at a specified time.

listDashboardScheduleInfo

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

GET

Imports necessary content schedule information from the dashboard.

listContentScheduleByGroup

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

POST

Imports a list of content schedules filtered based on different conditions. Lists can be imported per page, using paging information.

deleteContentSchedule

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

DELETE

Deletes a content schedule. If deleting a schedule previously published to a device, the device automatically plays the default content.

getProgramInfo

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

GET

Imports details of the selected schedule.

editContentSchedule

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

PUT

Edits a content schedule. If editing a schedule previously published to a device, the device automatically plays the edited schedule.

copyContentSchedule

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

PUT

Copies the {programId} content schedule. The content schedule such as {programId} is newly created.

deployContentSchedule

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

PUT

Publishes a content schedule to a specific device group.

getPublishStatus

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

GET

Imports real-time content schedule download status from a device.

getRootGroups

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

GET

Imports a list of root groups for a content schedule.

listContentScheduleGroupInfo

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

GET

Fetches details of the {groupId} group.

listAllMessageSchedule

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

GET

Imports a list of all message schedules.

createMessageSchedule

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

POST

Creates a new message schedule.

listMessage

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

POST

Imports a list of message schedules filtered based on different conditions. Lists can be imported per page, using paging information.

deleteMessageSchedule

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

DELETE

Deletes the selected message schedule. If deleting a message schedule previously published to a device, the change is automatically applied to the device.

getMessageInfo

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

GET

Imports details of the selected message schedule.

editMessageSchedule

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

PUT

Edits the selected message schedule. If editing a message schedule previously published to a device, the change is automatically applied to the device.

copyMessageSchedule

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

PUT

Copies the selected message schedule. A duplicate copy of the message schedule is created.

deployMessageSchedule

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

PUT

Publishes the selected message schedule to a device group.

getRootGroups

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

GET

Imports a list of root groups for a content schedule.

listMessageScheduleGroupInfo

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

GET

Fetches details of the {groupId} group.

getChildGroups

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

GET

Imports a list of sub-groups under a specific group.

Device

Control and manage devices. Device-related services are accessible to authenticated users with privileges to read, write, and manage devices.

Available device management services are as follows:

Service Name

API call

Call Type

Description

listAllDevice

/restapi/v1.0/rms/devices

GET

Imports a list of all devices. Device power status, thumbnail info, device error status, and other basic information are included in the list. Lists can be imported per page, using paging information.

getDashboardDeviceInfo

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

GET

Imports necessary device information from the dashboard.

filterDeviceList

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

POST

Imports a list of devices filtered based on different conditions. Lists can be imported per page, using paging information.

deleteDevice

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

DELETE

Deletes the selected device.

getDevice

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

GET

Imports details of the selected device.

approveDevice

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

PUT

Approves the selected device to a specific group.

getCabinetList

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

POST

Imports information about cabinets connected to an LED device. The imported information is valid only when the cabinets are connected to an LED device.

updateCabinetInfo

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

PUT

Edits information about cabinets connected to an LED device.

getDisplayControlInfo

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

GET

Imports device display control information from the database. If control information is not present, an information request should be sent to the device.

updateDisplayInfo

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

PUT

Sends edited display control information to a device. Only edited values in display information are sent as a protocol to the device.

getUpdatedDisplayInfoResult

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

GET

Receives edited display control information from a device. This API is run after executing the updateDisplayInfo API.

getGeneralInfo

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

GET

Imports general device information from the database. General device information is updated when the device connects to the server.

updateGeneralInfo

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

PUT

Sends edited device information to a device. Only edited values in basic device information are sent as a protocol to the device.

getUpdatedGeneralInfoResult

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

GET

Receives edited device information from a device. This API is run after executing the updateGeneralInfo API.

moveDevice

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

PUT

Moves a device to another group.

startRmServerVnc

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

GET

Sends an RM start protocol to a device. A device that received an RM start protocol sends information periodically via the Remote control Server.

stopRmServerVnc

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

GET

Sends an RM stop protocol to a device. A device that received a stop protocol stops the corresponding function immediately.

getSetupInfo

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

GET

Imports device settings. Device settings are updated when the device connects to the server.

updateSetupInfo

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

PUT

Sends edited device settings to a device. Only edited values in settings are sent as a protocol to the device.

getUpdatedSetupInfoResult

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

GET

Receives edited device settings from a device. This API is run after executing the updateSetupInfo API.

getCurrentStatusDisplay

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

GET

Sends a current display control information request to a device. When calling this API, requestId is returned as the response value.

getCurrentStatusDisplay

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

GET

Imports display control information sent from a device. This option is used for two actions: sending a request for information to a device and receiving actual device information.

getCurrentStatusTime

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

GET

Sends a current time information request to a device. When calling this API, requestId is returned as the response value.

getCurrentStatusTime

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

GET

Imports time information sent from a device. requestId received by calling getCurrentStatusTime must be sent as a parameter.

getTimeInfo

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

GET

Imports device time information from the database. If control information is not present, an information request should be sent to the device.

updateTimeInfo

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

PUT

Sends edited time information to a device. Only edited values in time information are sent as a protocol to the device.

getUpdatedTimeInfoResult

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

GET

Receives edited device time information from a device. This API is run after executing the getUpdatedTimeInfoResult API.

listDeviceGroupOrgan

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

GET

Imports a list of organizations.

listDeviceGroupInfo

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

GET

Fetches details of the {groupId} group.

listDeviceGroupChild

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

GET

Fetches sub groups under {groupId}.

User

Add users and manage user information. User-related services are accessible to authenticated users with privileges to read, write, and manage user information.

Available user management services are as follows:

Service Name

API call

Call Type

Description

createUser

/restapi/v1.0/ums/users

POST

Adds a user.

listDashboardUserInfo

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

GET

Imports necessary user information from the dashboard.

updateMyInfo

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

PUT

Edits user information.

listUserOrgan

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

GET

Imports a list of organizations. This option can be used to configure a group tree.

listUserGroupOrgan

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

GET

Imports a list of organizations.

listUserGroupInfo

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

GET

Fetches details of the {groupId} group.

listUserGroupChild

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

GET

Fetches a list of sub groups under the {groupId} group.

Setting

In addition to main functions, you can use many other functions to create and manage tags and categories, and edit the dashboard.

Service Name

API call

Call Type

Description

getCategoryInfo

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

GET

Imports a list of categories.

deleteDashboard

/restapi/v1.0/ems/dashboard

DELETE

Deletes specific dashboard information.

listDashboardInfo

/restapi/v1.0/ems/dashboard

GET

Imports content to be displayed on the customized dashboard. It is possible to display only specific information on the dashboard.

updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUT

Changes the order of items displayed on the dashboard.

createDashboard

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

GET

Activates an idle dashboard.

listDashboardLoginInfo

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

GET

Imports login information to be displayed on the dashboard.

listDashboardNoticeInfo

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

GET

Imports bulletin board information to be displayed on the dashboard.

deleteNoticeInfo

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

DELETE

Deletes a post from the bulletin board.

listEditNoticeInfo

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

GET

Imports details of the selected post.

createNoticeInfo

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

POST

Adds posts to the bulletin board.

updateNoticeInfo

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

PUT

Edits the selected post on the bulletin board.

listDashboardStorageInfo

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

GET

Imports storage information to be displayed on the dashboard.

listLicense

/restapi/v1.0/ems/license

GET

Imports a list of licenses registered on the server.

getServerSetupInfo

/restapi/v1.0/ems/setup

GET

Imports server settings. Server setting items include options that can turn on or off different functions on the server.

getTagListInfo

/restapi/v1.0/ems/tag

POST

Imports a list of tags registered on the server.

Open API Details (swagger UI)

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

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