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

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 such by calling Open API (v2.0).

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

Authentication

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

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

api_token can be obtained by calling the following api.

Service Name	API call	Call Type	Description
`authenticationRequest`	`/auth`	POST	Imports a token value for authentication using the user ID and password.
`authenticationRequest`	`/auth/refresh`	GET	Creates a new token to extend the expire time. It is possible to call REST API without logging in again

OPEN API (v2.0)

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

Category	Controller	Description
Content	`content-controller`	Content file management
Content	`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	Whenever content is modified, its version is updated. The active version of content details is fetched.
`approveContents`	`/restapi/v1.0/cms/contents/{contentId}/approval`	PUT	Approves/rejects content. Approved content is moved to the general content list and can be used in playlists or schedules.
`uploadContent`	`/restapi/v1.0/cms/contents/{groupId}`	POST	Uploads new content.
`listDefaultGroup`	`/restapi/v1.0/cms/contents/groups`	GET	Imports a list of default content groups.
`getGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}`	GET	Fetches details of the `{groupId}` group.
`listChildGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}/child`	GET	Fetches a list of sub groups under the `{groupId}` group.

Playlist

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

Available playlist management services are as follows:

Service Name	API call	Call Type	Description
`listAllPlaylist`	`/restapi/v1.0/cms/playlists`	GET	Imports a list of all playlists. Playlist names, main content thumbnails, playlist types, and other basic information are included in the list. Lists can be imported per page, using paging information.
`createPlaylist`	`/restapi/v1.0/cms/playlists`	POST	Creates a new playlist.
`getDashboardPlaylistInfo`	`/restapi/v1.0/cms/playlists/dashboard`	GET	Imports necessary playlist information from the dashboard.
`listPlaylist`	`/restapi/v1.0/cms/playlists/filter`	POST	Imports a list of playlists filtered based on conditions. Lists can be imported per page, using paging information.
`deletePlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}`	DELETE	Deletes the selected playlist. If attempting to delete a playlist included in a schedule, the playlist will not be deleted and an error code will be returned.
`getActivePlaylistInfo`	`/restapi/v1.0/cms/playlists/{playlistId}`	GET	Imports details of an activated version of a playlist. The version of a playlist is updated each time the playlist is edited.
`editPlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}`	PUT	Modifies the `{playlistId}` playlist. Editing a playlist updates the playlist version, and causes the device playing the playlist to automatically play the updated playlist.
`copyPlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}/copy`	PUT	Copies the `{playlistId}` playlist. A duplicate copy of the playlist is created.
`listDefaultGroup`	`/restapi/v1.0/cms/playlists/groups`	GET	Imports a list of default playlist groups.
`getGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}`	GET	Fetches details of the `{groupId}` group.
`listChildGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}/child`	GET	Fetches a list of sub groups under the `{groupId}` group.

Schedule

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

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

Available schedule management services are as follows:

Service Name	API call	Call Type	Description
`listContentScheduleAll`	`/restapi/v1.0/dms/schedule/contents`	GET	Imports a list of all content schedules. Content schedule names, dates of creation, device types, and other basic information are included in the list. Lists can be imported per page, using paging information.
`createContentSchedule`	`/restapi/v1.0/dms/schedule/contents`	POST	Creates a new content schedule. A content schedule may contain multiple channels and frames. Publish a schedule to devices and play the desired content or playlist at a specified time.
`listDashboardScheduleInfo`	`/restapi/v1.0/dms/schedule/contents/dashboard`	GET	Imports necessary content schedule information from the dashboard.
`listContentScheduleByGroup`	`/restapi/v1.0/dms/schedule/contents/filter`	POST	Imports a list of content schedules filtered based on different conditions. Lists can be imported per page, using paging information.
`deleteContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}`	DELETE	Deletes a content schedule. If deleting a schedule previously published to a device, the device automatically plays the default content.
`getProgramInfo`	`/restapi/v1.0/dms/schedule/contents/{programId}`	GET	Imports details of the selected schedule.
`editContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}`	PUT	Edits a content schedule. If editing a schedule previously published to a device, the device automatically plays the edited schedule.
`copyContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}/copy`	PUT	Copies the `{programId}` content schedule. The content schedule such as `{programId}` is newly created.
`deployContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}/deploy`	PUT	Publishes a content schedule to a specific device group.
`getPublishStatus`	`/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus`	GET	Imports real-time content schedule download status from a device.
`getRootGroups`	`/restapi/v1.0/dms/schedule/contents/groups`	GET	Imports a list of root groups for a content schedule.
`listContentScheduleGroupInfo`	`/restapi/v1.0/dms/schedule/contents/groups/{groupId}`	GET	Fetches details of the `{groupId}` group.
`listAllMessageSchedule`	`/restapi/v1.0/dms/schedule/messages`	GET	Imports a list of all message schedules.
`createMessageSchedule`	`/restapi/v1.0/dms/schedule/messages`	POST	Creates a new message schedule.
`listMessage`	`/restapi/v1.0/dms/schedule/messages/filter`	POST	Imports a list of message schedules filtered based on different conditions. Lists can be imported per page, using paging information.
`deleteMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	DELETE	Deletes the selected message schedule. If deleting a message schedule previously published to a device, the change is automatically applied to the device.
`getMessageInfo`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	GET	Imports details of the selected message schedule.
`editMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	PUT	Edits the selected message schedule. If editing a message schedule previously published to a device, the change is automatically applied to the device.
`copyMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}/copy`	PUT	Copies the selected message schedule. A duplicate copy of the message schedule is created.
`deployMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}/deploy`	PUT	Publishes the selected message schedule to a device group.
`getRootGroups`	`/restapi/v1.0/dms/schedule/messages/groups`	GET	Imports a list of root groups for a content schedule.
`listMessageScheduleGroupInfo`	`/restapi/v1.0/dms/schedule/messages/groups/{groupId}`	GET	Fetches details of the `{groupId}` group.
`getChildGroups`	`/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child`	GET	Imports a list of sub-groups under a specific group.

Device

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

Available device management services are as follows:

Service Name	API call	Call Type	Description
`listAllDevice`	`/restapi/v1.0/rms/devices`	GET	Imports a list of all devices. Device power status, thumbnail info, device error status, and other basic information are included in the list. Lists can be imported per page, using paging information.
`getDashboardDeviceInfo`	`/restapi/v1.0/rms/devices/dashboard`	GET	Imports necessary device information from the dashboard.
`filterDeviceList`	`/restapi/v1.0/rms/devices/filter`	POST	Imports a list of devices filtered based on different conditions. Lists can be imported per page, using paging information.
`deleteDevice`	`/restapi/v1.0/rms/devices/{deviceId}`	DELETE	Deletes the selected device.
`getDevice`	`/restapi/v1.0/rms/devices/{deviceId}`	GET	Imports details of the selected device.
`approveDevice`	`/restapi/v1.0/rms/devices/{deviceId}/approval`	PUT	Approves the selected device to a specific group.
`getCabinetList`	`/restapi/v1.0/rms/devices/{deviceId}/cabinet`	POST	Imports information about cabinets connected to an LED device. The imported information is valid only when the cabinets are connected to an LED device.
`updateCabinetInfo`	`/restapi/v1.0/rms/devices/{deviceId}/cabinet`	PUT	Edits information about cabinets connected to an LED device.
`getDisplayControlInfo`	`/restapi/v1.0/rms/devices/{deviceId}/display`	GET	Imports device display control information from the database. If control information is not present, an information request should be sent to the device.
`updateDisplayInfo`	`/restapi/v1.0/rms/devices/{deviceId}/display`	PUT	Sends edited display control information to a device. Only edited values in display information are sent as a protocol to the device.
`getUpdatedDisplayInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}`	GET	Receives edited display control information from a device. This API is run after executing the `updateDisplayInfo` API.
`getGeneralInfo`	`/restapi/v1.0/rms/devices/{deviceId}/general`	GET	Imports general device information from the database. General device information is updated when the device connects to the server.
`updateGeneralInfo`	`/restapi/v1.0/rms/devices/{deviceId}/general/info`	PUT	Sends edited device information to a device. Only edited values in basic device information are sent as a protocol to the device.
`getUpdatedGeneralInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}`	GET	Receives edited device information from a device. This API is run after executing the `updateGeneralInfo` API.
`moveDevice`	`/restapi/v1.0/rms/devices/{deviceId}/move`	PUT	Moves a device to another group.
`startRmServerVnc`	`/restapi/v1.0/rms/devices/{deviceId}/rmserver/start`	GET	Sends an RM start protocol to a device. A device that received an RM start protocol sends information periodically via the Remote control Server.
`stopRmServerVnc`	`/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop`	GET	Sends an RM stop protocol to a device. A device that received a stop protocol stops the corresponding function immediately.
`getSetupInfo`	`/restapi/v1.0/rms/devices/{deviceId}/setup`	GET	Imports device settings. Device settings are updated when the device connects to the server.
`updateSetupInfo`	`/restapi/v1.0/rms/devices/{deviceId}/setup`	PUT	Sends edited device settings to a device. Only edited values in settings are sent as a protocol to the device.
`getUpdatedSetupInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}`	GET	Receives edited device settings from a device. This API is run after executing the `updateSetupInfo` API.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display`	GET	Sends a current display control information request to a device. When calling this API, `requestId` is returned as the `response` value.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}`	GET	Imports display control information sent from a device. This option is used for two actions: sending a request for information to a device and receiving actual device information.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time`	GET	Sends a current time information request to a device. When calling this API, `requestId` is returned as the `response` value.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}`	GET	Imports time information sent from a device. `requestId` received by calling `getCurrentStatusTime` must be sent as a parameter.
`getTimeInfo`	`/restapi/v1.0/rms/devices/{deviceId}/time`	GET	Imports device time information from the database. If control information is not present, an information request should be sent to the device.
`updateTimeInfo`	`/restapi/v1.0/rms/devices/{deviceId}/time`	PUT	Sends edited time information to a device. Only edited values in time information are sent as a protocol to the device.
`getUpdatedTimeInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}`	GET	Receives edited device time information from a device. This API is run after executing the `getUpdatedTimeInfoResult` API.
`listDeviceGroupOrgan`	`/restapi/v1.0/rms/devices/groups`	GET	Imports a list of organizations.
`listDeviceGroupInfo`	`/restapi/v1.0/rms/devices/groups/{groupId}`	GET	Fetches details of the `{groupId}` group.
`listDeviceGroupChild`	`/restapi/v1.0/rms/devices/groups/{groupId}/child`	GET	Fetches sub groups under `{groupId}`.

User

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

Available user management services are as follows:

Service Name	API call	Call Type	Description
`createUser`	`/restapi/v1.0/ums/users`	POST	Adds a user.
`listDashboardUserInfo`	`/restapi/v1.0/ums/users/dashboard`	GET	Imports necessary user information from the dashboard.
`updateMyInfo`	`/restapi/v1.0/ums/users/me`	PUT	Edits user information.
`listUserOrgan`	`/restapi/v1.0/ums/users/organization`	GET	Imports a list of organizations. This option can be used to configure a group tree.
`listUserGroupOrgan`	`/restapi/v1.0/ums/users/groups`	GET	Imports a list of organizations.
`listUserGroupInfo`	`/restapi/v1.0/ums/users/groups/{groupId}`	GET	Fetches details of the `{groupId}` group.
`listUserGroupChild`	`/restapi/v1.0/ums/users/groups/{groupId}/child`	GET	Fetches a list of sub groups under the `{groupId}` group.

Setting

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

Service Name	API call	Call Type	Description
`getCategoryInfo`	`/restapi/v1.0/ems/category/{categoryId}`	GET	Imports a list of categories.
`deleteDashboard`	`/restapi/v1.0/ems/dashboard`	DELETE	Deletes specific dashboard information.
`listDashboardInfo`	`/restapi/v1.0/ems/dashboard`	GET	Imports content to be displayed on the customized dashboard. It is possible to display only specific information on the dashboard.
`updateDashboardPriority`	`/restapi/v1.0/ems/dashboard`	PUT	Changes the order of items displayed on the dashboard.
`createDashboard`	`/restapi/v1.0/ems/dashboard/create`	GET	Activates an idle dashboard.
`listDashboardLoginInfo`	`/restapi/v1.0/ems/dashboard/login`	GET	Imports login information to be displayed on the dashboard.
`listDashboardNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice`	GET	Imports bulletin board information to be displayed on the dashboard.
`deleteNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	DELETE	Deletes a post from the bulletin board.
`listEditNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	GET	Imports details of the selected post.
`createNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	POST	Adds posts to the bulletin board.
`updateNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	PUT	Edits the selected post on the bulletin board.
`listDashboardStorageInfo`	`/restapi/v1.0/ems/dashboard/storage`	GET	Imports storage information to be displayed on the dashboard.
`listLicense`	`/restapi/v1.0/ems/license`	GET	Imports a list of licenses registered on the server.
`getServerSetupInfo`	`/restapi/v1.0/ems/setup`	GET	Imports server settings. Server setting items include options that can turn on or off different functions on the server.
`getTagListInfo`	`/restapi/v1.0/ems/tag`	POST	Imports a list of tags registered on the server.

Open API Details (swagger UI)

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

Sv translation

language	fr

MagicINFO Server vous permet de mettre en place une gestion du contenu, une gestion des programmes, une gestion des périphériques et d’autres fonctions comme Open API (v2.0).

Pour utiliser Open API (v2.0), vous devez d’abord effectuer un processus d’authentification. Utilisez une page Swagger distincte pour tester chaque API.

Authentification

Lorsque vous appelez tous les éléments Open API (v2.0), vous devez inclure api_token dans l’en-tête. Si ceci n’est pas inclus, une erreur « 401 Unauthorized. » est renvoyée.

Un jeton obtenu expire et devient inutilisable après une durée définie. Si tel est le cas, vous devez obtenir un nouveau jeton.

Il est possible d’obtenir api_token en appelant l’API suivante.

Nom du service	Requête API	Type de requête	Description
`authenticationRequest`	`/auth`	POST	Importe une valeur de jeton pour l’authentification à l’aide de l’identifiant d’utilisateur et du mot de passe.
`authenticationRequest`	`/auth/refresh`	GET	Crée un nouveau jeton pour étendre le délai d’expiration. Il est possible d’appeler REST API sans se reconnecter

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) fournit diverses fonctions. La configuration de chaque fonction est indiquée ci-dessous.

Catégorie	Contrôleur	Description
Contenu :	`content-controller`	Gestion du contenu
Contenu :	`content-group-controller`	Gestion du groupe de contenu
Liste de lecture	`playlist-controller`	Gestion des listes de lecture
Liste de lecture	`playlist-group-controller`	Gestion du groupe de listes de lecture
Programme	`content-schedule-controller`	Gestion du programme de contenu
	`content-schedule-group-controller`	Gestion du groupe de programmes de contenu
	`message-schedule-controller`	Gestion des programmes de messages
	`message-schedule-group-controller`	Gestion du groupe de programmes de message
Périphérique	`device-controller`	Gestion des périphériques
Périphérique	`device-group-controller`	Gestion du groupe de périphériques
Utilisateur	`user-controller`	Gestion des utilisateurs
Utilisateur	`user-group-controller`	Gestion du groupe d’utilisateurs
Réglage	`environment-controller`	Réglage

Contenu :

Téléchargez, approuvez ou supprimez du contenu. Gérez des listes de contenu. Les services relatifs au contenu sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de contenu sont comme suit :

Nom du service	Requête API	Type de requête	Description
`listAllContent`	`/restapi/v1.0/cms/contents`	GET	Permet d’importer une liste du contenu téléchargé. La liste inclut les vignettes de contenu, les noms, les types de fichiers et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`listDashboardContentInfo`	`/restapi/v1.0/cms/contents/dashboard`	GET	Permet d’importer des informations de contenu générales à afficher sur le tableau de bord.
`listContent`	`/restapi/v1.0/cms/contents/filter`	POST	Permet d’importer une liste de contenu filtré selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`forceDeleteContent`	`/restapi/v1.0/cms/contents/force/{contentId}`	DELETE	Supprime du contenu, que le contenu soit inclus ou non dans une liste de lecture ou un programme.
`deleteContent`	`/restapi/v1.0/cms/contents/{contentId}`	DELETE	Supprime du contenu après avoir vérifié que le contenu n’est pas inclus dans une liste de lecture ou un programme. Si vous tentez de supprimer du contenu inclus dans une liste de lecture ou un programme, le contenu n’est pas supprimé et un code d’erreur est renvoyé.
`getActiveContentInfo`	`/restapi/v1.0/cms/contents/{contentId}`	GET	Lorsqu’un contenu est modifié, sa version est mise à jour. La version actuelle des détails du contenu est récupérée.
`approveContents`	`/restapi/v1.0/cms/contents/{contentId}/approval`	PUT	Permet d’approuver/de rejeter du contenu. Le contenu approuvé est déplacé dans la liste de contenu général et peut être utilisé dans des listes de lecture ou des programmes.
`uploadContent`	`/restapi/v1.0/cms/contents/{groupId}`	POST	Permet de télécharger du nouveau contenu.
`listDefaultGroup`	`/restapi/v1.0/cms/contents/groups`	GET	Permet d’importer une liste des groupes de contenu par défaut.
`getGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}`	GET	Récupère les détails du groupe `{groupId}`.
`listChildGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}/child`	GET	Récupère une liste de sous-groupes dans le groupe `{groupId}`.

Liste de lecture

Utilisez du contenu pour créer, modifier ou supprimer des listes de lecture. Les services relatifs aux listes de lecture sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de liste de lecture sont comme suit :

Nom du service	Requête API	Type de requête	Description
`listAllPlaylist`	`/restapi/v1.0/cms/playlists`	GET	Permet d’importer une liste de toutes les listes de lecture. La liste inclut les noms des listes de lecture, les vignettes de contenu principales, les types de listes de lecture et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`createPlaylist`	`/restapi/v1.0/cms/playlists`	POST	Crée une nouvelle liste de lecture.
`getDashboardPlaylistInfo`	`/restapi/v1.0/cms/playlists/dashboard`	GET	Permet d’importer depuis le tableau de bord des informations de liste de lecture indispensables.
`listPlaylist`	`/restapi/v1.0/cms/playlists/filter`	POST	Permet d’importer une liste des listes de lecture filtrées selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`deletePlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}`	DELETE	Supprime la liste de lecture sélectionnée. Si vous tentez de supprimer une liste de lecture incluse dans un programme, la liste de lecture n’est pas supprimée et un code d’erreur est renvoyé.
`getActivePlaylistInfo`	`/restapi/v1.0/cms/playlists/{playlistId}`	GET	Permet d’importer les détails d’une version activée d’une liste de lecture. La version d’une liste de lecture est mise à jour à chaque fois que cette liste de lecture est modifiée.
`editPlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}`	PUT	Modifie la liste de lecture `{playlistId}`. La modification d’une liste de lecture actualise la version de cette liste de lecture. Ainsi, le périphérique lisant la liste de lecture lit automatiquement la version mise à jour.
`copyPlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}/copy`	PUT	Copie la liste de lecture `{playlistId}`. Un duplicata de la liste de lecture est créé.
`listDefaultGroup`	`/restapi/v1.0/cms/playlists/groups`	GET	Permet d’importer une liste des groupes de listes de lecture par défaut.
`getGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}`	GET	Récupère les détails du groupe `{groupId}`.
`listChildGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}/child`	GET	Récupère une liste de sous-groupes dans le groupe `{groupId}`.

Programme

Créez de nouveaux programmes de contenu ou de message. Publiez des programmes sur des périphériques pour la lecture. Modifiez ou supprimez des programmes.

Les services relatifs aux programmes sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des programmes.

Les services disponibles de gestion de programme sont comme suit :

Nom du service	Requête API	Type de requête	Description
`listContentScheduleAll`	`/restapi/v1.0/dms/schedule/contents`	GET	Permet d’importer une liste de tous les programmes de contenu. La liste inclut les noms des programmes de contenu, les dates de création, les types de périphériques et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`createContentSchedule`	`/restapi/v1.0/dms/schedule/contents`	POST	Permet de créer un nouveau programme de contenu. Un programme de contenu peut contenir plusieurs canaux et cadres. Publiez un programme sur des périphériques et lisez le contenu souhaité ou la liste de lecture à un moment spécifié.
`listDashboardScheduleInfo`	`/restapi/v1.0/dms/schedule/contents/dashboard`	GET	Permet d’importer depuis le tableau de bord des informations de programme de contenu indispensables.
`listContentScheduleByGroup`	`/restapi/v1.0/dms/schedule/contents/filter`	POST	Permet d’importer une liste de programmes de contenu filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`deleteContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}`	DELETE	Supprime un programme de contenu. En cas de suppression d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le contenu par défaut.
`getProgramInfo`	`/restapi/v1.0/dms/schedule/contents/{programId}`	GET	Permet d’importer les détails du programme sélectionné.
`editContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}`	PUT	Permet de modifier un programme de contenu. En cas de modification d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le programme modifié.
`copyContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}/copy`	PUT	Copie le programme de contenu `{programId}`. Le programme de contenu comme `{programId}` est maintenant créé.
`deployContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}/deploy`	PUT	Permet de publier un programme de contenu sur un groupe de périphériques spécifique.
`getPublishStatus`	`/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus`	GET	Permet d’importer le statut de téléchargement en temps réel d’un programme de contenu depuis un périphérique.
`getRootGroups`	`/restapi/v1.0/dms/schedule/contents/groups`	GET	Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.
`listContentScheduleGroupInfo`	`/restapi/v1.0/dms/schedule/contents/groups/{groupId}`	GET	Récupère les détails du groupe `{groupId}`.
`listAllMessageSchedule`	`/restapi/v1.0/dms/schedule/messages`	GET	Permet d’importer une liste de tous les programmes de message.
`createMessageSchedule`	`/restapi/v1.0/dms/schedule/messages`	POST	Permet de créer un nouveau programme de message.
`listMessage`	`/restapi/v1.0/dms/schedule/messages/filter`	POST	Permet d’importer une liste de programmes de message filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`deleteMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	DELETE	Supprime le programme de message sélectionné. En cas de suppression d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.
`getMessageInfo`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	GET	Permet d’importer les détails du programme de message sélectionné.
`editMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	PUT	Permet d’éditer le programme de message sélectionné. En cas de modification d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.
`copyMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}/copy`	PUT	Permet de copier le programme de message sélectionné. Un duplicata du programme de message est créé.
`deployMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}/deploy`	PUT	Permet de publier le programme de message sélectionné sur un groupe de périphériques.
`getRootGroups`	`/restapi/v1.0/dms/schedule/messages/groups`	GET	Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.
`listMessageScheduleGroupInfo`	`/restapi/v1.0/dms/schedule/messages/groups/{groupId}`	GET	Récupère les détails du groupe `{groupId}`.
`getChildGroups`	`/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child`	GET	Permet d’importer une liste de sous-groupes dans un groupe spécifique.

Périphérique

Contrôlez et gérez les périphériques. Les services relatifs aux périphériques sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des périphériques.

Les services disponibles de gestion de périphérique sont comme suit :

Nom du service	Requête API	Type de requête	Description
`listAllDevice`	`/restapi/v1.0/rms/devices`	GET	Permet d’importer une liste de tous les périphériques. La liste inclut l’état d’alimentation du périphérique, les informations de vignette, le statut d’erreur du périphérique et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`getDashboardDeviceInfo`	`/restapi/v1.0/rms/devices/dashboard`	GET	Permet d’importer depuis le tableau de bord des informations de périphérique indispensables.
`filterDeviceList`	`/restapi/v1.0/rms/devices/filter`	POST	Permet d’importer une liste de périphériques filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
`deleteDevice`	`/restapi/v1.0/rms/devices/{deviceId}`	DELETE	Supprime le périphérique sélectionné.
`getDevice`	`/restapi/v1.0/rms/devices/{deviceId}`	GET	Permet d’importer les détails du périphérique sélectionné.
`approveDevice`	`/restapi/v1.0/rms/devices/{deviceId}/approval`	PUT	Permet d’approuver le périphérique sélectionné sur un groupe spécifique.
`getCabinetList`	`/restapi/v1.0/rms/devices/{deviceId}/cabinet`	POST	Permet d’importer des informations sur les cabinets connectés à un périphérique LED. Les informations importées sont valides uniquement lorsque les cabinets sont connectés à un périphérique LED.
`updateCabinetInfo`	`/restapi/v1.0/rms/devices/{deviceId}/cabinet`	PUT	Permet de modifier des informations sur les cabinets connectés à un périphérique LED.
`getDisplayControlInfo`	`/restapi/v1.0/rms/devices/{deviceId}/display`	GET	Permet d’importer des informations de contrôle d’affichage du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.
`updateDisplayInfo`	`/restapi/v1.0/rms/devices/{deviceId}/display`	PUT	Permet d’envoyer sur un périphérique des informations de contrôle d’affichage modifiées. Seules les valeurs modifiées dans les informations d’affichage sont envoyées au périphérique en tant que protocole.
`getUpdatedDisplayInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}`	GET	Permet de recevoir depuis un périphérique des informations de contrôle d’affichage modifiées. Cette API est exécutée après l’exécution de l’API `updateDisplayInfo`.
`getGeneralInfo`	`/restapi/v1.0/rms/devices/{deviceId}/general`	GET	Permet d’importer des informations de périphérique générales depuis la base de données. Les informations de périphérique générales sont actualisées lorsque le périphérique se connecte au serveur.
`updateGeneralInfo`	`/restapi/v1.0/rms/devices/{deviceId}/general/info`	PUT	Permet d’envoyer sur un périphérique des informations de périphérique modifiées. Seules les valeurs modifiées dans les informations de périphérique de base sont envoyées au périphérique en tant que protocole.
`getUpdatedGeneralInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}`	GET	Permet de recevoir depuis un périphérique des informations de périphérique modifiées. Cette API est exécutée après l’exécution de l’API `updateGeneralInfo`.
`moveDevice`	`/restapi/v1.0/rms/devices/{deviceId}/move`	PUT	Permet de déplacer un périphérique sur un autre groupe.
`startRmServerVnc`	`/restapi/v1.0/rms/devices/{deviceId}/rmserver/start`	GET	Permet d’envoyer sur un périphérique un protocole de démarrage RM. Un périphérique ayant reçu un protocole de démarrage RM envoie régulièrement des informations via le serveur de la télécommande.
`stopRmServerVnc`	`/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop`	GET	Permet d’envoyer sur un périphérique un protocole d’arrêt RM. Un périphérique ayant reçu un protocole d’arrêt arrête immédiatement la fonction correspondante.
`getSetupInfo`	`/restapi/v1.0/rms/devices/{deviceId}/setup`	GET	Permet d’importer des paramètres relatifs à un périphérique. Les paramètres de périphérique sont actualisés lorsque le périphérique se connecte au serveur.
`updateSetupInfo`	`/restapi/v1.0/rms/devices/{deviceId}/setup`	PUT	Permet d’envoyer sur un périphérique des paramètres de périphérique modifiés. Seules les valeurs modifiées dans les paramètres sont envoyées au périphérique en tant que protocole.
`getUpdatedSetupInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}`	GET	Permet de recevoir depuis un périphérique des paramètres de périphérique modifiés. Cette API est exécutée après l’exécution de l’API `updateSetupInfo`.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display`	GET	Permet d’envoyer sur un périphérique une requête d’informations actuelles de contrôle d’affichage. Lorsque vous appelez cette API, vous recevez `requestId` comme valeur de `response`.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}`	GET	Permet d’importer depuis un périphérique des informations de contrôle d’affichage. Cette option est utilisée pour deux actions : envoyer une requête d’informations à un périphérique et recevoir des informations actuelles sur le périphérique.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time`	GET	Permet d’envoyer sur un périphérique une requête d’informations actuelles concernant l’heure. Lorsque vous appelez cette API, vous recevez `requestId` comme valeur de `response`.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}`	GET	Permet d’importer des informations sur l’heure envoyées depuis un périphérique. `requestId` reçu en appelant `getCurrentStatusTime` doit être envoyé en tant que paramètre.
`getTimeInfo`	`/restapi/v1.0/rms/devices/{deviceId}/time`	GET	Permet d’importer des informations sur l’heure du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.
`updateTimeInfo`	`/restapi/v1.0/rms/devices/{deviceId}/time`	PUT	Permet d’envoyer sur un périphérique des informations modifiées concernant l’heure. Seules les valeurs modifiées dans les informations sur l’heure sont envoyées au périphérique en tant que protocole.
`getUpdatedTimeInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}`	GET	Permet de recevoir depuis un périphérique des informations modifiées sur l’heure du périphérique. Cette API est exécutée après l’exécution de l’API `getUpdatedTimeInfoResult`.
`listDeviceGroupOrgan`	`/restapi/v1.0/rms/devices/groups`	GET	Permet d’importer une liste d’organisations.
`listDeviceGroupInfo`	`/restapi/v1.0/rms/devices/groups/{groupId}`	GET	Récupère les détails du groupe `{groupId}`.
`listDeviceGroupChild`	`/restapi/v1.0/rms/devices/groups/{groupId}/child`	GET	Récupère les sous-groupes sous `{groupId}`.

Utilisateur

Ajoutez des utilisateurs et gérez les informations d’utilisateur. Les services relatifs aux utilisateurs sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer les informations d’utilisateur.

Les services disponibles de gestion d’utilisateur sont comme suit :

Nom du service	Requête API	Type de requête	Description
`createUser`	`/restapi/v1.0/ums/users`	POST	Permet d’ajouter un utilisateur.
`listDashboardUserInfo`	`/restapi/v1.0/ums/users/dashboard`	GET	Permet d’importer depuis le tableau de bord des informations d’utilisateur indispensables.
`updateMyInfo`	`/restapi/v1.0/ums/users/me`	PUT	Permet de modifier les informations relatives à l’utilisateur.
`listUserOrgan`	`/restapi/v1.0/ums/users/organization`	GET	Permet d’importer une liste d’organisations. Cette option peut être utilisée pour configurer une arborescence de groupes.
`listUserGroupOrgan`	`/restapi/v1.0/ums/users/groups`	GET	Permet d’importer une liste d’organisations.
`listUserGroupInfo`	`/restapi/v1.0/ums/users/groups/{groupId}`	GET	Récupère les détails du groupe `{groupId}`.
`listUserGroupChild`	`/restapi/v1.0/ums/users/groups/{groupId}/child`	GET	Récupère une liste de sous-groupes dans le groupe `{groupId}`.

Réglage

En plus des fonctions principales, vous pouvez utiliser de nombreuses autres fonctions pour créer et gérer des tags et des catégories, et modifier le tableau de bord.

Nom du service	Requête API	Type de requête	Description
`getCategoryInfo`	`/restapi/v1.0/ems/category/{categoryId}`	GET	Permet d’importer une liste de catégories.
`deleteDashboard`	`/restapi/v1.0/ems/dashboard`	DELETE	Permet de supprimer des informations de tableau de bord spécifiques.
`listDashboardInfo`	`/restapi/v1.0/ems/dashboard`	GET	Permet d’importer du contenu à afficher sur le tableau de bord personnalisé. Vous ne pouvez afficher que des informations spécifiques sur le tableau de bord.
`updateDashboardPriority`	`/restapi/v1.0/ems/dashboard`	PUT	Permet de changer l’ordre des éléments affichés sur le tableau de bord.
`createDashboard`	`/restapi/v1.0/ems/dashboard/create`	GET	Permet d’activer un tableau de bord inactif.
`listDashboardLoginInfo`	`/restapi/v1.0/ems/dashboard/login`	GET	Permet d’importer des informations de connexion à afficher sur le tableau de bord.
`listDashboardNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice`	GET	Permet d’importer des informations de tableau d’affichage à afficher sur le tableau de bord.
`deleteNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	DELETE	Permet de supprimer une publication du tableau d’affichage.
`listEditNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	GET	Permet d’importer les détails de la publication sélectionnée.
`createNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	POST	Permet d’ajouter des publications au tableau d’affichage.
`updateNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	PUT	Permet de modifier la publication sélectionnée sur le tableau d’affichage.
`listDashboardStorageInfo`	`/restapi/v1.0/ems/dashboard/storage`	GET	Permet d’importer des informations de stockage à afficher sur le tableau de bord.
`listLicense`	`/restapi/v1.0/ems/license`	GET	Permet d’importer une liste de licences enregistrées sur le serveur.
`getServerSetupInfo`	`/restapi/v1.0/ems/setup`	GET	Permet d’importer des paramètres relatifs au serveur. Les éléments de réglage du serveur incluent des options qui peuvent activer ou désactiver différentes fonctions sur le serveur.
`getTagListInfo`	`/restapi/v1.0/ems/tag`	POST	Permet d’importer une liste de tags enregistrés sur le serveur.

Détails sur Open API (interface utilisateur Swagger)

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

Sv translation

language	de

MagicINFO Server ermöglicht es Ihnen, Content Management, Terminmanagement, Gerätemanagement usw. 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	`content-controller`	Content Management
Inhalt	`content-group-controller`	Inhaltsgruppen-Verwaltung
Wiedergabeliste	`playlist-controller`	Verwalten einer Wiedergabeliste
Wiedergabeliste	`playlist-group-controller`	Wiedergabelistengruppen-Verwaltung
Zeitplan	`content-schedule-controller`	Inhaltszeitplan-Verwaltung
	`content-schedule-group-controller`	Inhaltszeitplan-Gruppenverwaltung
	`message-schedule-controller`	Verwalten von Nachrichtenzeitplänen
	`message-schedule-group-controller`	Nachrichten-Zeitplan-Gruppenverwaltung
Gerät	`device-controller`	Gerätemanagement
Gerät	`device-group-controller`	Gerätegruppen-Verwaltung
Benutzer	`user-controller`	Benutzerverwaltung
Benutzer	`user-group-controller`	Benutzergruppen-Verwaltung
Einstellung	`environment-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	Bei jedem Abändern des Inhalts wird die Version aktualisiert. Die aktive Version der Inhaltsangaben wird abgerufen.
`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	Abrufungsdetails der `{groupId}`-Gruppe.
`listChildGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}/child`	GET	Ruft eine Liste der Untergruppen unter der `{groupId}`-Gruppe ab.

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	Ändert die `{playlistId}`-Wiedergabeliste ab. 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	Abrufungsdetails der `{groupId}`-Gruppe.
`listChildGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}/child`	GET	Ruft eine Liste der Untergruppen unter der `{groupId}`-Gruppe ab.

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. Der Inhaltszeitplan, wie etwa `{programId}`, wird neu 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	Abrufungsdetails 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	Abrufungsdetails 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 nach dem Ausführen der `updateDisplayInfo`-API ausführbar.
`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 nach dem Ausführen der `updateGeneralInfo`-API ausführbar.
`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 Fernbedienungs-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 nach dem Ausführen der `updateSetupInfo`-API ausführbar.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display`	GET	Sendet eine aktuelle Anzeigesteuerungsinformationsanfrage an ein Gerät. Wenn Sie diese API aufgerufen, wird `requestId` als `response`-Wert 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 Sie diese API aufgerufen, wird `requestId` als `response`-Wert zurückgegeben.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}`	GET	Importiert Zeitinformationen, die von einem Gerät gesendet wurden. Die `requestId`, die bei einer Anfrage bei `getCurrentStatusTime` erhalten wurde, muss als Parameter gesendet werden.
`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 nach dem Ausführen der `getUpdatedTimeInfoResult`-API ausführbar.
`listDeviceGroupOrgan`	`/restapi/v1.0/rms/devices/groups`	GET	Importiert eine Liste der Organisationen.
`listDeviceGroupInfo`	`/restapi/v1.0/rms/devices/groups/{groupId}`	GET	Abrufungsdetails der `{groupId}`-Gruppe.
`listDeviceGroupChild`	`/restapi/v1.0/rms/devices/groups/{groupId}/child`	GET	Ruft Untergruppen unter `{groupId}` ab.

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	Abrufungsdetails der `{groupId}`-Gruppe.
`listUserGroupChild`	`/restapi/v1.0/ums/users/groups/{groupId}/child`	GET	Ruft eine Liste der Untergruppen unter der `{groupId}`-Gruppe ab.

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)

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 programmi, 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 è incluso, viene restituito 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 diverse funzioni. Di seguito si mostra la configurazione di ciascuna funzione.

