NSILM

GS: DashboardDefinitionElementReportUrl: API: POST /dashboard/dashboards/{dashboardId}/elements/{dashboardElementId}/reports/{dashboardElementReportId}/urls

Muutja: Andres Mill · 2025-09-24

Üldkirjeldus

Teenus loob juhtimislaua aruande elemendi jagamise lingi.

Seotud andmeobjektid:

NSIL-521 - 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
dashboardId1UUID
  • Juhtimislaud ei tohi olla kustutatud.
    • DashboardDefinition.objectStatus = CURRENT
  • Juhtimislaud peab olema avalikustatud staatuses.
    • DashboardDefinition.statusType = PUBLIC
Juhtimislaua id.
dashboardElementId1UUID
  • Aruande komponent ei tohi olla kustutatud.
    • DashboardDefinitionElement.objectStatus = CURRENT
Juhtimislaua aruande komponendi id.
dashboardElementReportId1UUID
  • Aruande komponendi näitaja ei tohi olla kustutatud.
    • DashboardDefinitionElementReport.objectStatus = CURRENT
Juhtimislaua aruande komponendi näitaja id.
institutionId1StringAsutus, millega juhtimislaud ja kasutaja seotud on.
bookmark0..1String
  • PBI aruande filtrite snapshot (bookmark) vastavalt kasutaja tehtud valikutele.
  • Sisu maksimaalne pikkus: 4000 tähemärki
  • Sisu eeldatav formaat: base64
Aruandele rakendatud filtrite snapshot (base64 formaadis).

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info

id

1

UUIDJagamise lingi Id.
dashboardDefinitionId1String (FK)

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

dashboardDefinitionElementId

1

String (FK)

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

dashboardDefinitionElementReportId

1

String (FK)

Viide juhtumislaua elemendi raporti objektile, millega juhtimislaua elemendi seotud on. Viitab DashboardDefinitionElementReport.id väärtusele.

bookmark

0..1

StringAruandele rakendatud filtrite snapshot (bookmark) base64 formaadis.
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)

createdAt1Date and timeURLi objekti loomise aeg.

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 juhtimislaua üldandmed.
    • Süsteem otsib Objektid#DashboardDefinition objekti, mille:
      • Asutuse tüübile avaldatud juhtimislaud.
        • statusType = PUBLIC
        • institutions.institutionType =
          • GET /hsilm-gateway/userinfo.response.organizations.institutionType
          • Või GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.type, mille educationalInstitutions.owner.regCode = GET hsilm-gateway/userinfo.response.organizations.regCode, mille privilegeList sisaldab privileegi HSILM_OWNER_DASHBOARD_SEARCH 
        • institutions.specificationTypes =
          • GET /hsilm-gateway/userinfo.response.organizations.institutionSubType
          • Või GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.type, mille educationalInstitutions.owner.regCode = GET hsilm-gateway/userinfo.response.organizations.regCode, mille privilegeList sisaldab privileegi HSILM_OWNER_DASHBOARD_SEARCH  
            • specificationTypes järgi filtreerimist kasutatakse, kui asutuse tüüp on õppeasutus.
              • GET /hsilm-gateway/userinfo.response.organizations.institutionType = EDUCATIONAL_INSTITUTION
        • Kui kasutaja on pidaja rollis, siis visibleToOwner = true, muudel juhtudel visibleToOwner parameetri kitsendust ei rakendata.
        • Kui kasutaja ei ole pidaja rollis, siis kitsendatakse päringut valdkondaega, mille vaatamise õigus kasutajal (pidaja rollis seda ei tehta) on ehk:
          • domainType = Klassifikaatorid#KlassifikaatorDOMAIN väärtused, mille ClassifierAttributeValue.classifierAttributeDefinitionCode = DASHBOARD_VIEW_PRIVILEGE ja ClassifierAttributeValue.attributeValue = tokenist organizations.privilegeList, mille organizations.institutionId = Sisendis esitatud institutionId.
        • objectStatus = CURRENT
      • Registrikoodile avaldatud juhtimislauad.
        • statusType = PUBLIC
        • institutions.institutionId = 
        • Kui kasutaja on pidaja rollis, siis visibleToOwner = true, muudel juhtudel visibleToOwner parameetri kitsendust ei rakendata.
        • objectStatus = CURRENT
      • HTM struktuuriüksusele avaldatud juhtimislaud
          • id = dashboardId
          • statusType = PUBLIC
          • htmStructureUnits = GET /hsilm-gateway/userinfo.response.relatedHtmStructures.id
          • objectStatus = CURRENT
              1. Kui juhtimislauda ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem loob kasutaja lemmik aurande objekti.
    • Süsteem loob Objektid#DashboardDefinitionElementReportUrl objekti:
      • id = UUID
      • userPersonalCode = Kasutaja isikukood tokenist.
      • institution.id = Sisendis esitatud institutionId väärtus.
      • institution.type = institutionId väärtusega seotud institutionType väärtus (EHIS päringust/tokenist)
      • dashboardDefinitionId = Sisendis esitatud dashboardId väärtus.
      • dashboardDefinitionElementId = Sisendis esitatud dashboardElementId väärtus.
      • dashboardDefinitionElementReportId = Sisendis esitatud dashboardElementReportId väärtus.
      • bookmark = Sisendis esitatud bookmark väärtus.
      • audit (loomine) = audit (loomine)
  5. Süsteem tagastab loodud andmed.