Page History

Versions Compared

Old Version 103

changes.mady.by.user user-f347e

Saved on Aug 03, 2018

compared with

New Version 104

changes.mady.by.user user-f347e

Saved on Aug 03, 2018

Key

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

Comment: Content imported from a Scroll Translations translation file.

...

Sv translation

language	sv

I MagicINFO Server kan du implementera innehållshantering, schemahantering, enhetshantering och andra funktioner genom att anropa Open API (v2.0).

Om du vill använda Open API (v2.0) måste du först gå igenom en autentiseringsprocess. Använd en särskild swagger-sida för att testa varje API.

Autentisering

När du anropar alla Open API (v2.0)-objekt, måste api_token ingå i huvudet. Om detta inte tas med returneras felet "401 Unauthorized".

En erhållen token upphör att gälla och blir omöjlig att använda efter en viss tid. Om så är fallet bör du skaffa en ny token.

api_token kan erhållas genom att man anropar följande api.

Servicenamn	API-anrop	Anropstyp	Beskrivning
authenticationRequest	/auth	POST	Importerar ett token-värde för autentisering med hjälp av användar-ID:t och lösenordet.
authenticationRequest	/auth/refresh	GET	Skapar en ny token för att förlänga giltighetstiden. Det är möjligt att anropa REST API utan att logga in igen.

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) innehåller en mängd olika funktioner. Konfiguration av varje funktion visas nedan.

Kategori	Styrenhet	Beskrivning
Innehåll	content-controller	Hantering av innehåll
Innehåll	content-group-controller	Hantering av innehållsgrupper
Spellista	playlist-controller	Hantera spellistor
Spellista	playlist-group-controller	Hantering av spellistegrupper
Schema	content-schedule-controller	Hantering av innehållsscheman
	content-schedule-group-controller	Hantering av grupper av innehållsscheman
	message-schedule-controller	Hantering av meddelandescheman
	message-schedule-group-controller	Hantering av grupper av meddelandescheman
Enhet	device-controller	Enhetshantering
Enhet	device-group-controller	Hantering av enhetsgrupper
Användare	user-controller	Användarhantering
Användare	user-group-controller	Hantering av användargrupper
Inställning	environment-controller	Inställning

Innehåll

Överföraöverföra, godkänna och radera innehåll. Hantera innehållslistor. Innehållsrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera innehåll.

Följande innehållshanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllContent	/restapi/v1.0/cms/contents	GET	Importerar en lista med överfört innehåll. Innehållsminiatyrer, namn, filtyper och andra grundläggande uppgifter ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Importerar allmän innehållsinformation som ska visas på instrumentpanelen.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importerar en lista med innehåll som filtrerats baserat på villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Tar bort innehållet, oavsett om innehållet ingår i en spellista eller ett schema.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Tar bort innehåll efter en kontroll av att innehållet inte ingår i en spellista eller ett schema. Om du försöker ta bort innehåll som ingår i en spellista eller ett schema, tas innehållet inte bort och en felkod returneras.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Importerar information om en aktiverad version av ett visst innehåll. Innehållets version uppdateras varje gång innehållet redigeras.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Godkänner/avvisar innehåll. Godkänt innehåll flyttas till den allmänna innehållslistan och kan användas i spellistor och scheman.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Överför överför nytt innehåll.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importerar en lista med standardinnehållsgrupper.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Spellista

Använd innehåll för att skapa, redigera och ta bort spellistor. Spellisterelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera innehåll.

Följande spellistehanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importerar en lista med samtliga spellistor. Spellistenamn, huvudinnehållsminiatyrer, spellistetyper och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Skapa en ny spellista.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importerar nödvändig spellisteinformation från instrumentpanelen.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importerar en lista med spellistor som filtrerats baserat på villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Ta bort den markerade spellistan. Om du försöker ta bort en spellista som ingår i en ett schema, tas spellistan inte bort och en felkod returneras.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Importerar information om en aktiverad version av en spellista. Spellistans version uppdateras varje gång spellistan redigeras.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Redigerar spellistan {playlistId}. När en spellista redigeras uppdateras dess version, och den spelare som spelar upp spellistan spelar automatiskt upp den uppdaterade spellistan.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Kopierar spellistan {playlistId}. En kopia av spellistan skapas.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importerar en lista med grupper av standardspellistor.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Schema

Skapa nya innehålls- eller meddelandescheman. Publicera scheman till enheter för uppspelning. Redigera eller ta bort scheman.

Schemarelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera scheman.

Följande schemahanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importerar en lista med alla innehållsscheman. Innehållsschemanamn, tillkomstdatum, spellistetyper och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Skapar ett nytt innehållsschema. Ett innehållsschema kan innehålla flera kanaler och ramar. Publicera ett schema till enheter och spela upp önskat innehåll eller en önskad spellista vid en angiven tidpunkt.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Import nödvändig innehållsschemainformation från instrumentpanelen.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importerar en lista med innehållsscheman som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Ta bort ett innehållsschema. Om du tar bort ett schema som tidigare har publicerats till en enhet, spelar enheten automatiskt upp standardinnehållet.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Importerar information om det markerade schemat.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Redigerar ett innehållsschema. Om du redigerar ett schema som tidigare har publicerats till en enhet, spelar enheten automatiskt upp det redigerade schemat.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Kopierar innehållsschemat {programId}. En kopia av innehållsschemat {programId} skapas.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Publicerar ett innehållsschema till en specifik enhetsgrupp.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Importerar hämtningsstatus för innehållsscheman i realtid från en enhet.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importerar en lista med rotgrupper för ett innehållsschema.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importerar en lista med samtliga meddelandescheman.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Skapar ett nytt meddelandeschema.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Importerar en lista med meddelandescheman som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Tar bort det markerade meddelandeschemat. Om du tar bort ett meddelandeschema som tidigare har publicerats till en enhet, tillämpas ändringen automatiskt på enheten.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Importerar information om det markerade meddelandeschemat.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Redigerar det markerade meddelandeschemat. Om du redigerar ett meddelandeschema som tidigare har publicerats till en enhet, tillämpas ändringen automatiskt på enheten.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Kopierar det markerade meddelandeschemat. En kopia av meddelandeschemat skapas.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Publicerar det markerade meddelandeschemat till en enhetsgrupp.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importerar en lista med rotgrupper för ett innehållsschema.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importerar en lista med undergrupper under en specifik grupp.

