NSILM

GS: AssessmentInstruction: API: PUT /quality-api/assessment-models/{modelId}/assessment-instructions/{instructionId}/sections/{sectionId}

Muutja: Carolina Kask · 2025-09-15

Üldkirjeldus

Teenuse abil saab luua hindamise juhendi sektsioone.

Seotud andmeobjektid:

NSIL-1141 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kasutajal peab olema õigus hallata valdkonna hindamismudeleid (Vaata Sisendid → instructionId → Vaikeväärtus, valideerimine).

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
modelId1String
  • Hindamismudel ei tohi olla kustutatud.
    • AssessmentModel.objectStatus = CURRENT

Hindamismudeli id (UUID).

instructionId1String
  • Kasutajal peab olema valdkonna haldamise õigus.
    • Valdkonnal (AssessmentInstruction.domainType) on seos kehtiva privileegiga (attributeDefinitionCode = ASSESSMENT_MODEL_MANAGE_PRIVILEGE), mis on kasutajale määratud.
  • Juhend ei tohi olla kustutatud.
    • Eksisteerib AssessmentInstruction objekt, mille id = instructionId
Hindamise juhendi id.
sectionId1UUID
  • Sektsioon ei tohi olla kustutatud.
    • Eksisteerib AssessmentInstructionSection objekt, mille id = sectionId

Hindamise juhendi sektsiooni seadistuse objekti id.

upperLevelSectionId0..1String
  • Kui määratud, siis ei tohi olla kustutatud.
    • AssessmentInstructionSection.objectStatus = CURRENT, mille AssessmentInstructionSection.id = upperLevelSectionId

Hindamise juhendi sektsiooni seadistuse objekti ülemsektsiooni id. Saab olla ainult sektsiooni tüüpi juhendi komponent.

previousComponent.id0..1String
  • Kui määratud, siis sektsioon või vormielement ei tohi olla kustutatud.
    • Sektsioon:
      • AssessmentInstructionSection.objectStatus = CURRENT, mille AssessmentInstructionSection.id = previousComponent.id
    • Element:
      • AssessmentInstructionElement.objectStatus = CURRENT, mille AssessmentInstructionElement.id = previousComponent.id
  • Kohustuslik, kui previousComponent.type on määratud.

Hindamise juhendi sektsiooni seadistuse objektile eelneva juhendi komponendi (sektsiooni, vormielemendi) id.

previousComponent.type0..1
  • Lubatud väärtused:
    • SECTION
    • ELEMENT
  • Kohustuslik, kui previousComponent.id on määratud.

Hindamise juhendi sektsiooni seadistuse objektile eelneva hindamise juhendi (sektsiooni, vormielemendi) tüüp.

name1String
  • Peab olema 3 - 250 tähemärki.

Hindamise juhendi sektsiooni nimetus.

helpText

0..1String
  • Lubatud kuni 1000 tähemärki.

Hindamise juhendi sektsiooni selgitus.

shortName

0..1String
  • Kuni 20 tähemärki.

Hindamise juhendi sektsiooni lühinimetus.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
GS: AssessmentInstruction: API: POST /quality-api/assessment-models/{modelId}/assessment-instructions/{instructionId}/sections#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, mille:
      • id = Sisendis esitatud modelId väärtus.
      • objectStatus = CURRENT
        1. Kui objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem otsib juhendi andmed.
    • Süsteem otsib Objektid#AssessmentInstruction objekti, mille:
      • id = Sisendis esitatud instructionId väärtus.
      • domainType = AssessmentModel.domainType
      • assessmentType = AssessmentModel.assessmentType
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem otsib sektsiooni andmed.
    • Süsteem otsib Objektid#AssessmentInstructionSection objekti, mille:
      • id = Sisendis esitatud sectionId väärtus.
      • assessmentInstructionId = Sisendis esitatud instructionId väärtus.
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  6. Süsteem muudab leitud hindamise juhendi sektsiooni andmeid.
    • Süsteem muudab leitud Objektid#AssessmentInstructionSection objekti andmeid:
      • name = Sisendis esitatud name väärtus.
      • helpText = Sisendis esitatud helpText väärtus.
      • shortName = Sisendis esitatud shortName väärtus.
      • audit (muutmine) = audit (muutmine)
  7. Süsteem lisab loodud sektsiooni juhendi komponentide järjestuses õigesse asukohta.
    • Kui upperLevelSectionId väärtus ei ole määratud, siis on tegemist esimese taseme sektsiooniga.
    • Kui upperLevelSectionId väärtus on määratud, siis lisatakse loodud sektsioon upperLevelSectionId alasektsiooniks.
    • Kui previousComponent väärtus ei ole määratud, siis lisatakse sektsioon vastava taseme hindamise komponentide järjekorras esimeseks.
    • Kui previousComponent väärtus on määratud, siis lisatakse loodud sektsioon vastava taseme hindamise komponentide järjekorras määratud hindamise komponendi järele.
    • Kui muudetud sektsioonil on vormielemente või alasektsioone, siis muudetakse ka vormielementide alasektsioonide tasemeid vastavalt muudetud sektsioonile.
    • Andmed salvestatakse  Objektid#AssessmentInstructionComponentOrder objekti.
  8. Süsteem tagastab muudetud andmed.