Page History

Versions Compared

Key

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

Comment: Content imported from a Scroll Translations translation file.

Sv translation

language	ko_KR

MagicInfo Server에서는 콘텐츠 관리, 스케줄 관리, 장치 관리 등 각 기능을 Open API (v2.0) 호출을 통하여 구현할 수 있습니다.

Open API (v2.0)를 사용하기 위해서는 먼저 인증 절차를 거쳐야 하며, 별도의 swagger 페이지를 통해 각 API를 테스트 할 수 있습니다.

Authentication

모든 Open API (v2.0) 호출 시 헤더에 api_token을 포함하여야 하며, 그렇지 않은 경우 '401 Unauthorized.' 에러를 받게 됩니다.

발급 받은 토큰은 정해진 일정 시간이 지나면 만료되어 사용이 중지되며, 그 경우 토큰을 새로 발급 받아야 합니다.

api_token은 아래 api 호출을 통해 발급받을 수 있습니다.

Service Name	API call	Call Type	Description
authenticationRequest	/auth	POST	사용자 ID 및 비밀번호를 이용하여 인증을 위한 토큰 값을 가져옵니다.
authenticationRequest	/auth/refresh	GET	토큰을 새로 생성하여 만료시간을 연장합니다. 재 로그인 없이 계속해서 REST API를 호출할 수 있습니다.

OPEN API (v2.0)

매직인포 서버 Open API (v2.0) 는 여러가지 기능을 제공하며 기능별 구성은 아래와 같습니다.

Category	Controller	Description
Content	content-controller	콘텐츠 관리
Content	content-group-controller	콘텐츠 그룹 관리
Playlist	playlist-controller	플레이리스트 관리
Playlist	playlist-group-controller	플레이리스트 그룹 관리
Schedule	content-schedule-controller	콘텐츠 스케줄 관리
	content-schedule-group-controller	콘텐츠 스케줄 그룹 관리
	message-schedule-controller	메시지 스케줄 관리
	message-schedule-group-controller	메시지 스케줄 그룹 관리
Device	device-controller	장치 관리
Device	device-group-controller	장치 그룹 관리
User	user-controller	사용자 관리
User	user-group-controller	사용자 그룹 관리
Setting	environment-controller	환경 설정

Content

콘텐츠 업로드, 승인, 삭제, 리스트 관리 등 콘텐츠를 관리할 수 있습니다. 콘텐츠 관련 서비스는 인증을 받은 사용자가 콘텐츠 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

콘텐츠를 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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} 그룹의 하위 그룹 목록을 가져옵니다.

Playlist

콘텐츠를 이용하여 플레이리스트를 만들고, 수정 및 삭제 등 관리 할 수 있습니다. 플레이리스트 관련 서비스는 인증을 받은 사용자가 콘텐츠 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

플레이리스트를 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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} 그룹의 하위 그룹 목록을 가져옵니다.

Schedule

새 콘텐츠/메시지 스케줄을 만들고, 장치에 배포하여 재생 할 수 있습니다. 또한 스케줄을 수정하거나 삭제 하는 등 관리 할 수 있습니다.

스케줄 관련 서비스는 인증을 받은 사용자가 스케줄 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

스케줄을 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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	원하는 그룹의 하위 그룹 목록을 가져옵니다.

Device

각 장치를 제어하고 관리 할 수있습니다. 장치 관련 서비스는 인증을 받은 사용자가 장치 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

장치를 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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	DB에서 장치의 디스플레이 제어 정보를 가져옵니다. 해당 정보가 존재하지 않는 경우 장치에 정보를 요청하여야 합니다.
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	DB에서 장치의 일반 정보를 가져옵니다. 장치의 일반 정보는 장치가 서버에 연결되는 시점에 업데이트 됩니다.
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 시작 프로토콜을 받은 장치는 RM server를 통해 정보를 주기적으로 전송합니다.
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를 호출하면 response값으로 requestId를 전달받게 됩니다.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	장치에서 전달받은 디스플레이 제어 정보를 가져옵니다. 장치로 정보를 요청하는 경우와, 장치 정보를 실제로 전달받는 경우 2가지 형태로 사용됩니다.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	장치에 현재 시간 상태를 요청합니다. 이 API를 호출하면 response값으로 requestId를 전달받게 됩니다.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	장치에서 전달받은 시간 정보를 가져옵니다. getCurrentStatusTime를 호출하여 받은 requestId를 파라미터로 전달해야 합니다.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	DB에서 장치 시간 정보를 가져옵니다. 해당 정보가 존재하지 않는 경우 장치에 정보를 요청하여야 합니다.
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}에 속한 하위 그룹 정보를 가져옵니다.

