Page History

Versions Compared

Old Version 88

changes.mady.by.user user-f347e

Saved on Aug 02, 2018

compared with

New Version 89

changes.mady.by.user user-f347e

Saved on Aug 02, 2018

Key

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

Comment: Content imported from a Scroll Translations translation file.

...

Sv translation

language	zh_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}/child	GET	导入 {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/users	POST	添加用户。
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

Sv translation

language	tr

MagicINFO Server, Open API’ye (v2.0) çağrı yaparak içerik yönetimi, zamanlama yönetimi, aygıt yönetimi ve diğer işlevleri gerçekleştirmenize olanak sağlar.

Open API’yi (v2.0) kullanmak için önce bir kimlik denetimi sürecini tamamlamanız gerekir. API’leri test ederken her bir API için farklı bir swagger sayfası kullanın.

Kimlik denetimi

Open API (v2.0) öğelerine çağrı yapılırken api_token değerinin başlık bölümüne eklenmesi gerekir. Eklenmezse “401 Unauthorized” hatası döndürülür.

Belirlenen zaman diliminden sonra, alınan belirtecin tarihi geçer ve kullanılamaz hale gelir. Bu durumda yeni bir belirteç almanız gerekir.

api_token değeri aşağıdaki API’ye yapılacak bir çağrı aracılığıyla edinilebilir.

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
authenticationRequest	/auth	POST	Kullanıcı kimliği ve parolasını kullanarak kimlik denetimi için bir belirteç değeri içeri aktarır.
authenticationRequest	/auth/refresh	GET	Geçerlilik süresini uzatmak için yeni bir belirteç oluşturur. Tekrar oturum açmadan REST API’ye çağrı yapılabilir

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) çeşitli işlevler sunar. Her bir işleve yönelik yapılandırma aşağıda gösterilmiştir.

Kategori	Denetleyici	Açıklama
İçerik	content-controller	İçerik dosyası yönetimi
İçerik	content-group-controller	İçerik grubu yönetimi
Oynatma listesi	playlist-controller	Bir çalma listesinin yönetilmesi
Oynatma listesi	playlist-group-controller	Çalma listesi grubu yönetimi
Zamanlama	content-schedule-controller	İçerik zamanlaması yönetimi
	content-schedule-group-controller	İçerik zamanlaması grubu yönetimi
	message-schedule-controller	Mesaj zamanlaması yönetimi
	message-schedule-group-controller	Mesaj zamanlaması grubu yönetimi
Aygıt	device-controller	Aygıt yönetimi
Aygıt	device-group-controller	Aygıt grubu yönetimi
Kullanıcı	user-controller	Kullanıcı yönetimi
Kullanıcı	user-group-controller	Kullanıcı grubu yönetimi
Ayar	environment-controller	Ayar

İçerik

İçerik yükleyin, onaylayın ya da silin. İçerik listelerini yönetin. İçerikle ilgili hizmetlere içerik okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilen içerik yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
listAllContent	/restapi/v1.0/cms/contents	GET	Karşıya yüklenmiş dosyaların listesini içeri aktarır. Listede içerik küçük resimleri, isimler, dosya türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Kontrol panelinde gösterilecek genel içerik bilgilerini içeri aktarır.
listContent	/restapi/v1.0/cms/contents/filter	POST	Koşula göre filtrelenmiş bir içerik listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	İçeriğin bir çalma listesine ya da zamanlamaya dahil edilmiş olup olmaması fark etmeksizin içeriği siler.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	İçeriğin bir çalma listesine ya da zamanlamaya dahil edilmemiş olduğunu onayladıktan sonra içeriği siler. Bir çalma listesine veya zamanlamaya dahil edilmiş bir içerik silinmeye çalışılıyorsa içerik silinmez ve bir hata kodu döndürülür.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	İçeriğin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. İçerik her düzenlendiğinde sürümü güncellenir.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	İçeriği onaylar veya reddeder. Onaylanan içerik genel içerik listesine aktarılır ve çalma listelerinde veya zamanlamalarda kullanılabilir.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Yeni içeriği karşıya yükler.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Varsayılan içerik gruplarının listesini içeri aktarır.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Oynatma listesi

