Versions Compared

Old Version 87

changes.mady.by.user user-f347e

Saved on

compared with

New Version 88

changes.mady.by.user user-f347e

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
languageru


MagicINFO Server позволяет реализовать управление содержимым, расписаниями, устройствами, а также другие функции с помощью вызова методов Open API (v2.0).

Для того, чтобы использовать Open API (v2.0), сперва нужно пройти процедуру аутентификации. Используйте отдельную swagger-страницу для проверки каждого API.

Проверка подлинности

При вызове объектов Open API (v2.0) необходимо включить в заголовок api_token. В противном случае появится ошибка "401 Нет доступа".

Маркер доступа становится недоступным для использования по истечении срока действия. В этом случае необходимо получить новый маркер доступа.

Получить маркер доступа api_token можно путем вызова следующего api.

Название услуги

Вызов API

Тип вызоваОписание
Запрос «Аутентификация»

/auth

POST (создание)Импорт значения маркера доступа для аутентификации с использованием ИД и пароля пользователя.
Запрос «Аутентификация»

/auth/refresh

GET (чтение)Создание нового маркера доступа для продления срока действия. Вызов REST API можно осуществлять без повторного входа в систему.

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) предлагает множество функций. Конфигурация каждой функции представлена ниже.

КатегорияКонтроллерОписание
Содержимоеcontent-controllerУправление файлом содержимого
content-group-controllerУправление группами содержимого
Плейлистplaylist-controllerУправление списком воспроизведения
playlist-group-controllerУправление группами списков воспроизведения
Расписаниеcontent-schedule-controllerУправление расписаниями содержимого
content-schedule-group-controllerУправление группами расписаний содержимого
message-schedule-controllerУправление расписанием сообщений
message-schedule-group-controllerУправление группами расписаний сообщений
Устройствоdevice-controllerУправление устройствами
device-group-controllerУправление группами устройств
Пользовательuser-controllerУправление пользователями
user-group-controllerУправление группами пользователей
Настройкаenvironment-controllerНастройка

Содержимое

Загрузить, подтвердить или удалить содержимое. Управление списками содержимого Службы для работы с содержимым доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление содержимым.

Ниже приведены доступные службы управления содержимым:

Название услуги

Вызов API

Тип вызоваОписание
listAllContent

/restapi/v1.0/cms/contents

GET (чтение)Импорт списка всего загруженного содержимого. Список содержит эскизы, имена, типы файлов и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
listDashboardContentInfo

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

GET (чтение)Импорт общих сведений о содержимом, отображаемом на панели управления.
listContent

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

POST (создание)Импорт списка содержимого, отсортированного по параметрам. Загружать списки можно постранично, используя постраничную информацию.
forceDeleteContent

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

DELETE (удалить)Удаление содержимого вне зависимости, включено оно в список воспроизведения или расписание.
deleteContent

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

DELETE (удалить)Удаление содержимого после проверки его содержания в списке воспроизведения или расписании. Если содержимое включено в список воспроизведения или расписание, то при попытке его удаления отобразится код ошибки.
getActiveContentInfo

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

GET (чтение)Импорт подробных сведений об активированной версии списка содержимого. Версия списка содержимого обновляется каждый раз при его изменении.
approveContents

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

PUT (заполнение)Подтверждение/отклонение содержимого. Подтвержденное содержимое перемещается в общий список и может использоваться в списках воспроизведения или расписаниях.
uploadContent

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

POST (создание)Загрузка нового содержимого.

listDefaultGroup

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

GET (чтение)Импорт перечня групп содержимого по умолчанию.
getGroup

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

GET (чтение)Импорт подробных сведений о {groupId} группе.
listChildGroup

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

GET (чтение)Импорт списка подгрупп под указанной {groupId} группой.


Плейлист

Используйте содержимое для создания, изменения или удаления списков воспроизведения. Службы для работы со списками воспроизведения доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление содержимым.

Ниже приведены доступные службы управления списками воспроизведения:

Название услуги

Вызов API

Тип вызоваОписание
listAllPlaylist

/restapi/v1.0/cms/playlists

