NSILM

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

Muutja: Andres Mill · 2025-07-25

Üldkirjeldus

Teenus otsib kasutaja lemmikuks märgitud juhtimislaua elementide andmed.

Seotud andmeobjektid:

NSIL-485 - Getting issue details... STATUS NSIL-653 - 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
dashboardDefinitionId0..1UUID
  • Juhtimislaud ei tohi olla kustutatud.
    • DashboardDefinition.objectStatus = CURRENT
  • Juhtimislaud peab olema avalikustatud staatused.
    • DashboardDefinition.statusType = PUBLIC
  • Juhtimislaud peab olema avalikustatud kasutajaga seotud asutusele.
    • DashboardDefinition.institutions.institutionType = Kasutaja rollidele määratud asutuse tüübid (EHIS x-tee teenus GET/users/v1/users.response.data.users.institution.type)
    • või DashboardDefinition.institutions.institutionIds = GET hsilm-gateway/userinfo.response.organizations.institutionId
Juhtimislaua id.
displayLocationTypes0..*Array


Lemmikuks märgitud aruande kuvamise asukoht.
institutionId0..1StringAsutus, millega juhtimislaud ja kasutaja seotud on.

Väljundid

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

0..*

Array
  • Lemmiku objekti id.
  • Nimekirja objektid on samad, mis GS: UserDashboardElement: API: POST /dashboard-api/user-dashboard-elements#V%C3%A4ljundid
  • NB! Kui mõni järgnev tingimus ei ole aruande komponendi kohta täidetud, siis sellist elementi ei lisata päringu vastusesse.
    • Päringu vastuses olevad elemendid ei tohi olla kustutatud.
      • DashboardDefinitionElement.objectStatus = CURRENT
    • Päringu vastuses olevate elementidega seotud juhtimislauad ei tohi olla kustutatud.
      • DashboardDefinition.objectStatus = CURRENT
    • Päringu vastuses olevate elementidega seotud juhtimislauad peavad olema avalikustatud staatused.
      • DashboardDefinition.statusType = PUBLIC
    • Päringu vastuses olevate elementidega seotud juhtimislauad peavad olema avalikustatud kasutajaga seotud asutusele.
      • DashboardDefinition.institutions.institutionType = Kasutaja rollidele määratud asutuse tüübid (EHIS x-tee teenus GET/users/v1/users.response.data.users.institution.type)

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 otsib kasutaja lemmik aurande objektid.
    • Süsteem otsib Objektid#UserDashboardElement objekte, mille:
      • userPersonalCode = Kasutaja isikukood tokenist.
      • dashboardElements.displayLocationType = Sisendis esitatud displayLocationTypes väärtused
      • dashboardElements.institution.id = Sisendis esitatud institutionId väärtus
      • NB! Tagastatavate elementide nimistu täiendavad kitsendused on kirjeldatud Väljund - Kirjeldus, täiendav info
  4. Süsteem tagastab leitud andmed.