Page History

Versions Compared

Old Version 71

changes.mady.by.user user-dd421

Saved on May 14, 2018

compared with

New Version 72

changes.mady.by.user user-f347e

Saved on May 15, 2018

Key

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

...

Sv translation

language	en

MagicINFO Server allows you to implement content management, schedule management, device management, and other functions 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 will be 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	content-group-controller	Content group management
Playlist	playlist-controller	Managing Playlists
Playlist	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	device-group-controller	Device group management
User	user-controller	User management
User	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	Imports details of an activated version of content. The version of content is updated each time the content is edited.
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	Imports details of the {groupId} group.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Imports 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	Edits 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	Imports details of the {groupId} group.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Imports 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. A duplicate copy of the {programId} content schedule is 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	Imports 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	Imports 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 executable after updateDisplayInfo API is executed.
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 executable after updateGeneralInfo API is executed.
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 RM 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 executable after updateSetupInfo API is executed.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Sends a current display control information request to a device. If 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.If 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. This option is used for two actions: sending a request for information to a device and receiving actual device information.
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 executable after getUpdatedTimeInfoResult API is executed.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Imports a list of organizations.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Imports details of the {groupId} group.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Imports information about 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	Imports details of the {groupId} group.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Imports 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

language	it

Premium MagicINFO 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 chiamata	Descrizione
authenticationRequest	/auth	POST	Importa il valore di un token per l'autenticazione usando l'ID utente e la password.
authenticationRequest	/auth/refresh	GET	Crea un nuovo token per ampliare il tempo di scadenza. È possibile chiamare REST API senza effettuare nuovamente l'accesso

OPEN API (v2.0)

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

Categoria	Controller	Descrizione
Contenuto	contenuto-controller	Gestione contenuti
Contenuto	contenuto-gruppo-controller	Gestione del gruppo di contenuti
Playlist	playlist-controller	Gestione di una playlist
Playlist	playlist-gruppo-controller	Gestione del gruppo di playlist
Programma	contenuto-programmazione-controller	Gestione programmazione di contenuti
	contenuto-programmazione-gruppo-controller	Gestione del gruppo di programmazioni di contenuti
	messaggio-programmazione-controller	Gestione dei programmi messaggio
	messaggio-programmazione-gruppo-controller	Gestione del gruppo di programmazioni di messaggi
Dispositivo	dispositivo-controller	Gestione dispositivo
Dispositivo	dispositivo-gruppo-controller	Gestione del gruppo di dispositivi
Utente	utente-controller	Gestione utente
Utente	utente-gruppo-controller	Gestione gruppo utente
Impostazioni	ambiente-controller	Impostazioni

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 chiamata	Descrizione
listAllContent	/restapi/v1.0/cms/contents	GET	Importa 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	GET	Importa le informazioni dei contenuti generali da visualizzare sulla dashboard.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importa 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}	DELETE	Elimina contenuto, a prescindere dal fatto che sia incluso in una playlist o in una programmazione.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Elimina 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}	GET	Importa 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	PUT	Approva/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}	POST	Esegue l'upload di contenuto nuovo.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importa un elenco di gruppi di contenuti predefiniti.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importa 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 chiamata	Descrizione
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importa 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	POST	Crea una nuova playlist.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importa informazioni necessarie sulla playlist dalla dashboard.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importa 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}	DELETE	Elimina 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}	GET	Importa 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}	PUT	Modifica 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	PUT	Copia la playlist {playlistId}. Si crea una copia duplicata della playlist.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importa un elenco di gruppi di playlist predefinite.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	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 chiamata	Descrizione
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importa 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	POST	Crea 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	GET	Importa informazioni necessarie sulla programmazione di contenuti dalla dashboard.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importa 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}	DELETE	Elimina 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}	GET	Importa dettagli della programmazione selezionata.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Modifica 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	PUT	Copia la programmazione di contenuti {programId}. Si crea una copia duplicata della programmazione di contenuti {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Pubblica una programmazione di contenuti su un gruppo specifico di dispositivi.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Importa lo stato di download in tempo reale di una programmazione di contenuti dal dispositivo.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importa un elenco di gruppi principali per una programmazione di contenuti.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importa un elenco di tutte le programmazioni di messaggi.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Crea 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}	DELETE	Elimina 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}	GET	Importa dettagli della programmazione di messaggi selezionata.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Modifica 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	PUT	Copia la programmazione di messaggi selezionata. Si crea una copia duplicata della programmazione di messaggi.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Pubblica la programmazione di messaggi selezionata su un gruppo di dispositivi.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importa un elenco di gruppi principali per una programmazione di contenuti.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importa 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 chiamata	Descrizione
listAllDevice	/restapi/v1.0/rms/devices	GET	Importa 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	GET	Importa informazioni necessarie sul dispositivo dalla dashboard.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importa 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}	DELETE	Elimina il dispositivo selezionato.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importa dettagli del dispositivo selezionato.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Approva il dispositivo selezionato su un gruppo specifico.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importa 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	PUT	Modifica informazioni sui case collegati a un dispositivo LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importa 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	PUT	Invia 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}	GET	Riceve 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	GET	Importa 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	PUT	Invia 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}	GET	Riceve informazioni modificate sul dispositivo da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Sposta un dispositivo su un altro gruppo.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Invia 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	GET	Invia 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	GET	Importa 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	PUT	Invia 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}	GET	Riceve 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	GET	Invia 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}	GET	Importa 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	GET	Invia 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}	GET	Importa 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	GET	Importa 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	PUT	Invia 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	GET	Importa un elenco di organizzazioni.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importa 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 chiamata	Descrizione
createUser	/restapi/v1.0/ums/users	POST	Aggiunge un utente.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importa informazioni necessarie sull'utente dalla dashboard.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Modifica le informazioni utente.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importa un elenco di organizzazioni. È possibile usare questa opzione per configurare un albero dei gruppi.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importa un elenco di organizzazioni.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importa 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 chiamata	Descrizione
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importa un elenco di categorie.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Elimina specifiche informazioni della dashboard.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importa contenuti da visualizzare sulla dashboard personalizzata. È possibile visualizzare solo informazioni specifiche sulla dashboard.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Cambia l'ordine degli elementi visualizzati sulla dashboard.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Attiva una dashboard inattiva.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importa le informazioni di accesso da visualizzare sulla dashboard.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importa le informazioni della bacheca da visualizzare sulla dashboard.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Elimina una pubblicazione dalla bacheca.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importa dettagli della pubblicazione selezionata.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Aggiunge pubblicazioni alla bacheca.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Modifica la pubblicazione selezionata sulla bacheca.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importa le informazioni di archiviazione da visualizzare sulla dashboard.
listLicense	/restapi/v1.0/ems/license	GET	Importa un elenco di licenze registrate sul server.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importa 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	POST	Importa un elenco di tag registrati sul server.

Dettagli Open API (swagger UI)

Open API Documentation

docExpansion	nessuno
validatorUrl	nessuno
operationsSorter	metodo
url	http://184.169.167.38:7001/MagicInfo/v2/api-docs/

...

Content

Space Tools

Page History

Versions Compared

Old Version 71

New Version 72

Key

Authentication

OPEN API (v2.0)

Content

Playlist

Schedule

Device

User

Setting

Open API Details (swagger UI)

Autenticazione

OPEN API (v2.0)

Contenuto

Playlist

Programma

Dispositivo

Utente

Impostazioni

Dettagli Open API (swagger UI)