User

새 사용자를 추가하고, 사용자의 정보를 관리할 수 있습니다. 사용자 관련 서비스는 인증을 받은 사용자가 사용자 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

사용자를 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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} 그룹에 속한 하위 그룹 목록을 가져옵니다.

Setting

주요 기능 이외에도 태그, 카테고리를 생성, 관리하고 대시보드를 수정하는 등 다양한 기능을 구현할 수 있습니다.

Service Name	API call	Call Type	Description
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	서버 설정 정보를 가져옵니다. 서버 설정에는 서버의 여러가지 기능들을 on/off 할 수 있는 기능을 제공합니다.
getTagListInfo	/restapi/v1.0/ems/tag	POST	서버에 등록된 태그 목록을 가져옵니다.

Open API Details (swagger UI)

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

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

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)

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/

Sv translation

language	de

MagicInfo-Server ermöglicht es Ihnen, Content Management, Terminmanagement, Gerätemanagement und andere Funktionen zu implementieren, indem Sie Open API (v2.0) aufrufen.

Für die Verwendung von Open API (v2.0) müssen Sie zuerst einen Authentifizierungsprozess durchlaufen. Verwenden Sie eine separate Swagger-Seite, um jedes einzelne API zu testen.

Authentifizierung

Beim Aufrufen aller Open API (v2.0)-Elemente muss api_token im Header enthalten sein. Wenn dies nicht enthalten ist, wird ein „401 Unauthorized“-Fehler zurückgegeben.

Ein erhaltener Token läuft nach einem bestimmten Zeitraum ab und wird nicht mehr verfügbar. In diesem Fall sollten Sie einen neuen Token erhalten.

api_token können durch Aufrufen der folgenden Api abgerufen werden.

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
authenticationRequest	/auth	POST	Importiert einen Token-Wert für die Authentifizierung unter Verwendung der Benutzer-ID und des Kennworts.
authenticationRequest	/auth/refresh	GET	Erstellt ein neues Token, um die Ablaufzeit zu verlängern. Es ist möglich, REST API aufzurufen, ohne sich erneut anzumelden

OPEN API (v2.0)

MagicInfo Server Open API (v2.0) bietet eine Vielzahl von Funktionen. Die Konfiguration der einzelnen Funktionen wird unten dargestellt.

Kategorie	Controller	Beschreibung
Inhalt	Inhalte-Controller	Content Management
Inhalt	Inhalte-Gruppe-Controller	Inhaltsgruppen-Verwaltung
Wiedergabeliste	Wiedergabeliste-Controller	Verwalten einer Wiedergabeliste
Wiedergabeliste	Wiedergabeliste-Gruppe-Controller	Wiedergabelistengruppen-Verwaltung
Zeitplan	Inhalte-Zeitplan-Controller	Inhaltszeitplan-Verwaltung
	Inhalte-Zeitplan-Gruppe-Controller	Inhaltszeitplan-Gruppenverwaltung
	Nachricht-Zeitplan-Controller	Verwalten von Nachrichtenzeitplänen
	Nachricht-Zeitplan-Gruppe-Controller	Nachrichten-Zeitplan-Gruppenverwaltung
Gerät	Gerät-Controller	Gerätemanagement
Gerät	Gerät-Gruppe-Controller	Gerätegruppen-Verwaltung
Benutzer	Benutzer-Controller	Benutzerverwaltung
Benutzer	Benutzer-Gruppe-Controller	Benutzergruppen-Verwaltung
Einstellung	Umgebung-Controller	Einstellung

Inhalt

Hochladen, Genehmigen oder Löschen von Inhalten. Verwalten von Inhaltsdateizeitplänen Inhaltsbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Inhalten zugänglich.