İçeriği kullanarak çalma listeleri oluşturun, düzenleyin veya silin. Çalma listesiyle ilgili hizmetlere içerik okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilir çalma listesi yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Tüm çalma listelerinin listesini içeri aktarır. Listede çalma listesi isimleri, ana içeriğin küçük resimleri, çalma listesi türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Yeni bir çalma listesi oluşturur.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Kontrol panelinden gerekli çalma listesi bilgilerini içeri aktarır.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Koşula göre filtrelenmiş çalma listelerinin bir listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Seçilen çalma listesini siler. Bir zamanlamaya dahil edilmiş bir çalma listesi silinmeye çalışılıyorsa çalma listesi silinmez ve bir hata kodu döndürülür.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Çalma listesinin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. Çalma listesi her düzenlendiğinde sürümü güncellenir.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	{playlistId} çalma listesini düzenler. Bir çalma listesi düzenlenlendiğinde çalma listesi sürümü güncellenir ve çalma listesini oynatan aygıt, güncellenmiş çalma listesini otomatik olarak oynatır.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	{playlistId} çalma listesini kopyalar. Çalma listesinin bir kopyası oluşturulur.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Varsayılan çalma listesi gruplarının bir listesini içeri aktarır.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Zamanlama

Yeni içerik ya da mesaj zamanlamaları oluşturun. Zamanlamaları oynatma için aygıtlara yayınlayın. Zamanlamaları düzenleyin veya silin.

Zamanlama ile ilgili hizmetlere zamanlamaları okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilir zamanlama yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	İçerik zamanlamalarının listesini içeri aktarır. Listede içerik zamanlamalarının isimleri, oluşturulma tarihleri, aygıt türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Yeni bir içerik zamanlaması oluşturur. İçerik zamanlamaları birden fazla kanal ve çerçeve içerebilir. Aygıtlara bir zamanlama yayınlayıp arzu edilen içerik ya da çalma listesini belirlenen zamanda oynatın.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Kontrol panelinden gerekli içerik zamanlama bilgilerini içeri aktarır.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Farklı koşullara göre filtrelenmiş bir içerik zamanlaması listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	İçerik zamanlamasını siler. Daha önce bir aygıta yayınlanmış bir zamanlama siliniyorsa aygıt otomatik olarak varsayılan içeriği oynatır.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Seçilen grubun detaylarını içeri aktarır.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	İçerik zamanlamasını düzenler. Daha önce bir aygıta yayınlanmış bir zamanlama düzenleniyorsa aygıt otomatik olarak düzenlenmiş içeriği oynatır.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	{programId} içerik zamanlamasını kopyalar. {programId} içerik zamanlamasının bir kopyası oluşturulur.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	İçerik zamanlamasını belirli bir aygıt grubuna yayınlar.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Gerçek zamanlı içerik zamanlaması indirme durumunu bir aygıttan içeri aktarır.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	İçerik zamanlaması için kök grupların listesini içeri aktarır.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Tüm mesaj zamanlamalarının listesini içeri aktarır.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Yeni bir mesaj programı oluşturur.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Farklı koşullara göre filtrelenmiş bir mesaj zamanlaması listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Seçilen mesaj zamanlamasını siler. Daha önce bir aygıta yayınlanmış bir mesaj zamanlaması siliniyorsa değişiklik otomatik olarak aygıta uygulanır.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Seçilen mesaj zamanlamasının detaylarını içeri aktarır.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Seçilen mesaj zamanlamasını düzenler. Daha önce bir aygıta yayınlanmış bir mesaj zamanlaması düzenleniyorsa değişiklik otomatik olarak aygıta uygulanır.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Seçilen mesaj zamanlamasını kopyalar. Mesaj zamanlamasının bir kopyası oluşturulur.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Seçilen mesaj zamanlamasını bir aygıt grubuna yayınlar.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	İçerik zamanlaması için kök grupların listesini içeri aktarır.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Belirli bir grubun altındaki alt grupların listesini içeri aktarır.

Aygıt