Categoria	Controller	Descrizione
Contenuto	`content-controller`	Gestione contenuti
Contenuto	`content-group-controller`	Gestione del gruppo di contenuti
Playlist	`playlist-controller`	Gestione di una playlist
Playlist	`playlist-group-controller`	Gestione del gruppo di playlist
Programma	`content-schedule-controller`	Gestione programmazione di contenuti
	`content-schedule-group-controller`	Gestione del gruppo di programmazioni di contenuti
	`message-schedule-controller`	Gestione dei programmi messaggio
	`message-schedule-group-controller`	Gestione del gruppo di programmazioni di messaggi
Dispositivo	`device-controller`	Gestione dispositivo
Dispositivo	`device-group-controller`	Gestione del gruppo di dispositivi
Utente	`user-controller`	Gestione utente
Utente	`user-group-controller`	Gestione gruppo utente
Impostazioni	`environment-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	Ogni volta che si modifica il contenuto, viene aggiornata la relativa versione. La versione attiva dei dettagli del contenuto viene recuperata.
`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	Recupera i dettagli del gruppo `{groupId}`.
`listChildGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}/child`	GET	Recupera 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	Recupera i dettagli del gruppo `{groupId}`.
`listChildGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}/child`	GET	Recupera 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 il programma di contenuti `{programId}`. Viene creato il programma di contenuti,ad esempio `{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	Recupera i 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	Recupera i 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 viene eseguita dopo l'esecuzione dell'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 viene eseguita dopo l'esecuzione dell'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. Un dispositivo che ha ricevuto il protocollo di avvio RM invia periodicamente le informazioni mediante il server di controllo remoto.
`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 viene eseguita dopo l'esecuzione dell'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. Quando si chiama questa API, `requestId` viene restituito come valore `response`.
`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. Quando si chiama questa API, `requestId` viene restituito come valore `response`.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}`	GET	Importa informazioni sull'orario inviate da un dispositivo. `requestId` ricevuto tramite la chiamata a `getCurrentStatusTime` deve essere inviato come parametro.
`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 viene eseguita dopo l'esecuzione dell'API `getUpdatedTimeInfoResult`.
`listDeviceGroupOrgan`	`/restapi/v1.0/rms/devices/groups`	GET	Importa un elenco di organizzazioni.
`listDeviceGroupInfo`	`/restapi/v1.0/rms/devices/groups/{groupId}`	GET	Recupera i dettagli del gruppo `{groupId}`.
`listDeviceGroupChild`	`/restapi/v1.0/rms/devices/groups/{groupId}/child`	GET	Recupera sottogruppi in `{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	Recupera i dettagli del gruppo `{groupId}`.
`listUserGroupChild`	`/restapi/v1.0/ums/users/groups/{groupId}/child`	GET	Recupera 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)

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