Die folgenden Inhaltsverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllContent	/restapi/v1.0/cms/contents	GET	Importiert eine Liste mit hochgeladenen Inhalten. In der Liste sind Inhalts-Miniaturen, Namen, Dateitypen und andere grundlegende Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Importiert allgemeine Inhaltsinformationen, die auf dem Dashboard angezeigt werden.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importiert eine Liste mit anhand der Bedingungen gefilterten Inhalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Löscht Inhalte, unabhängig davon, ob die Inhalte in einer Wiedergabeliste oder einem Zeitplan enthalten sind.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Löscht Inhalte, nachdem überprüft wurde, dass die Inhalte nicht in einer Wiedergabeliste oder einem Zeitplan enthalten sind. Wenn Sie versuchen, Inhalte zu löschen, die in einer Wiedergabeliste oder einem Zeitplan enthalten sind, werden die Inhalte nicht gelöscht und es wird ein Fehlercode zurückgegeben.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Importiert Details einer aktivierten Version von Inhalten. Die Version der Inhalte wird jedes Mal aktualisiert, wenn die Wiedergabeliste bearbeitet wird.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Genehmigt Inhalte/lehnt Inhalte ab. Genehmigte Inhalte werden in die allgemeine Inhaltsliste bewegt und können in Wiedergabelisten oder Zeitplänen verwendet werden.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Lädt neue Inhalte hoch.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importiert eine Liste der Standard-Inhaltsgruppen.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Wiedergabeliste

Verwenden Sie Inhalte zum Erstellen, Bearbeiten oder Löschen von Wiedergabelisten. Wiedergabelistenbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Inhalten zugänglich.

Die folgenden Wiedergabelistenverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importiert eine Liste mit allen Wiedergabelisten. In der Liste sind Namen von Wiedergabelisten, Miniaturen von Hauptinhalten, Typen von Wiedergabelisten und andere grundlegende Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Erstellt eine neue Wiedergabeliste.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importiert notwendige Wiedergabelisteninformationen vom Dashboard.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importiert eine Liste mit anhand der Bedingungen gefilterten Wiedergabelisten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Löscht die ausgewählte Wiedergabeliste. Wenn Sie versuchen, eine Wiedergabeliste zu löschen, die in einem Zeitplan enthalten ist, wird die Wiedergabeliste nicht gelöscht und es wird ein Fehlercode zurückgegeben.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Importiert Details einer aktivierten Version einer Wiedergabeliste. Die Version einer Wiedergabeliste wird jedes Mal aktualisiert, wenn die Wiedergabeliste bearbeitet wird.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Bearbeitet die {playlistId}-Wiedergabeliste. Das Bearbeiten einer Wiedergabeliste aktualisiert die Wiedergabelistenversion und bewirkt, dass das Gerät, das die Wiedergabeliste abspielt, die aktualisierte Wiedergabeliste automatisch abspielt.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Kopiert die {playlistId} Wiedergabeliste. Ein Duplikat der Wiedergabeliste wurde erstellt.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importiert eine Liste der Standard-Wiedergabelistengruppen.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Zeitplan

Neue Inhalte oder Nachrichtenzeitpläne erstellen. Zeitpläne an Geräte für die Wiedergabe übermitteln. Zeitpläne löschen oder bearbeiten.

Den Zeitplan betreffende Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Zeitplänen zugänglich.