Enhet

Styr och hantera enheter. Enhetsrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera enheter.

Följande enhetshanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllDevice	/restapi/v1.0/rms/devices	GET	Importerar en lista med samtliga enheter. Enheters strömstatus, information om miniatyrer, enheters felstatus och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Importerar nödvändig enhetsinformation från instrumentpanelen.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importerar en lista med enheter som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Tar bort den markerade enheten.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importerar information om markerade enheter.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Godkänner den markerade enheten för en specifik grupp.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importerar information om Cabinet som är anslutna till en LED-enhet. Den importerade informationen är endast giltig när dina Cabinet är anslutna till en LED-enhet.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Redigerar information om Cabinet som är anslutna till en LED-enhet.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importerar enhetens skärmstyrningsinformation från databasen. Om det inte finns någon styrningsinformation ska en informationsbegäran skickas till enheten.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Skickar redigerad skärmstyrningsinformation till en enhet. Bara redigerade värden i skärminformationen skickas som ett protokoll till enheten.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Tar emot redigerad skärmstyrningsinformation från en enhet. Detta API kan köras efter att API:t updateDisplayInfo har körts.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Importerar allmän enhetsinformation från databasen. Allmän enhetsinformation uppdateras när enheten ansluts till servern.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Skickar redigerad enhetsinformation till en enhet. Bara redigerade värden i den grundläggande enhetsinformationen skickas som ett protokoll till enheten.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Tar emot redigerad enhetsinformation från en enhet. Detta API kan köras efter att API:t updateGeneralInfo har körts.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Flyttar en enhet till en annan grupp.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Skickar ett RM-startprotokoll till en enhet. En enhet som fått ett RM-startprotokoll skickar med jämna mellanrum information via fjärrservern.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Skickar ett RM-stopprotokoll till en enhet. En enhet som fått ett stopprotokoll stoppar motsvarande funktion omedelbart.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Importerar enhetsinställningar. Enhetens inställningar uppdateras när enheten ansluts till servern.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Skickar redigerade enhetsinställningar till en enhet. Bara redigerade värden i inställningarna skickas som ett protokoll till enheten.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Tar emot redigerade enhetsinställningar från en enhet. Detta API kan köras efter att API:t updateSetupInfo har körts.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Skickar en aktuell begäran om skärmstyrningsinformation till en enhet. Om detta API anropas, returneras requestId som svarsvärde.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importerar skärmstyrningsinformation som skickats från en enhet. Det här alternativet används för två åtgärder: för att skicka en begäran om information till en enhet och för att ta emot själva enhetsinformationen.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Skickar en begäran om aktuell tidsinformation till en enhet. Om detta API anropas, returneras requestId som svarsvärde.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importerar tidsinformation som skickats från en enhet. Det här alternativet används för två åtgärder: för att skicka en begäran om information till en enhet och för att ta emot själva enhetsinformationen.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Importerar tidsinformation för en enhet från databasen. Om det inte finns någon styrningsinformation ska en informationsbegäran skickas till enheten.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Skickar redigerad tidsinformation till en enhet. Bara redigerade värden i tidsinformationen skickas som ett protokoll till enheten.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Tar emot redigerad enhetstidsinformation från en enhet. Detta API kan köras efter att API:t getUpdatedTimeInfoResult har körts.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Importerar en lista med organisationer.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importerar information om undergrupper under {groupId}.

Användare

Lägg till användare och hantera användarinformation. Användarrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera användarinformation.

Följande användarhanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
createUser	/restapi/v1.0/ums/users	POST	Lägger till en användare.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importerar nödvändig användarinformation från instrumentpanelen.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Redigerar användarinformation.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importerar en lista med organisationer. Det här alternativet kan användas för att konfigurera ett gruppträd.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importerar en lista med organisationer.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Inställning

Förutom huvudfunktionerna kan du använda många andra funktioner till att skapa och hantera taggar och kategorier samt redigera instrumentpanelen.

Servicenamn	API-anrop	Anropstyp	Beskrivning
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importerar en lista med kategorier.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Tar bort specifik instrumentpanelsinformation.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importerar innehåll som ska visas på den anpassade instrumentpanelen. Det går att visa endast specifik information på instrumentpanelen.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Ändrar ändrar ordning på de objekt som visas på instrumentpanelen.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Aktiverar en inaktiv instrumentpanel.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importerar inloggningsinformation som ska visas på instrumentpanelen.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importerar anslagstavleinformation som ska visas på instrumentpanelen.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Tar bort ett inlägg från anslagstavlan.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importerar information om det markerade inlägget.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Lägger till inlägg på anslagstavlan.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Redigerar det markerade inlägget på anslagstavlan.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importerar lagringsinformation som ska visas på instrumentpanelen.
listLicense	/restapi/v1.0/ems/license	GET	Importerar en lista med licenser som registrerats på servern.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importerar serverinställningar. Serverinställningsobjekt inkluderar alternativ som kan slå på och av olika funktioner på servern.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Importerar en lista med taggar som registrerats på servern.

Open API-information (swagger UI)

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

Content

Space Tools