Sv translation

language	es

MagicINFO Server le permite implementar la administración de contenidos, de programaciones, de dispositivos y otras funciones mediante una llamada a Open API (versión 2.0).

Para utilizar Open API (versión 2.0), antes es necesario pasar por un proceso de autenticación. Use una página independiente de Swagger para probar cada API.

Autenticación

Si desea invocar todos los elementos de Open API (versión 2.0), se debe incluir api_token en el encabezado. Si no se incluye, se devuelve un error "401 Unauthorized.".

Un token obtenido caduca y deja de estar disponible para su uso después de un período de tiempo especificado. Si este es el caso, debe obtener un nuevo token.

Se puede obtener api_token invocando la siguiente API.

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`authenticationRequest`	`/auth`	POST	Importa un valor de token para la autenticación utilizando el ID y la contraseña de usuario.
`authenticationRequest`	`/auth/refresh`	GET	Crea un nuevo token para prolongar el tiempo de caducidad. Es posible llamar a la API REST sin iniciar sesión otra vez.

OPEN API (v2.0)

La versión 2.0 de Open API que emplea MagicINFO Server ofrece una serie de funciones. A continuación se muestra la configuración de cada función.

Categoría	Controlador	Descripción
Contenido	`content-controller`	Gestión de archivos de contenido
Contenido	`content-group-controller`	Gestión de grupos de contenido
Lista de reproducción	`playlist-controller`	Gestión de listas de reproducción
Lista de reproducción	`playlist-group-controller`	Gestión de grupos de listas de reproducción
Programación	`content-schedule-controller`	Gestión de programaciones de contenidos
	`content-schedule-group-controller`	Gestión de grupos de programaciones de contenidos
	`message-schedule-controller`	Administración de la programación de mensajes
	`message-schedule-group-controller`	Gestión de grupos de programaciones de mensajes