Die folgenden Zeitplanverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importiert eine Liste aller Inhaltszeitpläne. In der Liste sind Namen von Inhaltszeitplänen, Erstellungsdaten und andere grundlegenden Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Erstellt einen neuen Inhaltszeitplan. Ein Inhaltszeitplan kann mehrere Kanäle und Rahmen enthalten. Einen Zeitplan an Geräte übermitteln und die gewünschten Inhalte oder die Wiedergabeliste zu einer bestimmten Zeit wiedergeben.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Importiert notwendige Inhaltszeitplaninformationen vom Dashboard.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Inhaltszeitplänen. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Löscht einen Inhaltszeitplan. Wenn ein Zeitplan gelöscht wird, der zuvor an ein Gerät übermittelt wurde, spielt das Gerät automatisch die Standard-Inhalte ab.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Importiert Details des ausgewählten Zeitplans.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Bearbeitet einen Inhaltszeitplan. Wenn ein Zeitplan bearbeitet wird, der zuvor an ein Gerät übermittelt wurde, spielt das Gerät automatisch den bearbeiteten Zeitplan ab.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Kopiert den {programId}-Inhaltszeitplan. Ein Duplikat des {programId}-Inhaltszeitplans wird erstellt.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Übermittelt einen Inhaltszeitplan an eine bestimmte Gerätegruppe.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Import den Echtzeit-Inhaltszeitplan-Downloadstatus von einem Gerät.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importiert eine Liste aller Nachrichtenzeitpläne.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Erstellt einen neuen Nachrichtenzeitplan.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Nachrichtenzeitpläne. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Löscht den ausgewählten Nachrichtenzeitplan. Wenn ein Nachrichtenzeitplan gelöscht wird, der zuvor an ein Gerät übermittelt wurde, wird die Änderung automatisch auf das Gerät angewendet.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Importiert Details des ausgewählten Nachrichtenzeitplans.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Bearbeitet den ausgewählten Nachrichtenzeitplan. Wenn ein Nachrichtenzeitplan bearbeitet wird, der zuvor an ein Gerät übermittelt wurde, wird die Änderung automatisch auf das Gerät angewendet.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Kopiert den ausgewählten Nachrichtenzeitplan. Ein Duplikat des Nachrichtenzeitplans wird erstellt.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Übermittelt den ausgewählten Nachrichtenzeitplan an eine Gerätegruppe.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter einer bestimmten Gruppe.

Gerät

Geräte steuern und verwalten. Gerätebezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Geräten zugänglich.

Die folgenden Geräteverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllDevice	/restapi/v1.0/rms/devices	GET	Importiert eine Liste mit allen Geräten. Gerät-Energieversorgungsstatus, Miniaturansichtsinformationen, Gerätefehlerstatus und andere grundlegende Informationen sind in der Liste enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Importiert notwendige Geräteinformationen aus dem Dashboard.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Geräten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Löscht das ausgewählte Gerät.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importiert Details des ausgewählten Geräts.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Genehmigt das ausgewählte Video für eine bestimmte Gruppe.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importiert Informationen über Schränke, die mit einem LED-Gerät verbunden sind. Die importierten Informationen gelten nur, wenn die Schränke mit einem LED-Gerät verbunden sind.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Bearbeitet Informationen über Schränke, die mit einem LED-Gerät verbunden sind.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importiert Geräteanzeigesteuerungsinformationen aus der Datenbank. Falls keine Steuerungsinformationen vorhanden sind, sollte eine Informationsanfrage an das Gerät gesendet werden.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Sendet bearbeitete Anzeigesteuerungsinformationen an ein Gerät. Nur bearbeitete Werte in den Anzeigeinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Empfängt bearbeitete Anzeigesteuerungsinformationen von einem Gerät. Diese API ist ausführbar, nachdem updateDisplayInfo API ausgeführt wurde.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Importiert allgemeine Geräteinformationen aus der Datenbank. Allgemeine Geräteinformationen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Sendet bearbeitete Geräteinformationen an ein Gerät. Nur bearbeitete Werte in grundlegenden Geräteinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Erhält bearbeitete Geräteinformationen von einem Gerät. Diese API ist ausführbar, nachdem updateGeneralInfo API ausgeführt wurde.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Bewegt ein Gerät in eine andere Gruppe.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Sendet ein RM-Startprotokoll an ein Gerät. Ein Gerät, das ein RM-Startprotokoll empfangen hat, sendet in regelmäßigen Abständen Informationen über den RM-Server.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Sendet ein RM-Stoppprotokoll an ein Gerät. Ein Gerät, das ein Stoppprotokoll empfangen hat, stoppt sofort die entsprechende Funktion.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Importiert Geräteeinstellungen. Geräteeinstellungen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Sendet bearbeitete Geräteeinstellungen an ein Gerät. Nur bearbeitete Werte in den Einstellungen werden als Protokoll an das Gerät gesendet.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Erhält bearbeitete Geräteeinstellungen von einem Gerät. Diese API ist ausführbar, nachdem updateSetupInfo API ausgeführt wurde.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Sendet eine aktuelle Anzeigesteuerungsinformationsanfrage an ein Gerät. Wenn diese API aufrufen, wird requestId als der Antwortwert zurückgegeben.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importiert eine Anzeigesteuerungsinformation, die von einem Gerät gesendet wurde. Diese Option wird für zwei Aktionen verwendet: Das Senden einer Anforderung für Informationen an ein Gerät und das Empfangen von tatsächlichen Geräteinformationen.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Sendet eine aktuelle Zeitinformationsanfrage an ein Gerät. Wenn diese API aufrufen, wird requestId als der Antwortwert zurückgegeben.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importiert Zeitinformationen, die von einem Gerät gesendet wurden. Diese Option wird für zwei Aktionen verwendet: Das Senden einer Anforderung für Informationen an ein Gerät und das Empfangen von tatsächlichen Geräteinformationen.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Importiert Gerätezeitinformationen aus der Datenbank. Falls keine Steuerungsinformationen vorhanden sind, sollte eine Informationsanfrage an das Gerät gesendet werden.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Sendet bearbeitete Zeitinformationen an ein Gerät. Nur bearbeitete Werte in den Zeitinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Erhält bearbeitete Zeitinformationen von einem Gerät. Diese API ist ausführbar, nachdem getUpdatedTimeInfoResult API ausgeführt wurde.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Importiert eine Liste der Organisationen.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importiert Informationen über Untergruppen unter {groupId}.

