NSILM

GS: DashboardDefinition: API: PUT /dashboard-api/dashboard-definitions/{dashboardDefinitionId}/institutions

Muutja: Andres Mill · 2025-07-25

Üldkirjeldus

Teenus abil saab muuta juhtimislaua asutuse liiki muuta..

Seotud andmeobjektid:

NSIL-469 - Getting issue details... STATUS NSIL-681 - Getting issue details... STATUS NSIL-1133 - Getting issue details... STATUS NSIL-1223 - Getting issue details... STATUS NSIL-1238 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kasutaja poolt valitud rollil peab olema juhtimislauaga seotud valdkonna haldamise õigus.
    • DashboardDefinition.domainType = Klassifikaatorid#KlassifikaatorDOMAIN, mis on seotud DASHBOARD_MANAGE_PRIVILEGE  (attributeDefinitionCode) privileegiga, mis on kasutaja poolt valitud rollile lisatud.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
dashboardDefinitionId1UUID
  • Juhtimislaud ei tohi olla kustutatud.
    • DashboardDefinition.objectStatus = CURRENT
Juhtimislaua id (UUID).
institutions0..*Array


Asutuste liikide nimekiri, mille kasutajatele juhtimislaud avaldatakse. Ühele juhtimislauale võidakse lisada mitu asutuse liiki.

institutions.institutionType0..1EHIS Classifier Object

Juhtimislaua liik.

institutions.specificationTypes0..*Array
  • Kohustuslik esitada vähemalt üks Klassifikaatorid#KlassifikaatorOPPEASUTUSE_TYYP väärtus, kui institutionType = Õppeasutus.
  • Ei tohi esitada ühtegi väärtust, kui institutionType != Õppeasutus.
  • Ei tohi esitada mitu sama liigiga kirjet.

Asutuse liigi täpsustused. Ühel asutuse liigil võib olla mitu täpsustust.

institutions.institutionIds0..*Array
  • Ei tohi esitada mitu sama asutuse institutionId kirjet.

Asutuste nimekiri, mille kasutajatele juhtimislaud avaldatakse. Ühele juhtimislauale võidakse lisada mitu asutust.

visibleToOwner0..1Boolean
  •  Lubatud väärtused:
    • true
    • false
      • Kui null, siis salvestatakse väärtus false.

Määrab, kas juhtimislaud on õppeasutuse pidajale nähtav või mitte.

true - juhtimislaud on pidajale õppeasutuse rollis nähtav.

false - juhtimislaud ei ole pidajale õppeasutuse rollis nähtav.

htmStructureUnits0..*Array


Määrab, millistele HTM struktuuriüksuste töötajatele juhtimislaud avaldatud on.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
Sama, mis GS: DashboardDefinition: API: POST /quality-api/dashboard-definitions#V%C3%A4ljundid

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:
      • id = Sisendis esitatud dashboardDefinitionId väärtus.
      • objectStatus = CURRENT
        1. Kui objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem muudab juhtumislaua üldandmeid.
    • Süsteem muudab leitud Objektid#DashboardDefinition objekti andmeid:
      • institutions.institutionType = Sisendis esitatud institutions.institutionType. Kui sisendis ei ole ühtegi väärtust defineeritud, siis kustutab süsteem andmebaasist array väärtused.
      • institutions.specificationTypes = Sisendis esitatud institutions.specificationType. Kui sisendis ei ole ühtegi väärtust defineeritud, siis kustutab süsteem andmebaasist array väärtused.
      • institutions.institutionIds = Sisendis esitatud institutions.institutionIds. Kui sisendis ei ole ühtegi väärtust defineeritud, siis kustutab süsteem andmebaasist array väärtused.
      • visibleToOwner = Sisendis esitatud visibleToOwner.
      • htmStructureUnits = Sisendis esitatud htmStructureUnits väärtused.
      • audit (muutmine) = audit (muutmine)
  5. Süsteem tagastab muudetud andmed.