GET (чтение)Импорт перечня всех списков воспроизведения. Перечень содержит имена списков воспроизведения, эскизы основного содержимого, типы списков воспроизведения и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
createPlaylist

/restapi/v1.0/cms/playlists

POST (создание)Создание нового списка воспроизведения.

getDashboardPlaylistInfo

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

GET (чтение)Импорт необходимых сведений о списке воспроизведения с приборной панели.

listPlaylist

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

POST (создание)Импорт перечня списков воспроизведения, отсортированных по параметрам. Загружать списки можно постранично, используя постраничную информацию.

deletePlaylist

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

DELETE (удалить)удаление выбранного списка воспроизведения. Если список воспроизведения включен в расписание, то при попытке его удаления отобразится код ошибки.

getActivePlaylistInfo

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

GET (чтение)Импорт подробных сведений об активированной версии списка воспроизведения. Версия списка воспроизведения обновляется каждый раз при его изменении.

editPlaylist

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

PUT (заполнение)Изменение {playlistId} списка воспроизведения. При изменении списка воспроизведения его версия обновляется, таким образом устройство автоматически проигрывает обновленный список воспроизведения.

copyPlaylist

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

PUT (заполнение)Копирование {playlistId} списка воспроизведения. Создается дубликат списка воспроизведения.
listDefaultGroup

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

GET (чтение)Импорт перечня групп списков воспроизведения по умолчанию.

getGroup

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

GET (чтение)Импорт подробных сведений о {groupId} группе.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET (чтение)

Импорт списка подгрупп под указанной {groupId} группой.

Расписание

Создание нового содержимого или расписания сообщений. Публикация расписания для воспроизведения на устройствах. Изменение или удаление расписаний.

Службы для работы с расписаниями доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление расписаниями.

Ниже приведены доступные службы управления расписаниями:

Название услуги

Вызов API

Тип вызоваОписание
listContentScheduleAll

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

GET (чтение)Импорт перечня всех расписаний содержимого. Перечень содержит имена расписаний содержимого, даты создания, типы устройств и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
createContentSchedule

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

POST (создание)Создание нового расписания содержимого. Расписание содержимого может содержать несколько каналов и кадров. Публикация расписания на устройствах и воспроизведение нужного содержимого или списка воспроизведения в указанное время.
listDashboardScheduleInfo

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

GET (чтение)Импорт необходимых сведений о расписании содержимого с приборной панели.
listContentScheduleByGroup

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

POST (создание)Импорт списка расписаний содержимого, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteContentSchedule

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

DELETE (удалить)Удаление расписания содержимого. При удалении расписания, ранее опубликованного на устройстве, автоматически выполняется воспроизведение содержимого по умолчанию.
getProgramInfo

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

GET (чтение)Импорт подробных сведений о выбранном расписании.
editContentSchedule

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

PUT (заполнение)Изменение расписания файла содержимого. При изменении расписания, ранее опубликованного на устройстве, автоматически выполняется воспроизведение отредактированного расписания.
copyContentSchedule

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

PUT (заполнение)Копирование {programId} расписания содержимого. Создается дубликат расписания содержимого {programId}.
deployContentSchedule

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

PUT (заполнение)Публикация расписания содержимого в указанной группе устройств.
getPublishStatus

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

GET (чтение)Импорт состояния загрузки расписания содержимого в режиме реального времени с устройства.
getRootGroups

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

GET (чтение)Импорт списка исходных групп для расписания содержимого.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GET (чтение)Импорт подробных сведений о {groupId} группе.
listAllMessageSchedule

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

GET (чтение)Импорт списка всех расписаний сообщений.
createMessageSchedule

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

POST (создание)Создание нового расписания сообщений.
listMessage

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

POST (создание)

Импорт списка расписаний сообщений, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteMessageSchedule

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

DELETE (удалить)Удаление выбранного расписания сообщений. При удалении расписания сообщений, ранее опубликованного на устройстве, внесенные изменения применяются автоматически.
getMessageInfo

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

GET (чтение)Импорт подробных сведений о выбранном расписании сообщений.
editMessageSchedule

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

PUT (заполнение)Изменение выбранного расписания сообщений. При изменении расписания сообщений, ранее опубликованного на устройстве, внесенные изменения применяются автоматически.
copyMessageSchedule

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