Dispositivo	`device-controller`	Administración de dispositivos
Dispositivo	`device-group-controller`	Gestión de grupos de dispositivos
Usu.	`user-controller`	Administración de usuarios
Usu.	`user-group-controller`	Gestión de grupos de usuarios
Configuración	`environment-controller`	Configuración

Contenido

Cargar, aprobar o eliminar contenido. Gestionar listas de contenido. Los usuarios autenticados con privilegios para leer, escribir y gestionar contenidos pueden acceder a los servicios relacionados con el contenido.

Los servicios de gestión de contenidos disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`listAllContent`	`/restapi/v1.0/cms/contents`	GET	Importa una lista del contenido cargado. Las miniaturas de contenido, los nombres, los tipos de archivos y otra información básica se incluyen en la lista. Las listas se pueden importar por página mediante la información de paginación.
`listDashboardContentInfo`	`/restapi/v1.0/cms/contents/dashboard`	GET	Importa información general de contenido que se mostrará en el panel.
`listContent`	`/restapi/v1.0/cms/contents/filter`	POST	Importa una lista de contenido filtrado de acuerdo con condiciones. Las listas se pueden importar por página mediante la información de paginación.
`forceDeleteContent`	`/restapi/v1.0/cms/contents/force/{contentId}`	DELETE	Borra el contenido, tanto si está incluido en una lista de reproducción o una programación como si no.
`deleteContent`	`/restapi/v1.0/cms/contents/{contentId}`	DELETE	Elimina el contenido después de comprobar que no está incluido en una lista de reproducción o una programación. Si intenta eliminar contenido incluido en una lista de reproducción o una programación, no se eliminará y se devolverá un código de error.
`getActiveContentInfo`	`/restapi/v1.0/cms/contents/{contentId}`	GET	Cada vez que se modifica el contenido, se actualiza su versión. Se obtiene la versión activa de los detalles del contenido.
`approveContents`	`/restapi/v1.0/cms/contents/{contentId}/approval`	PUT	Aprueba/rechaza el contenido. El contenido aprobado se mueve a la lista de contenido general y se puede utilizar en listas de reproducción o programaciones.
`uploadContent`	`/restapi/v1.0/cms/contents/{groupId}`	POST	Carga contenido nuevo.
`listDefaultGroup`	`/restapi/v1.0/cms/contents/groups`	GET	Importa una lista de grupos de contenido predeterminados.
`getGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listChildGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}/child`	GET	Importa una lista de subgrupos contenidos en el grupo `{groupId}`.