Aygıtları kontrol edin ve yönetin. Aygıtlarla ilgili hizmetlere aygıtları okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Mevcut aygıt yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
listAllDevice	/restapi/v1.0/rms/devices	GET	Tüm aygıtların listesini içeri aktarır. Listede aygıt güç durumları, küçük resim bilgisi, aygıt hata durumları ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Kontrol panelinden gerekli aygıt bilgilerini içeri aktarır.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Farklı koşullara göre filtrelenmiş bir aygıt listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Seçilen aygıtı siler.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Seçilen aygıtın detaylarını içeri aktarır.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Seçilen aygıtı belirli bir grup için onaylar.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	LED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri içeri aktarır. İçeri aktarılan bilgiler sadece cabinet'ler bir LED aygıtına bağlı olduğu zaman geçerlidir.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	LED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri düzenler.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Veri tabanından aygıt ekran kontrol bilgilerini içeri aktarır. Kontrol bilgisi yoksa aygıta bir bilgi isteği gönderilmelidir.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Düzenlenmiş ekran kontrol bilgilerini bir aygıta gönderir. Aygıta sadece ekran bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Aygıttan düzenlenmiş ekran kontrol bilgilerini alır. Bu API, updateDisplayInfo API’si yürütüldükten sonra yürütülebilir.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Veri tabanından genel aygıt bilgilerini içeri aktarır. Genel aygıt bilgisi, aygıt sunucuya bağlandığında güncellenir.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Düzenlenmiş aygıt bilgilerini bir aygıta gönderir. Aygıta sadece temel aygıt bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Aygıttan düzenlenmiş aygıt bilgilerini alır. Bu API, updateGeneralInfo API’si yürütüldükten sonra yürütülebilir.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Aygıtı farklı bir gruba taşır.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Aygıta bir RM başlatma protokolü gönderir. RM başlatma protokolü alan bir aygıt, Uzaktan Kumanda Sunucusu aracılığıyla düzenli aralıklarla bilgi gönderir.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	RM durdurma protokolünü bir aygıta gönderir. RM durdurma protokolü alan bir aygıt ilgili işlevi anında durdurur.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Aygıt ayarlarını içeri aktarır. Aygıt ayarları, aygıt sunucuya bağlandığında güncellenir.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Düzenlenmiş aygıt ayarlarını bir aygıta gönderir. Aygıta sadece ayarlardaki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Aygıttan düzenlenmiş aygıt ayarlarını alır. Bu API, updateSetupInfo API’si yürütüldükten sonra yürütülebilir.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Aygıta mevcut ekran kontrol bilgileri için bir istek gönderir. Bu API çağırılırsa requestId cevap değeri olarak döndürülür.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Aygıttan gönderilen ekran kontrol bilgisini içeri aktarır. Bu seçenek iki eylem için kullanılır: aygıta bilgi isteği göndermek ve asıl aygıt bilgisini almak.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Aygıta mevcut zaman bilgisi için bir istek gönderir. Bu API çağırılırsa requestId cevap değeri olarak döndürülür.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Aygıttan gönderilen zaman bilgisini içeri aktarır. Bu seçenek iki eylem için kullanılır: aygıta bilgi isteği göndermek ve asıl aygıt bilgisini almak.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Veritabanından aygıt zaman bilgilerini içeri aktarır. Kontrol bilgisi yoksa aygıta bir bilgi isteği gönderilmelidir.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Aygıta düzenlenmiş zaman bilgilerini gönderir. Aygıta sadece zaman bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Aygıttan düzenlenmiş aygıt zaman bilgilerini alır. Bu API, getUpdatedTimeInfoResult API’si yürütüldükten sonra yürütülebilir.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Organizasyonların listesini içeri aktarır.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt gruplar hakkındaki bilgileri içeri aktarır.

Kullanıcı

Kullanıcı ekleyip kullanıcı bilgilerini yönetin. Kullanıcılarla ilgili hizmetlere kullanıcı bilgilerini okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Mevcut kullanıcı yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
createUser	/restapi/v1.0/ums/users	POST	Kullanıcı ekler.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Kontrol panelinden gerekli kullanıcı bilgilerini içeri aktarır.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Kullanıcı bilgisini düzenler.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Organizasyonların listesini içeri aktarır. Bu seçenek bir grup ağacını yapılandırmak için kullanılabilir.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Organizasyonların listesini içeri aktarır.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Ayar

Ana işlevlere ek olarak, birçok diğer işlevi kullanarak da etiket ve kategorileri oluşturup yönetebilir ve kontrol panelini düzenleyebilirsiniz.

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Kategorilerin listesini içeri aktarır.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Belirli bir kontrol paneli bilgisini siler.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Özelleştirilmiş kontrol panelinde gösterilecek içeriği içeri aktarır. Kontrol panelinde sadece belirli bilgiler gösterilebilir.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Kontrol panelinde gösterilen öğelerin sıralamasını değiştirir.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Boştaki bir kontrol panelini aktifleştirir.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Kontrol panelinde gösterilecek giriş bilgilerini içeri aktarır.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Kontrol panelinde gösterilecek ilan panosu bilgilerini içeri aktarır.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	İlan panosundan bir gönderiyi siler.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Seçilen gönderinin detaylarını içeri aktarır.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	İlan panosuna gönderiler ekler.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	İlan panosunda seçili gönderiyi düzenler.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Kontrol panelinde gösterilecek depolama bilgilerini içeri aktarır.
listLicense	/restapi/v1.0/ems/license	GET	Sunucudaki kayıtlı lisansların listesini içeri aktarır.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Sunucu ayarlarını içeri aktarır. Sunucu ayarı öğeleri, sunucudaki farklı işlevleri kapatıp açabilecek seçenekler içerir.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Sunucuda kayıtlı etiketlerin listesini içeri aktarır.

Open API Detayları (swagger UI)