PUT (заполнение)Копирование выбранного расписания сообщений. Создается дубликат расписания сообщений.
deployMessageSchedule

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

PUT (заполнение)Публикация выбранного расписания сообщений в группе устройств.
getRootGroups

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

GET (чтение)Импорт списка исходных групп для расписания содержимого.
listMessageScheduleGroupInfo

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

GET (чтение)Импорт подробных сведений о {groupId} группе.
getChildGroups

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

GET (чтение)Импорт списка подгрупп под указанной группой.

Устройство

Контроль и управление устройствами. Службы по работе с устройствами доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление устройствами.

Ниже приведены доступные службы управления устройствами:

Название услуги

Вызов API

Тип вызоваОписание
listAllDevice

/restapi/v1.0/rms/devices

GET (чтение)Импорт списка всех устройств. Список содержит состояние питания устройства, информацию об эскизе, статусы ошибок устройства и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
getDashboardDeviceInfo

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

GET (чтение)Импорт необходимых сведений об устройстве с приборной панели.
filterDeviceList

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

POST (создание)Импорт списка устройств, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteDevice

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

DELETE (удалить)удаление выбранного устройства.
getDevice

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

GET (чтение)Импорт подробных сведений о выбранном устройстве.
approveDevice

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

PUT (заполнение)Подтверждение выбранного устройства в указанной группе.
getCabinetList

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

POST (создание)Импорт сведений о блоках, подключенных к светодиодному устройству. Полученные сведения действительны только при условии подключения блоков к светодиодному устройству.
updateCabinetInfo

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

PUT (заполнение)Изменение сведений о блоках, подключенных к светодиодному устройству.
getDisplayControlInfo

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

GET (чтение)Импорт сведений об управлении экраном устройства из базы данных. В случае отсутствия сведений об управлении, запрос на их получение отправляется в устройство.
updateDisplayInfo

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

PUT (заполнение)Отправка отредактированной информации об управлении экраном на устройство. Сведения об экране, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedDisplayInfoResult

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

GET (чтение)Получение отредактированной информации об управлении экраном из устройства. Выполнение этого запроса API возможно после завершения запроса updateDisplayInfo API.
getGeneralInfo

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

GET (чтение)Импорт общих сведений об устройстве из базы данных. Общие сведения устройства обновляются при его подключении к серверу.
updateGeneralInfo

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

PUT (заполнение)Отправка отредактированной информации на устройство. Общие сведения об устройстве, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedGeneralInfoResult

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

GET (чтение)Получение отредактированной информации об устройстве. Выполнение этого запроса API возможно после завершения запроса updateGeneralInfo API.
moveDevice

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

PUT (заполнение)Перемещение устройства в другую группу.
startRmServerVnc

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

GET (чтение)Отправка протокола запуска RM на устройство. С устройства, на которое принят стартовый протокол RM, периодически отправляются сведения через сервер дистанционного управления.
stopRmServerVnc

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

GET (чтение)Отправка протокола остановки RM на устройство. Устройство незамедлительно останавливает выполнение соответствующей функции при получении протокола с остановкой.
getSetupInfo

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

GET (чтение)Импорт параметров устройства. Параметры устройства обновляются при его подключении к серверу.
updateSetupInfo

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

PUT (заполнение)Отправка измененных параметров на устройство. Настройки, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedSetupInfoResult

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

GET (чтение)Получение измененных параметров от устройство. Выполнение этого запроса API возможно после завершения запроса updateSetupInfo API.
getCurrentStatusDisplay

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

GET (чтение)Отправка запроса текущей информации об управлении экраном на устройство. При вызове этого API запрос отображается в виде ответного значения.
getCurrentStatusDisplay

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

GET (чтение)Импорт информации об управлении экраном, отправленной с устройства. Эта опция используется для выполнения двух действий: отправка запроса информации на устройство и получение информации о нем.
getCurrentStatusTime

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

GET (чтение)Отправка запроса информации о текущем времени на устройство. При вызове этого API запрос отображается в виде ответного значения.
getCurrentStatusTime

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

