NSILM

GS: AssessmentModel: API: PUT /quality-api/assessment-models/{id}

Muutja: Andres Mill · 2025-10-13

Üldkirjeldus

Teenus muudab hindamismudeli detailandmeid.

Seotud andmeobjektid:

NSIL-70 - Getting issue details... STATUS NSIL-88 - Getting issue details... STATUS NSIL-94 - Getting issue details... STATUS NSIL-102 - Getting issue details... STATUS NSIL-684 - Getting issue details... STATUS NSIL-710 - Getting issue details... STATUS NSIL-996 - Getting issue details... STATUS NSIL-1143 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kasutajal peab olema privileeg ASSESSMENT_MODEL_MANAGE_PRIVILEGE


Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
id1String
  • Kasutajal peab olema hindamismudeliga seotud valdkonna haldamise õigus.

Hindamismudeli id (UUID).

name1String3-250 tähemärki.

Hindamismudeli nimetus.

validFrom1Date
  • validFrom >= Päringu teostamise kuupäev.
  • Saab muuta, kui hindamismudel on esitamata või kui hindamismudel on esitatud, aga kehtivuse algus ei ole saabunud.
    • AssessmentModel.confirmed  = false või true.
      • Kui AssessmentModel.confirmed  = true, siis AssessmentModel.validFrom > Päringu teostamise kuupäev.
Hindamismudeli kehtivuse algus.
validUntil0..1Date
  • validUntil >= validFrom
  • Kui hindamismudel on kinnitatud, siis ei tohi hindamismudeli kehtivuse aeg kattuda mõne teise sama liiki kinnitatud hindamismudeli kehtivusajaga.
    • Tingimus:  AssessmentModel.confirmed  = true
    • Validateerimine: Sisendis validUntil ei tohi kuuluda mõne muu AssessmentModel.validFrom (kaasa arvatud) ja AssessmentModel.validUntil (välja arvatud) vahemikku, mille AssessmentModel.assessmentType = muudetava AssessmentModel.assessmentType ja AssessmentModel.objectStatus = CURRENT
  • Saab muuta, kui hindamismudeli äriline staatus on "Mustand", "Kinnitatud" või "Kehtiv". Muudel juhtudel väärtust muuta ei saa.
    • Mustand: confirmed = false
    • Kinnitatud: confirmed = true, validFrom > päringu teostamise aeg.
    • Kehtiv: confirmed = true, validFrom <= päringu teostamise aeg, validUntil > päringu teostamise aeg.
Hindamismudeli kehtivuse lõpp.
phaseTypes1..*Array
  • Peavad olema Klassifikaatorid#KlassifikaatorASSESSMENT_PHASE hulgas.
  • Kui ei ole tegemist hierarhilise hindamis liigiga, siis peab minimaalselt olema kaasatud kohustuslikud etapid. Võivad olla kaasatud ka teised etapid.
  • Kui on tegemist hierarhilise hindamis liigiga, mis on hierarhilise hindamise peamine hindamise liik, siis peab minimaalselt olema kaasatud kohustuslikud etapid. Võivad olla kaasatud ka teised etapid.
  • Kui on tegemist hierarhilise hindamis liigiga, mis on hierarhilise hindamise alamhindamise liik, siis peab minimaalselt olema kaasatud enesehindamise etapp. Teisi etappe ei tohi kaasata.
    • Kui AssessmentModel.assessmentHierarchyType = SUB_ASSESSMENT, siis peab sisendis olema määratud vähemalt SELF_ASSESSMENT etapp.
  • Saab muuta, kui hindamismudel on esitamata või kui hindamismudel on esitatud, aga kehtivuse algus ei ole saabunud.
    • AssessmentModel.confirmed  = false või true.
      • Kui AssessmentModel.confirmed  = true, siis AssessmentModel.validFrom > Päringu teostamise kuupäev.
  • Ei tohi esitada mitu sama liigiga kirjet.

Hindamismudeli etapid.

institutions.institutionTypes0..*Array
  • Peavad olema Klassifikaatorid#KlassifikaatorINSTITUTION_TYPE hulgas kehtivad kirjed.
  • Saab muuta, kui hindamismudel ei ole kehtetu (on Mustand, Kinnitatud või Kehtiv staatuses).
    • AssessmentModel.confirmed  = false või true.
      • Kui AssessmentModel.confirmed  = true, siis AssessmentModel.validFrom <= Päringu teostamise kuupäev.
  • Ei tohi esitada mitu sama liigiga kirjet.
  • Lubatud kasutada, kui hindamismudel on mõeldud asutusepõhiseks kasutamiseke.
    • AssessmentModel.assessmentScope = INSTITUTIONAL
  • Peab olema null, kui publishedToAllUsers = true

