NSILM

GS: AssessmentModel: API: POST /quality-api/assessment-models/{modelId}/assessment-component/sections

Muutja: Carolina Kask · 2024-04-09

Üldkirjeldus

Teenus salvestab hindamismudeli komponentide hulka sektsioonide andmed.

Seotud andmeobjektid:

NSIL-314 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

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

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
modelId1UUID
  • Hindamismudel ei tohi olla kustutatud.
    • AssessmentModel.objectStatus = CURRENT
  • Hindamismudeli äriline staatus peab olema "Mustand" või "Kinnitatud".
    • Mustand: AssessmentModel.isConfirmed = false
    • Kinnitatud: AssessmentModel.isConfirmed = true, validFrom > päringu teostamise aeg.
  • Hindamismudelile peab olema lisatud enesehindamise ja/või välishindamise etapp.
    • AssessmentModel.phases hulgas peab olema etapp "Enesehindamine" ja/või "Välishindamine".

Hindamismudeli id (UUID).

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

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

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

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

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

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

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

Hindamise komponendi sektsiooni nimetus.

helpText

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

Hindamise komponendi sektsiooni selgitus.

shortName

0..1String
  • Kuni 20 tähemärki.
  • Lubatud kasutada kui upperLevelSectionId = null. Muudel juhtudel ei ole lubatud väärtustada.

Hindamise komponendi sektsiooni lühinimetus.

Väljundid

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

Hindamise komponendi sektsiooni seadistuse objekti id (UUID).

assessmentModelId1UUID

Hindamismudeli id.

name1String

Hindamise komponendi sektsiooni nimetus.

helpText0..1String

Hindamise komponendi sektsiooni selgitus.

shortName0..1String

Hindamise komponendi sektsiooni lühinimetus.

objectStatus1String

Objekti staatus.

  • CURRENT - Kehtiv
  • DELETED - Kustutatud

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.
      • isConfirmed = false
        • Või isConfirmed = true ja validFrom > päringu teostamise aeg.
      • phases = "Enesehindamine" ja/või "Välishindamine"
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem lisab hindamise komponentide hulka uue sektsiooni andmed.
    • Süsteem loob Objektid#AssessmentModelComponentSection objekti:
      • id = UUID
      • assessmentModelId = Sisendis esitatud modelId väärtus.
      • name = Sisendis esitatud name väärtus.
      • helpText = Sisendis esitatud helpText väärtus.
      • shortName = Sisendis esitatud shortName väärtus.
      • objectStatus = CURRENT
      • audit (loomine) = audit (loomine)
  5. Süsteem lisab loodud sektsiooni hindamise 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.
    • Andmed salvestatakse Objektid#AssessmentModelComponentOrder objekti.
  6. Süsteem tagastab loodud andmed.