GET (чтение)Импорт информации о времени экраном, отправленной с устройства. Эта опция используется для выполнения двух действий: отправка запроса информации на устройство и получение информации о нем.
getTimeInfo

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

GET (чтение)Импорт информации о времени устройства из базы данных. В случае отсутствия сведений об управлении, запрос на их получение отправляется в устройство.
updateTimeInfo

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

PUT (заполнение)Отправка отредактированной информации о времени на устройство. Сведения об времени, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedTimeInfoResult

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

GET (чтение)

Получение отредактированной информации о времени от устройства. Выполнение этого запроса API возможно после завершения запроса getUpdatedTimeInfoResult API.

listDeviceGroupOrgan

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

GET (чтение)Импорт списка организаций.
listDeviceGroupInfo

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

GET (чтение)Импорт подробных сведений о {groupId} группе.
listDeviceGroupChild

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

GET (чтение)Импорт информации о подгруппах ниже {groupId}.

Пользователь

Добавляйте пользователей и управляйте информацией о них. Службы для работы с пользователями доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление информацией о пользователях.

Ниже приведены доступные службы управления пользователями:

Название услуги

Вызов API

Тип вызоваОписание
createUser/restapi/v1.0/ums/usersPOST (создание)Добавление пользователя.
listDashboardUserInfo

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

GET (чтение)Импорт необходимых сведений о пользователях с панели управления.
updateMyInfo

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

PUT (заполнение)Редактирование сведений о пользователях.
listUserOrgan

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

GET (чтение)Импорт списка организаций. Данная опция используется для настройки дерева групп.
listUserGroupOrgan

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

GET (чтение)Импорт списка организаций.
listUserGroupInfo

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

GET (чтение)Импорт подробных сведений о {groupId} группе.
listUserGroupChild

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

GET (чтение)Импорт списка подгрупп под указанной {groupId} группой.

Настройка

В дополнение к основным функциям можно использовать множество других функций для создания и управления метками и категориями, а также изменения панели управления.

Название услуги

Вызов API

Тип вызоваОписание
getCategoryInfo

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

GET (чтение)Импорт списка категорий.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETE (удалить)Удаление определенной информации о панели управления.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GET (чтение)Импорт содержимого, отображаемого на пользовательской панели управления. Можно настраивать отображение только указанной информации на панели управления.
updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUT (заполнение)Изменение порядка отображения объектов на панели управления.
createDashboard

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

GET (чтение)Активация резервной панели управления.

listDashboardLoginInfo

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

GET (чтение)Импорт учетных данных, отображаемых на панели управления.
listDashboardNoticeInfo

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

GET (чтение)Импорт информации с доски объявлений, отображаемой на панели управления.
deleteNoticeInfo

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

DELETE (удалить)Удаление публикации из доски объявлений.
listEditNoticeInfo

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

GET (чтение)Импорт подробных сведений о выбранной публикации.
createNoticeInfo

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

POST (создание)Размещение публикаций на доске объявлений.
updateNoticeInfo

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

PUT (заполнение)Изменение выбранной публикации на доске объявлений.
listDashboardStorageInfo

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

GET (чтение)Импорт информации об объеме памяти, отображаемой на панели управления.

listLicense

/restapi/v1.0/ems/license

GET (чтение)Импорт списка лицензий, зарегистрированных на сервере.
getServerSetupInfo

/restapi/v1.0/ems/setup

GET (чтение)Импорт параметров сервера. Элементы настройки сервера включают опции, с помощью которых включаются или отключаются различные функции на сервере.
getTagListInfo

/restapi/v1.0/ems/tag

POST (создание)Импорт списка меток, зарегистрированных на сервере.


Открытие подробных сведений API (swagger UI)

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



Sv translation
languagezh_CN


MagicINFO Server 可让您通过调用 Open API（2.0 版）实现内容管理、日程表管理、设备管理和其他功能。

要使用 Open API（2.0 版），您首选需要通过验证流程。使用单独的 swagger 页面测试每个 API。

身份验证

调用所有 Open API（2.0 版）项目时，必须在标头中包含 api_token。如果未包含此项，将返回“401 未授权”错误。