Benutzer

Benutzer hinzufügen und Benutzerinformationen verwalten. Benutzerbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Benutzerinformationen zugänglich.

Die folgenden Benutzerverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
createUser	/restapi/v1.0/ums/users	POST	Fügt einen Benutzer hinzu.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importiert notwendige Benutzerinformationen aus dem Dashboard.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Bearbeitet Benutzerinformationen.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importiert eine Liste der Organisationen. Diese Option kann verwendet werden, um eine Gruppenstruktur zu konfigurieren.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importiert eine Liste der Organisationen.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Einstellung

Neben den Hauptfunktionen können Sie viele weitere Funktionen zum Erstellen und Verwalten von Tags und Kategorien verwenden und das Dashboard bearbeiten.

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importiert eine Liste der Kategorien.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Löscht bestimmte Dashboard-Informationen.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importiert Inhalte, die auf dem angepassten Dashboard angezeigt werden. Es ist möglich, nur bestimmte Informationen auf dem Dashboard anzuzeigen.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Ändert die Reihenfolge der Elemente, die auf dem Dashboard angezeigt werden.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Aktiviert ein inaktives Dashboard.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importiert Anmeldeinformationen, die auf dem Dashboard angezeigt werden.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importiert Anzeigetafel-Informationen, die auf dem Dashboard angezeigt werden.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Löscht einen Beitrag von der Anzeigetafel.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importiert Details des ausgewählten Beitrags.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Fügt einen Beitrag zur Anzeigetafel hinzu.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Bearbeitet den ausgewählten Beitrag auf der Anzeigetafel.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importiert Speicherinformationen, die auf dem Dashboard angezeigt werden.
listLicense	/restapi/v1.0/ems/license	GET	Importiert eine Liste der Lizenzen, die auf dem Server registriert werden.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importiert Servereinstellungen. Servereinstellelemente enthalten Optionen, die verschiedene Funktionen auf dem Server aktivieren oder deaktivieren können.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Importiert eine Liste der Tags, die auf dem Server registriert werden.

Open API-Details (Swagger UI)

Open API Documentation

docExpansion	keine
validatorUrl	keine
operationsSorter	Methode
url	http://184.169.167.38:7001/MagicInfo/v2/api-docs/

Content

Space Tools

Page History

Versions Compared

Old Version 52

New Version 53

Key

Authentication

OPEN API (v2.0)

Content

Playlist

Schedule

Device

User

Setting

Open API Details (swagger UI)

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)

Authentifizierung

OPEN API (v2.0)

Inhalt

Wiedergabeliste

Zeitplan

Gerät

Benutzer

Einstellung

Open API-Details (Swagger UI)