Asutuste liikide nimekiri, mille kasutajatele hindamismudel avaldatakse. 

institutions.specificationTypes0..*Array
  • Kohustuslik esitada vähemalt üks Klassifikaatorid#KlassifikaatorOPPEASUTUSE_TYYP väärtus, kui institutionType = Õppeasutus.
  • Kui tegemist on asutusepõhise hindamisega, siis on kohustuslik esitada vähemalt üks Klassifikaatorid#KlassifikaatorOPPEASUTUSE_TYYP väärtus, kui institutionType = Õppeasutus.
    • AssessmentModel.assessmentScope = INSTITUTIONAL
  • Kui tegemist on asutusepõhise hindamisega, siis ei tohi esitada ühtegi väärtust, kui institutionType != Õppeasutus.
    • AssessmentModel.assessmentScope = INSTITUTIONAL
  • Kui tegemist on isikupõhise hindamisega, siis tohib esitada õppeasutuse täpsustusi. Ei ole kohustuslik.
    • AssessmentModel.assessmentScope = INDIVIDUAL
  • Saab muuta, kui hindamismudel ei ole kehtetu (on Mustand, Kinnitatud või Kehtiv staatuses).
    • AssessmentModel.confirmed  = false või true.
      • Kui AssessmentModel.confirmed  = true, siis AssessmentModel.validFrom <= Päringu teostamise kuupäev.
  • Ei tohi esitada mitu sama liigiga kirjet.
  • Lubatud kasutada kui tegemist on peamise hindamismudeliga või mittehierarhiline hindamismudeliga.
    • AssessmentModel.assessmentHierarchyType = MAIN_ASSESSMENT või null
  • Peab olema null, kui publishedToAllUsers = true

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

institutions.institutionIds0..*Array
  • Saab muuta, kui hindamismudel ei ole kehtetu (on Mustand, Kinnitatud või Kehtiv staatuses).
    • AssessmentModel.confirmed  = false või true.
      • Kui AssessmentModel.confirmed  = true, siis AssessmentModel.validFrom <= Päringu teostamise kuupäev.
  • Ei tohi esitada mitu sama asutuse institutionId kirjet.
  • Lubatud kasutada, kui hindamismudel on mõeldud asutusepõhiseks kasutamiseke.
    • AssessmentModel.assessmentScope = INSTITUTIONAL
  • Peab olema null, kui publishedToAllUsers = true

Asutuste nimekiri, mille kasutajatele hindamismudel avaldatakse. Ühele mudelile võidakse lisada mitu asutust.

jobsites 0..*Array
  • Saab muuta, kui hindamismudel ei ole kehtetu (on Mustand, Kinnitatud või Kehtiv staatuses).
    • AssessmentModel.confirmed  = false või true.
      • Kui AssessmentModel.confirmed  = true, siis AssessmentModel.validFrom <= Päringu teostamise kuupäev.
  • Peab olema EHIS klassifikaatori PEDAGOOG_AMETIKOHT hulgas kehtiv element.
  • Lubatud kasutada ja on kohustuslik, kui hindamismudel on mõeldud isikupõhiseks hindamiseks ja tegemist on peamise hindamismudeliga või mittehierarhiline hindamismudeliga.
    • AssessmentModel.assessmentScope = INDIVIDUAL
    • AssessmentModel.assessmentHierarchyType = MAIN_ASSESSMENT või null
  • Peab olema null, kui publishedToAllUsers = true

Loend ametikohtadest, millele hindamismudel on avatud. 

includedSubRoles0..*Array
  • Saab muuta, kui hindamismudel ei ole kehtetu (on Mustand, Kinnitatud või Kehtiv staatuses).
    • AssessmentModel.confirmed  = false või true.
      • Kui AssessmentModel.confirmed  = true, siis AssessmentModel.validFrom <= Päringu teostamise kuupäev.
  • Lubatud kasutada, kui tegemist on hierarhilise hindamismudeli peamise hindamismudeliga. Teiste hindamismudelite korral ei ole lubatud väärtust esitada.
    • AssessmentModel.assessmentHierarchyType = MAIN_ASSESSMENT
  • Ei ole kohustuslik. 

Hierarhilise hindamismudeli kaasatud rollide nimistu. Kasutatakse hierarhilise mudeli peamise hindamise juures.

Salvestamisel kirjutatakse alati array väärtus üle. Kui sisendis array null, siis ka array on null.