经过指定的时间段后，获得的令牌过期并且变为不可用。如果是这种情况，应获得新令牌。

通过调用以下 api 可获得 api_token。

服务名称

API 调用

调用类别说明
authenticationRequest

/auth

POST使用用户 ID 和密码导入令牌值以进行验证。
authenticationRequest

/auth/refresh

GET创建新令牌以延长过期时间。可以调用 REST API 而无需再次登录

OPEN API（2.0 版）

MagicINFO Server Open API（2.0 版）提供各种功能。每种功能的配置如下所示。

类别控制器说明
内容content-controller内容文件管理
content-group-controller内容组管理
播放列表playlist-controller管理播放列表
playlist-group-controller播放列表组管理
日程表content-schedule-controller内容日程表管理
content-schedule-group-controller内容日程表组管理
message-schedule-controller管理消息日程表
message-schedule-group-controller消息日程表组管理
设备device-controller设备管理
device-group-controller设备组管理
用户user-controller用户管理
user-group-controller用户组管理
设置environment-controller设置

内容

上传、批准或删除内容。管理内容列表。具有读取、写入和管理内容权限的经验证用户可以访问内容相关服务。

可用的内容管理服务如下：

服务名称

API 调用

调用类别说明
listAllContent

/restapi/v1.0/cms/contents

GET导入已上传内容的列表。内容缩略图、名称、文件类型和其他基本信息均包含在该列表中。列表可以使用分页信息每页导入。
listDashboardContentInfo

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

GET导入要在仪表板上显示的常规内容信息。
listContent

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

POST导入基于条件筛选的内容列表。列表可以使用分页信息每页导入。
forceDeleteContent

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

DELETE删除内容，无论内容是否包含在播放列表或日程表中。
deleteContent

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

DELETE检查内容未包含在播放列表或日程表中后删除内容。如果尝试删除包含在播放列表或日程表中的内容，将不会删除该内容，并且将返回错误代码。
getActiveContentInfo

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

GET导入激活内容版本的详细信息。每次编辑内容时都会更新内容版本。
approveContents

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

PUT批准/拒绝内容。批准的内容将移动到常规内容列表，并可在播放列表或日程表中使用。
uploadContent

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

POST上传新内容。

listDefaultGroup

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

GET导入默认内容组的列表。
getGroup

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

GET导入 {groupId} 组的详细信息。
listChildGroup

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

GET导入 {groupId} 组下子组的列表。


播放列表

使用内容创建、编辑或删除播放列表。具有读取、写入和管理内容权限的经验证用户可以访问播放列表相关服务。

可用的播放列表管理服务如下：

服务名称

API 调用

调用类别说明
listAllPlaylist

/restapi/v1.0/cms/playlists

GET导入所有播放列表的列表。播放列表名称、主要内容缩略图、播放列表类型和其他基本信息均包含在该列表中。列表可以使用分页信息每页导入。
createPlaylist

/restapi/v1.0/cms/playlists

POST创建新播放列表。

getDashboardPlaylistInfo

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

GET从仪表板导入必要的播放列表信息。

listPlaylist

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

POST导入基于条件筛选的播放列表的列表。列表可以使用分页信息每页导入。

deletePlaylist

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

DELETE删除所选播放列表。如果尝试删除包含在日程表中的播放列表，将不会删除该播放列表，并且将返回错误代码。

getActivePlaylistInfo

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

GET导入激活播放列表版本的详细信息。每次编辑播放列表时都会更新播放列表版本。

editPlaylist

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

PUT编辑 {playlistId} 播放列表。编辑播放列表会更新播放列表版本，并使播放该播放列表的设备自动播放更新的播放列表。

copyPlaylist

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

PUT复制 {playlistId} 播放列表。创建播放列表的复制副本。
listDefaultGroup

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

GET导入默认播放列表组的列表。

getGroup

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

GET导入 {groupId} 组的详细信息。
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET

导入 {groupId} 组下子组的列表。

日程表

创建新的内容或消息日程表。将日程表发布到设备以进行播放。编辑或删除日程表。

具有读取、写入和管理日程表权限的经验证用户可以访问日程表相关服务。

可用的日程表管理服务如下：

服务名称

