NSILM

GS: UserDashboardElement: API: POST /dashboard-api/user-dashboard-elements

Muutja: Andres Mill · 2025-07-11

Üldkirjeldus

Teenus lisab juhtimislaua raporti kasutaja lemmik raportite hulka.

Seotud andmeobjektid:


NSIL-484 - Getting issue details... STATUS NSIL-653 - Getting issue details... STATUS NSIL-679 - Getting issue details... STATUS NSIL-1134 - Getting issue details... STATUS NSIL-1224 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kasutajal peab olema autenditud ja autoriseeritud (Omab kehtivat tokenit).

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
dashboardDefinitionElementId1UUID
  • Aruande komponent ei tohi olla kustutatud.
    • DashboardDefinitionElement.objectStatus = CURRENT
  • Aruande komponendiga seotud juhtimislaud ei tohi olla kustutatud.
    • DashboardDefinition.objectStatus = CURRENT
  • Aruande komponendiga seotud juhtimislaud peab olema avalikustatud staatused.
    • DashboardDefinition.statusType = PUBLIC
Juhtimislaua aruande komponendi id.
dashboardDefinitionElementReportId1UUID
  • Aruande komponendi näitaja ei tohi olla kustutatud.
    • DashboardDefinitionElementReport.objectStatus = CURRENT
    • DashboardDefinitionElementReport.dashboardDefinitionElementId = Sisendis esitatud dashboardDefinitionElementId väärtus.
Juhtimislaua aruande komponendi näitaja id.
institutionId1StringAsutus, millega juhtimislaud ja kasutaja seotud on.
bookmark0..1String
  • PBI aruande küljest vastavalt kasutaja tehtud valikutele.
  • Sisu maksimaalne pikkus: 4000 tähemärki
Juhtimislaua elemendi filtrite andmed.
displayLocationType1UUID
  • Lubatud väärtused:
    • MAIN_DASHBOARD - Süsteemi töölaud (Lemmikud).
    • DASHBOARD - Juhtimislaud (Esiletõstetud).
  • Samale elemendile võib lisada sama kuvamise asukoha tüüpi mitu korda.
Lemmikuks märgitud elemendi kuvamise asukoht.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
id

1

UUIDLemmiku objekti id.
dashboardDefinitionId1String (FK)

Viide juhtumislaua objektile, millega juhtimislaua element seotud on. Viitab DashboardDefinition.id väärtusele.

dashboardDefinitionElementId

1

String (FK)

Viide juhtumislaua elemendi objektile, millega juhtimislaua element seotud on. Viitab DashboardDefinitionElement.id väärtusele.

dashboardDefinitionElementReportId

1

String (FK)

Juhtimislaua aruande komponendi näitaja id.

bookmark

0..1

String

Juhtimislaua elemendi aktiveeritud filtrid lemmikuks märkimise hetkel.

displayLocationType1Enum

Lemmikuks märgitud aruande kuvamise asukoht. Võimalikud väärtused:

  • MAIN_DASHBOARD - Süsteemi töölaud.
  • DASHBOARD - Juhtimislaud.
institution

1

ObjectAsutus, millega kasutaja lemmikuks märgitud töölaud seotud on.
institution.id

1

StringViide hindamisega seotud asutusele EHISes.
institution.type1EHIS Classifier

Asutuste liik. (KOV, õppeasutus)

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  2. Süsteem valideerib sisendi.
    1. Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  3. Süsteem loob kasutaja lemmik aruande objekti.
    • Süsteem loob Objektid#UserDashboardElement objekti:
      • Järgnevad andmed luuakse, kui kasutajale ei ole lemmik aruannete nimistu objekti loodud:
        • id = UUID
        • userPersonalCode = Kasutaja isikukood tokenist.
      • Järgnevad andmed luuakse iga kord: 
        • dashboardElements.id = UUID
        • dashboardElements.dashboardDefinitionId = Sisendis esitatud dashboardDefinitionElementId väärtusega seotud dashboardDefinitionId väärtus.
        • dashboardElements.dashboardDefinitionElementId = Sisendis esitatud dashboardDefinitionElementId väärtus.
        • dashboardElements.dashboardDefinitionElementReportId = Sisendis esitatud dashboardDefinitionElementReportId väärtus.
        • dashboardElements.institution.id = Sisendis esitatud institutionId väärtus.
        • dashboardElements.institution.type = institutionId väärtusega seotud institutionType väärtus (EHIS päringust/tokenist)
      • Järgnevad andmed luuakse, kui kasutajal olid lemmikuks märkimise hetkel filtrid aktiveeritud:
        • dashboardElements.bookmark = Sisendis esitatud bookmark väärtused.
  2. Süsteem tagastab loodud andmed.