includedSubRoles.roleType1EHIS Classifier
  • Kaasatud roll peab olema seotud mudeli valdkonnaga.
    • Klassifikaatorid#KlassifikaatorASSESSMENT_ROLE, mille:
      • ROLE_SCOPE (klassifikaatori atribuut) = 360_ASSESSMENT_ROLE (klassifikaatori atribuudi väärtus)
      • Mudeli valdkonnaga seotud rollide kontroll:
        1. Süsteem käivitab päringu GET hsilm-gateway/v1/classifiers/ASSESSMENT_TYPE/links hindamise liikide klassifikaatori linkide otsimiseks.
        2. Süsteem otsib leitud linkide hulgast ülesse valitud hindamise valdkonna kõik hindamise liigid.
            • Süsteem otsib lingi objektide classifierItemCode1 väärtused, mille:
              • classifierLinkDefinitionCode = ASSESSMENT_TYPE_DOMAIN
              • classifierItemCode2 = AssessmentModel.domainType
        3. Süsteem otsib kõikide punktis 2 leitud hindamise liikide kaasatud rollid.
            • Süsteem otsib linkide objektide classifierItemCode2 väärtuseid, mille:
              • classifierLinkDefinitionCode = ASSESSMENT_TYPE_ASSESSMENT_ROLE
              • classifierItemCode1 = Punktis 2 leitud classifierItemCode1 väärtused
        4. Sisendis esitatud includedSubRoles.roleType väärtused peavad olema punktis 3 leitud classifierItemCode2 väärtuste hulgas. 

Kaasatud rolli EHIS klassifikaatori objekt. Väärtusena kasutatakse Klassifikaatorid#KlassifikaatorASSESSMENT_ROLE väärtust.

includedSubRoles.minimumRespondentsCount1Integer
  • Peab olema 0 suurem positiivne täisarv.

Defineerib palju peab olema antud rollis minimaalselt vastanuid, et hierarhilises hindamises saaks hinnatav enesehindamise etapi kinnitada.

includedSubRoles.questionnaireDeadlineDays1Integer
  • Peab olema 0 suurem positiivne täisarv.

Defineerib mitme päeva jooksul peab rollil küsimustik täidetud olema.

publishedToAllUsers0..1Boolean
  • Saab muuta, kui hindamismudel ei ole kehtetu (on Mustand, Kinnitatud või Kehtiv staatuses).
    • AssessmentModel.confirmed  = false või true.
      • Kui AssessmentModel.confirmed  = true, siis AssessmentModel.validFrom <= Päringu teostamise kuupäev.
  • Lubatud väärtused:
    • true
    • false
  • Kui määramata, siis vaikimisi false.
  • Peab olema null/false, kui ASSESSMENT_SCOPE = INSTITUTIONAL