API 调用

调用类别说明
listContentScheduleAll

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

GET导入所有内容日程表的列表。内容日程表名称、创建日期、设备类型和其他基本信息均包含在该列表中。列表可以使用分页信息每页导入。
createContentSchedule

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

POST创建新的内容日程表。内容日程表可能包含多个频道和框架。将日程表发布到设备并在指定的时间播放所需内容或播放列表。
listDashboardScheduleInfo

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

GET从仪表板导入必要的内容日程表信息。
listContentScheduleByGroup

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

POST导入基于不同条件筛选的内容日程表列表。列表可以使用分页信息每页导入。
deleteContentSchedule

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

DELETE删除内容日程表。如果删除以前发布到设备的日程表，设备会自动播放默认内容。
getProgramInfo

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

GET导入所选日程表的详细信息。
editContentSchedule

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

PUT编辑内容日程表。如果编辑以前发布到设备的日程表，设备会自动播放编辑的日程表。
copyContentSchedule

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

PUT复制 {programId} 内容日程表。创建 {programId} 内容日程表的复制副本。
deployContentSchedule

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

PUT将内容日程表发布到特定的设备组。
getPublishStatus

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

GET从设备导入实时内容日程表下载状态。
getRootGroups

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

GET导入内容日程表根组的列表。
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GET导入 {groupId} 组的详细信息。
listAllMessageSchedule

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

GET导入所有消息日程表的列表。
createMessageSchedule

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

POST创建新的消息日程表。
listMessage

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

POST

导入基于不同条件筛选的消息日程表列表。列表可以使用分页信息每页导入。
deleteMessageSchedule

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

DELETE删除所选消息日程表。如果删除以前发布到设备的消息日程表，更改会自动应用到设备。
getMessageInfo

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

GET导入所选消息日程表的详细信息。
editMessageSchedule

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

PUT编辑所选消息日程表。如果编辑以前发布到设备的消息日程表，更改会自动应用到设备。
copyMessageSchedule

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

PUT复制所选消息日程表。创建消息日程表的复制副本。
deployMessageSchedule

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

PUT将所选消息日程表发布到设备组。
getRootGroups

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

GET导入内容日程表根组的列表。
listMessageScheduleGroupInfo

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

GET导入 {groupId} 组的详细信息。
getChildGroups

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

GET导入特定组下子组的列表。

设备

控制和管理设备。具有读取、写入和管理设备权限的经验证用户可以访问设备相关服务。

可用的设备管理服务如下：

服务名称

API 调用

调用类别说明
listAllDevice

/restapi/v1.0/rms/devices

GET导入所有设备的列表。设备电源状态、缩略图信息、设备错误状态和其他基本信息均包含在该列表中。列表可以使用分页信息每页导入。
getDashboardDeviceInfo

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

GET从仪表板导入必要的设备信息。
filterDeviceList

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

POST导入基于不同条件筛选的设备列表。列表可以使用分页信息每页导入。
deleteDevice

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

DELETE删除所选的设备。
getDevice

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

GET导入所选设备的详细信息。
approveDevice

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

PUT批准所选设备到特定组。
getCabinetList

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

POST导入连接到 LED 设备的机柜的相关信息。导入的信息仅当机柜连接到 LED 设备时有效。
updateCabinetInfo

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

PUT编辑连接到 LED 设备的机柜的相关信息。
getDisplayControlInfo

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

GET从数据库导入设备显示屏控制信息。如果控制信息不存在，则信息请求应发送到设备。
updateDisplayInfo

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

PUT将编辑的显示屏控制信息发送到设备。只有显示屏信息中编辑的值作为协议发送到设备。
getUpdatedDisplayInfoResult

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

GET从设备接收编辑的显示屏控制信息。此 API 在执行 updateDisplayInfo API 后可执行。
getGeneralInfo

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

GET从数据库导入常规设备信息。设备连接到服务器时会更新常规设备信息。
updateGeneralInfo

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

PUT将编辑的设备信息发送到设备。只有基本设备信息中编辑的值作为协议发送到设备。
getUpdatedGeneralInfoResult

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

GET从设备接收编辑的设备信息。此 API 在执行 updateGeneralInfo API 后可执行。
moveDevice

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