Lista de reproducción

Utilice el contenido para crear, editar o borrar listas de reproducción. Los usuarios autenticados con privilegios para leer, escribir y gestionar contenido pueden acceder a los servicios relacionados con las listas de reproducción.

Los servicios de gestión de listas de reproducción disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`listAllPlaylist`	`/restapi/v1.0/cms/playlists`	GET	Importa una lista de todas listas de reproducción. En la lista se incluyen los nombres de las listas de reproducción, las miniaturas de contenido principal, los tipos de listas de reproducción y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
`createPlaylist`	`/restapi/v1.0/cms/playlists`	POST	Crea una nueva lista de reproducción.
`getDashboardPlaylistInfo`	`/restapi/v1.0/cms/playlists/dashboard`	GET	Importa la información de lista de reproducción necesaria del panel.
`listPlaylist`	`/restapi/v1.0/cms/playlists/filter`	POST	Importa una lista de listas de reproducción filtradas de acuerdo con condiciones. Las listas se pueden importar por página mediante la información de paginación.
`deletePlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}`	DELETE	Elimina la lista de reproducción seleccionada. Si intenta eliminar una lista de reproducción incluida en una programación, no se eliminará y se devolverá un código de error.
`getActivePlaylistInfo`	`/restapi/v1.0/cms/playlists/{playlistId}`	GET	Importa detalles sobre una versión activada de una lista de reproducción. La versión de una lista de reproducción se actualiza cada vez que se edita la lista de reproducción.
`editPlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}`	PUT	Modifica la lista de reproducción `{playlistId}`. La edición de una lista de reproducción provoca la actualización de la versión de la lista de reproducción y hace que el dispositivo de reproducción reproduzca automáticamente la lista de reproducción actualizada.
`copyPlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}/copy`	PUT	Copia la lista de reproducción `{playlistId}`. Se crea una copia duplicada de la lista de reproducción.
`listDefaultGroup`	`/restapi/v1.0/cms/playlists/groups`	GET	Importa una lista de los grupos predeterminados de la lista de reproducción.
`getGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listChildGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}/child`	GET	Importa una lista de subgrupos contenidos en el grupo `{groupId}`.