Defineerib, kas hindamismudel on avaldatud kõikidele sisseloginud kasutajatele või mitte.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
GS: AssessmentModel: API: GET /quality-api/assessment-models/{id}#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 hindamismudeli andmed.
    • Süsteem otsib Objektid#AssessmentModel objekti:
      • id = Sisendis esitatud id väärtus.
      • objectStatus = CURRENT
        1. Kui hindamismudelit ei leitud, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem muudab leitud hindamismudeli andmeid. 
    • Süsteem uuendab Objektid#AssessmentModel objekti andmeid:
      • name = Sisendis esitatud name väärtus.
      • validFrom = Sisendis esitatud validFrom väärtus.
      • validUntil = Sisendis esitatud validUntil väärtus.
      • phaseTypes = Sisendis esitatud phaseTypes väärtused.
      • institutionTypes = Sisendis esitatud institutionTypes väärtused.
      • institutionTypes.specifications = Sisendis esitatud institutionTypes.specifications väärtused.
      • institutions.institutionIds = Sisendis esitatud institutions.institutionIds väärtused.
      • jobsites = Sisendis esitatud jobsites väärtused.
      • includedSubRoles = Sisendis esitatud includedSubRoles väärtused.
      • publishedToAllUsers = Sisendist publishedToAllUsers väärtus.
      • modifiedBy = Objekti muutja ID.
      • modifiedAt = Päringu teostamise aeg.
  5. Kui hindamismudeli etappide hulgast kustutati planeerimise etapp (AssessmentModel.phases), siis kustutab süsteem kõik planeerimise etapi tegevused ja planeerimise sektsioonid.
    1. Planeerimise sektsioonide kustutamine
      • Süsteem kustutab AssessmentModelPlanningSection objektid, mille assessmentModelId = sisendis esitatud id väärtus ja objectStatus = CURRENT, füüsiliselt andmebaasist.
            1. Kui kustutatud sektsioonidel on ka vormielemente, siis kustutab süsteem sektsiooni vormi elemendid füüsiliselt andmebaasist.
              • Süsteem kustutab Objektid#AssessmentModelPlanningSectionElement objektid, mille assessmentModelPlanningSectionId = kustutatud AssessmentModelPlanningSection.id väärtused ja objectStatus = CURRENT.
                1. Kui mõne kustutatud elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja selle elemendi sisendi formaat on pilt (inputType = IMAGE) ja elemendiga on seotud faile (AssessmentModelComponentElement.files != null), siis:
                  1. Süsteem kustutab faili metaandmestiku süsteemist.
                    • Süsteem kustutab Objektid#File objekte, mille id = AssessmentModelComponentElement.files.fileId ja objectStatus = CURRENT.
                  2. Süsteem kustutab kustutatud failide meteandmetega seotud failid failisüsteemist.
    2. Planeerimise tegevuste kustutamine
      • Süsteem kustutab AssessmentModelPlanningActivity objektid, mille assessmentModelId = sisendis esitatud id väärtus ja objectStatus = CURRENT, füüsiliselt andmebaasist.
        1. Kui hindamismudeli etappide hulgast kustutati mõni muu etapp (AssessmentModel.phaseTypes), siis eemaldatakse hindamismudeli planeerimise tegevuste hulgast ainult eemaldatud etappide tegevuste andmed.
          • Süsteem kustutab füüsiliselt andmebaasist AssessmentModelPlanningActivity objektid, mille assessmentModelId = sisendis esitatud id väärtus ja phaseType = eemaldatud AssessmentModel.phaseTypes väärtused ja objectStatus = CURRENT.
  6. Kui hindamismudeli etappide hulgast kustutati enesehindamise ja/või planeerimise etapp, siis kustutab süsteem etapiga seotud hindamise komponentide vormielemendid või eemaldab etapi andmed vormielemendilt.
    1. Süsteem eemaldab hindamise komponentide vormielementidelt kustutatud etapi andmed.
      • AssessmentModel.assessmentComponent.sections.section.elements.element.phaseTypes hulgast tuleb eemaldada kustutatud AssessmentModel.phaseTypes väärtused.
    2. Kui hindamise komponendi elemendil ei ole ühtegi etappi peale etapi eemaldamist, siis kustutab süsteem elemendi.
      • Süsteem kustutab andmebaasist füüsiliselt tingimustele vastava AssessmentModelComponentElement objekti.
        1. Kui mõne kustutatud elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja selle elemendi sisendi formaat on pilt (inputType = IMAGE) ja elemendiga on seotud faile (AssessmentModelComponentElement.files != null), siis:
          1. Süsteem kustutab faili metaandmestiku süsteemist.
            • Süsteem kustutab Objektid#File objekte, mille id = AssessmentModelComponentElement.files.fileId ja objectStatus = CURRENT.
          2. Süsteem kustutab kustutatud failide meteandmetega seotud failid failisüsteemist. 
  7. Kui hindamismudeli etappide hulka lisati mõni etapp, mida hindamismudelil eelnevalt ei olnud, siis lisab süsteem etapiga seotud teavituse algseadistuse.
      • Teavituse seadistus luuakse iga etapi kohta, mis lisati juurde ja millel on link EHISe klassifikaatoriga läbi klassifikaatori lingi definitsiooni (NSILM_MESSAGE_ACTION_ASSESSMENT_PHASE) klassifikaatoriga NSILM_MESSAGE_ACTION. Näiteks, kui sisendis on etapp SELF_ASSESSMENT, mida enne hindamismudelil ei olnud, siis see on lingitud teavituse seadistusega CONFIRM_SELF_ASSESSMENT. Sellisel juhul tuleb luua teavituse seadistus liigiga CONFIRM_SELF_ASSESSMENT. Esialgsed lingid on kirjeldatud Klassifikaatorid#KlassifikaatorNSILM_MESSAGE_ACTION tabelis.
      • Süsteem loob AssessmentModel.notificationSettings objektid:
        • id = UUID
        • messageActionType = Klassifikaatorid#KlassifikaatorNSILM_MESSAGE_ACTION, mille classifierLinkDefinitionCode = NSILM_MESSAGE_ACTION_ASSESSMENT_PHASE ja  classifierLink on assessmentType lisandunud väärtuste hulgas.
        • phaseType = NSILM_MESSAGE_ACTION klassifikaatori elemendiga lingitud phaseType väärtus.
        • addresseeGroupTypes = null
        • assessmentRoles = null
        • ehisPrivileges = null
        • adUserGroups = null
        • objectStatus = CURRENT
        • audit (loomine) = audit (loomine)
  8. Kui hindamismudeli etappide hulgast eemaldati mõni etapp, siis kustutab süsteem etapiga seotud teavituse algseadistuse.
    • Süsteem kustutab füüsiliselt andmebaasist assessmentModelNotificationSetting objektid, mille phaseType = Eemaldatud AssessmentModel.phaseTypes väärtused ja assessmentModelId = sisendis esitatud id väärtus.
  9. Süsteem tagastab muudetud hindamismudeli andmed.