PUT将设备移动到另一个组。
startRmServerVnc

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

GET将 RM 启动协议发送到设备。接收 RM 启动协议的设备会通过远程控制服务器定期发送信息。
stopRmServerVnc

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

GET将 RM 停止协议发送到设备。接收停止协议的设备会立即停止相应的功能。
getSetupInfo

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

GET导入设备设置。设备连接到服务器时会更新设备设置。
updateSetupInfo

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

PUT将编辑的设备设置发送到设备。只有设置中编辑的值作为协议发送到设备。
getUpdatedSetupInfoResult

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

GET从设备接收编辑的设备设置。此 API 在执行 updateSetupInfo API 后可执行。
getCurrentStatusDisplay

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

GET将当前显示屏控制信息请求发送到设备。如果调用此 API，requestId 将作为响应值返回。
getCurrentStatusDisplay

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

GET导入从设备发送的显示屏控制信息。此选项用于两个操作：将信息请求发送到设备和接收实际设备信息。
getCurrentStatusTime

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

GET将当前时间信息请求发送到设备。如果调用此 API，requestId 将作为响应值返回。
getCurrentStatusTime

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

GET导入从设备发送的时间信息。此选项用于两个操作：将信息请求发送到设备和接收实际设备信息。
getTimeInfo

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

GET从数据库导入设备时间信息。如果控制信息不存在，则信息请求应发送到设备。
updateTimeInfo

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

PUT将编辑的时间信息发送到设备。只有时间信息中编辑的值作为协议发送到设备。
getUpdatedTimeInfoResult

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

GET

从设备接收编辑的设备时间信息。此 API 在执行 getUpdatedTimeInfoResult API 后可执行。

listDeviceGroupOrgan

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

GET导入组织的列表。
listDeviceGroupInfo

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

GET导入 {groupId} 组的详细信息。
listDeviceGroupChild

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

GET导入 {groupId} 下子组的相关信息。

用户

添加用户并管理用户信息。具有读取、写入和管理用户权限的经验证用户可以访问用户相关服务。

可用的用户管理服务如下：

服务名称

API 调用

调用类别说明
createUser/restapi/v1.0/ums/usersPOST添加用户。
listDashboardUserInfo

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

GET从仪表板导入必要的用户信息。
updateMyInfo

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

PUT编辑用户信息。
listUserOrgan

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

GET导入组织的列表。此选项可用于配置组树。
listUserGroupOrgan

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

GET导入组织的列表。
listUserGroupInfo

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

GET导入 {groupId} 组的详细信息。
listUserGroupChild

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

GET导入 {groupId} 组下子组的列表。

设置

除了主要功能以外，您还可以使用许多其他功能来创建和管理标签和类别，以及编辑仪表板。

服务名称

API 调用

调用类别说明
getCategoryInfo

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

GET导入类别列表。
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETE删除特定仪表板信息。
listDashboardInfo

/restapi/v1.0/ems/dashboard

GET导入要在自定义仪表板上显示的内容。可以在仪表板上仅显示特定信息。
updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUT更改仪表板上所显示项目的顺序。
createDashboard

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

GET激活空闲的仪表板。

listDashboardLoginInfo

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

GET导入要在仪表板上显示的登录信息。
listDashboardNoticeInfo

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

GET导入要在仪表板上显示的公告板信息。
deleteNoticeInfo

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

DELETE从公告板删除帖子。
listEditNoticeInfo

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

GET导入所选帖子的详细信息。
createNoticeInfo

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

POST将帖子添加到公告板。
updateNoticeInfo

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

PUT编辑公告板上所选的贴子。
listDashboardStorageInfo

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

GET导入要在仪表板上显示的存储信息。

listLicense

/restapi/v1.0/ems/license

GET导入服务器上注册的许可证列表。
getServerSetupInfo

/restapi/v1.0/ems/setup

GET导入服务器设置。服务器设置项目包括可在服务器上打开或关闭不同功能的选项。
getTagListInfo

/restapi/v1.0/ems/tag

POST导入服务器上注册的标签列表。


Open API 详细信息 (swagger UI)

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