Programación

Cree nuevas programaciones de contenido o mensajes. Publique programaciones en dispositivos para su reproducción. Edite o elimine programaciones.

Los usuarios autenticados con privilegios para leer, escribir y gestionar programaciones pueden acceder a los servicios relacionados con las programaciones.

Los servicios de gestión de programaciones disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`listContentScheduleAll`	`/restapi/v1.0/dms/schedule/contents`	GET	Importa una lista de todas las programaciones de contenido. En la lista se incluyen los nombres de las programaciones, las fechas de creación, los tipos de dispositivos y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
`createContentSchedule`	`/restapi/v1.0/dms/schedule/contents`	POST	Crea una nueva programación de contenido. Una programación de contenido puede contener varios canales y marcos. Publique una programación en los dispositivos y reproduzca el contenido deseado o una lista de reproducción en un momento especificado.
`listDashboardScheduleInfo`	`/restapi/v1.0/dms/schedule/contents/dashboard`	GET	Importa información de programación de contenido necesaria del panel.
`listContentScheduleByGroup`	`/restapi/v1.0/dms/schedule/contents/filter`	POST	Importa una lista de programaciones de contenido filtrada de acuerdo con diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
`deleteContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}`	DELETE	Elimina una programación de contenido. Si elimina una programación previamente publicada en un dispositivo, el dispositivo reproduce automáticamente el contenido predeterminado.
`getProgramInfo`	`/restapi/v1.0/dms/schedule/contents/{programId}`	GET	Importa detalles sobre la programación seleccionada.
`editContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}`	PUT	Edita una programación de contenido. Si edita una programación publicada previamente en un dispositivo, el dispositivo reproduce automáticamente la programación editada.
`copyContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}/copy`	PUT	Copia la programación de contenido `{programId}`. La programación de contenido como `{programId}` se ha creado recientemente.
`deployContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}/deploy`	PUT	Publica una programación de contenido en un grupo de dispositivos específico.
`getPublishStatus`	`/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus`	GET	Importa el estado de descarga de la programación de contenido en tiempo real desde un dispositivo.
`getRootGroups`	`/restapi/v1.0/dms/schedule/contents/groups`	GET	Importa una lista de grupos raíz para una programación de contenido.
`listContentScheduleGroupInfo`	`/restapi/v1.0/dms/schedule/contents/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listAllMessageSchedule`	`/restapi/v1.0/dms/schedule/messages`	GET	Importa una lista de todas las programaciones de mensajes.
`createMessageSchedule`	`/restapi/v1.0/dms/schedule/messages`	POST	Crea una nueva programación de mensajes.
`listMessage`	`/restapi/v1.0/dms/schedule/messages/filter`	POST	Importa una lista de programaciones de mensajes filtrada según diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
`deleteMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	DELETE	Borra la programación de mensajes seleccionada. Si elimina una programación de mensajes anteriormente publicada en un dispositivo, el cambio se aplica automáticamente al dispositivo.
`getMessageInfo`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	GET	Importa detalles sobre la programación de mensajes seleccionada.
`editMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	PUT	Modifica la programación de mensajes seleccionada. Si edita una programación de mensajes publicada previamente en un dispositivo, el cambio se aplica automáticamente al dispositivo.
`copyMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}/copy`	PUT	Copia la programación de mensajes seleccionada. Se crea una copia duplicada de la programación de mensajes.
`deployMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}/deploy`	PUT	Publica la programación de mensajes seleccionada en un grupo de dispositivos.
`getRootGroups`	`/restapi/v1.0/dms/schedule/messages/groups`	GET	Importa una lista de grupos raíz para una programación de contenido.
`listMessageScheduleGroupInfo`	`/restapi/v1.0/dms/schedule/messages/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`getChildGroups`	`/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child`	GET	Importa una lista de subgrupos incluidos en un grupo específico.

Dispositivo

Controle y gestione los dispositivos. Los usuarios autenticados con privilegios para leer, escribir y gestionar dispositivos pueden acceder a los servicios relacionados con los dispositivos.

Los servicios de gestión de dispositivos disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`listAllDevice`	`/restapi/v1.0/rms/devices`	GET	Importa una lista de todos los dispositivos. En la lista se incluyen el estado de alimentación del dispositivo, la información sobre las miniaturas, el estado de error de dispositivo y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
`getDashboardDeviceInfo`	`/restapi/v1.0/rms/devices/dashboard`	GET	Importa la información de dispositivo necesaria del panel.
`filterDeviceList`	`/restapi/v1.0/rms/devices/filter`	POST	Importa una lista de dispositivos filtrada según diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
`deleteDevice`	`/restapi/v1.0/rms/devices/{deviceId}`	DELETE	Borra el dispositivo seleccionado.
`getDevice`	`/restapi/v1.0/rms/devices/{deviceId}`	GET	Importa detalles sobre el dispositivo seleccionado.
`approveDevice`	`/restapi/v1.0/rms/devices/{deviceId}/approval`	PUT	Aprueba el dispositivo seleccionado en un grupo específico.
`getCabinetList`	`/restapi/v1.0/rms/devices/{deviceId}/cabinet`	POST	Importa información sobre las vitrinas conectadas a un dispositivo LED. La información importada solo es válida cuando las vitrinas están conectadas a un dispositivo LED.
`updateCabinetInfo`	`/restapi/v1.0/rms/devices/{deviceId}/cabinet`	PUT	Edita la información sobre las vitrinas conectadas a un dispositivo LED.
`getDisplayControlInfo`	`/restapi/v1.0/rms/devices/{deviceId}/display`	GET	Importa información sobre el control de visualización de dispositivos de la base de datos. Si no hay información de control, se debe enviar una solicitud de información al dispositivo.
`updateDisplayInfo`	`/restapi/v1.0/rms/devices/{deviceId}/display`	PUT	Envía la información sobre el control de visualización editada a un dispositivo. Se envían solo los valores editados de la información de visualización como un protocolo al dispositivo.
`getUpdatedDisplayInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}`	GET	Recibe la información sobre el control de visualización editada de un dispositivo. Esta API se ejecuta después de ejecutar la API `updateDisplayInfo`.
`getGeneralInfo`	`/restapi/v1.0/rms/devices/{deviceId}/general`	GET	Importa información general del dispositivo desde la base de datos. La información general del dispositivo se actualiza cuando el dispositivo se conecta al servidor.
`updateGeneralInfo`	`/restapi/v1.0/rms/devices/{deviceId}/general/info`	PUT	Envía la información de dispositivo editada a un dispositivo. Se envían solo los valores editados de la información de dispositivo básica a modo de protocolo al dispositivo.
`getUpdatedGeneralInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}`	GET	Recibe la información del dispositivo editada desde un dispositivo. Esta API se ejecuta después de ejecutar la API `updateGeneralInfo`.
`moveDevice`	`/restapi/v1.0/rms/devices/{deviceId}/move`	PUT	Mueve un dispositivo a otro grupo.
`startRmServerVnc`	`/restapi/v1.0/rms/devices/{deviceId}/rmserver/start`	GET	Envía un protocolo de inicio de gestión remota a un dispositivo. Un dispositivo que recibe un protocolo de inicio de gestión remota envía información periódicamente a través del servidor de gestión remota.
`stopRmServerVnc`	`/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop`	GET	Envía un protocolo de detención de gestión remota a un dispositivo. Un dispositivo que recibe un protocolo de detención detiene inmediatamente la función correspondiente.
`getSetupInfo`	`/restapi/v1.0/rms/devices/{deviceId}/setup`	GET	Importa la configuración del dispositivo. La configuración del dispositivo se actualiza cuando el dispositivo se conecta al servidor.
`updateSetupInfo`	`/restapi/v1.0/rms/devices/{deviceId}/setup`	PUT	Envía la configuración de dispositivo editada a un dispositivo. Se envían solo los valores editados de la configuración a modo de protocolo al dispositivo.
`getUpdatedSetupInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}`	GET	Recibe la configuración de dispositivo editada de un dispositivo. Esta API se ejecuta después de ejecutar la API `updateSetupInfo`.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display`	GET	Envía una solicitud de información de control de visualización actual a un dispositivo. Si se llama a esta API, se devuelve `requestId` como el valor `response`.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}`	GET	Importa la información de control de dispositivo enviada desde un dispositivo. Esta opción se utiliza para dos acciones: enviar una solicitud de información a un dispositivo y recibir la información real del dispositivo.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time`	GET	Envía una solicitud de información de la hora actual a un dispositivo. Si se llama a esta API, se devuelve `requestId` como el valor `response`.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}`	GET	Importa la información temporal enviada desde un dispositivo. El `requestId` recibido al llamar a `getCurrentStatusTime` debe enviarse como parámetro.
`getTimeInfo`	`/restapi/v1.0/rms/devices/{deviceId}/time`	GET	Importa la información temporal de dispositivo de la base de datos. Si no hay información de control, se debe enviar una solicitud de información al dispositivo.
`updateTimeInfo`	`/restapi/v1.0/rms/devices/{deviceId}/time`	PUT	Envía la información temporal editada a un dispositivo. Se envían solo los valores editados de la información temporal a modo de protocolo al dispositivo.
`getUpdatedTimeInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}`	GET	Recibe la información temporal editada desde un dispositivo. Esta API se ejecuta después de ejecutar la API `getUpdatedTimeInfoResult`.
`listDeviceGroupOrgan`	`/restapi/v1.0/rms/devices/groups`	GET	Importa una lista de organizaciones.
`listDeviceGroupInfo`	`/restapi/v1.0/rms/devices/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listDeviceGroupChild`	`/restapi/v1.0/rms/devices/groups/{groupId}/child`	GET	Busca subgrupos en `{groupId}`.

Usu.

Agregue usuarios y gestione la información de usuario. Los usuarios autenticados con privilegios para leer, escribir y gestionar información de usuario pueden acceder a los servicios relacionados con los usuarios.

Los servicios de gestión de usuarios disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`createUser`	`/restapi/v1.0/ums/users`	POST	Añade un usuario.
`listDashboardUserInfo`	`/restapi/v1.0/ums/users/dashboard`	GET	Importa la información de usuario necesaria desde el panel.
`updateMyInfo`	`/restapi/v1.0/ums/users/me`	PUT	Edita la información de usuario.
`listUserOrgan`	`/restapi/v1.0/ums/users/organization`	GET	Importa una lista de organizaciones. Esta opción se puede utilizar para configurar un árbol de grupos.
`listUserGroupOrgan`	`/restapi/v1.0/ums/users/groups`	GET	Importa una lista de organizaciones.
`listUserGroupInfo`	`/restapi/v1.0/ums/users/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listUserGroupChild`	`/restapi/v1.0/ums/users/groups/{groupId}/child`	GET	Importa una lista de subgrupos contenidos en el grupo `{groupId}`.

Configuración

Además de las funciones principales, puede utilizar muchas otras funciones para crear y gestionar etiquetas y categorías, así como editar el panel.

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`getCategoryInfo`	`/restapi/v1.0/ems/category/{categoryId}`	GET	Importa una lista de categorías.
`deleteDashboard`	`/restapi/v1.0/ems/dashboard`	DELETE	Elimina la información de un panel específico.
`listDashboardInfo`	`/restapi/v1.0/ems/dashboard`	GET	Importa el contenido que se mostrará en el panel personalizado. Es posible visualizar solo información específica en el panel.
`updateDashboardPriority`	`/restapi/v1.0/ems/dashboard`	PUT	Cambia el orden de los elementos que se muestran en el panel.
`createDashboard`	`/restapi/v1.0/ems/dashboard/create`	GET	Activa un panel inactivo.
`listDashboardLoginInfo`	`/restapi/v1.0/ems/dashboard/login`	GET	Importa la información de inicio de sesión que aparecerá en el panel.
`listDashboardNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice`	GET	Importa la información del tablón de anuncios que se mostrará en el panel.
`deleteNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	DELETE	Elimina una publicación del tablón de anuncios.
`listEditNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	GET	Importa los detalles de la publicación seleccionada.
`createNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	POST	Agrega publicaciones al tablón de anuncios.
`updateNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	PUT	Edita la publicación seleccionada en el tablón de anuncios.
`listDashboardStorageInfo`	`/restapi/v1.0/ems/dashboard/storage`	GET	Importa la información de almacenamiento que se mostrará en el panel.
`listLicense`	`/restapi/v1.0/ems/license`	GET	Importa una lista de las licencias registradas en el servidor.
`getServerSetupInfo`	`/restapi/v1.0/ems/setup`	GET	Importa la configuración del servidor. Los elementos de configuración del servidor incluyen opciones que permiten activar o desactivar diferentes funciones en el servidor.
`getTagListInfo`	`/restapi/v1.0/ems/tag`	POST	Importa una lista de etiquetas registradas en el servidor.

Detalles de Open API (interfaz de usuario de Swagger)

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

Sv translation

language	zh_CN

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

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

身份验证

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

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

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

服务名称	API 调用	调用类别	说明
`authenticationRequest`	`/auth`	POST	使用用户 ID 和密码导入令牌值以进行验证。
`authenticationRequest`	`/auth/refresh`	GET	创建新令牌以延长过期时间。可以调用 REST API 而无需再次登录

OPEN API (v2.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` 作为 `response` 值返回。
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}`	GET	导入从设备发送的显示屏控制信息。此选项用于两个操作：将信息请求发送到设备和接收实际设备信息。
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time`	GET	将当前时间信息请求发送到设备。当调用该 API 时，`requestId` 作为 `response` 值返回。
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}`	GET	导入从设备发送的时间信息。必须以参数形式发送通过调用 `getCurrentStatusTime` 接收的 `requestId`。
`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

Content

Space Tools

Page History

Versions Compared

Old Version 20

New Version 21

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)

Authentification

OPEN API (v2.0)

Contenu :

Liste de lecture

Programme

Périphérique

Utilisateur

Réglage

Détails sur Open API (interface utilisateur Swagger)

Authentifizierung

OPEN API (v2.0)

Inhalt

Wiedergabeliste

Zeitplan

Gerät

Benutzer

Einstellung

Open API-Details (Swagger UI)

Autenticazione

OPEN API (v2.0)

Contenuto

Playlist

Programma

Dispositivo

Utente

Impostazioni

Dettagli Open API (swagger UI)

Autenticación

OPEN API (v2.0)

Contenido

Lista de reproducción

Programación

Dispositivo

Usu.

Configuración

Detalles de Open API (interfaz de usuario de Swagger)

身份验证

OPEN API (v2.0)

内容

播放列表

日程表

设备

用户

设置

Open API 详情 (swagger UI)