NSILM

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

Muutja: Andres Mill · 2024-04-18

Üldkirjeldus

Teenus muudab hindamismudeli komponentide sektsiooni andmeid.

Seotud andmeobjektid:


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" või "Kehtiv".
    • Mustand: AssessmentModel.isConfirmed = false
    • Kinnitatud: AssessmentModel.isConfirmed = true, validFrom > päringu teostamise aeg.
    • Kehtiv: AssessmentModel.isConfirmed = true, validFrom <= päringu teostamise aeg, validUntil > 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).

sectionId1UUID
  • Sektsioon ei tohi olla kustutatud.
    • AssessmentModel.assessmentComponent.sections.section = CURRENT

Hindamise komponendi sektsiooni seadistuse objekti id.

upperLevelSectionId0..1String
  • Kui määratud, siis ei tohi olla kustutatud.
    • AssessmentModelComponentSection.objectStatus = CURRENT, mille AssessmentModelComponentSection.id = upperLevelSectionId
  • Saab muuta kui mudeli staatus on "Mustand" või "Kinnitatud".

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.
  • Saab muuta kui mudeli staatus on "Mustand" või "Kinnitatud".

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.
  • Saab muuta kui mudeli staatus on "Mustand" või "Kinnitatud".

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

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

Hindamise komponendi sektsiooni nimetus.

helpText

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

Hindamise komponendi sektsiooni selgitus.

shortName

0..1String
  • Kuni 20 tähemärki.
  • Saab alati muuta.
  • 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
GS: AssessmentModel: API: POST /quality-api/assessment-models/{modelId}/assessment-component/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 sektsiooni andmed.
    • Süsteem otsib Objektid#AssessmentModelComponentSection objekti, mille:
      • AssessmentModelComponentSection.assessmentModelId = Sisendis esitatud modelId väärtus.
      • AssessmentModel.objectStatus = CURRENT
      • AssessmentModelComponentSection.id = Sisendis esitatud sectionId väärtus. 
      • AssessmentModelComponentSection.objectStatus = CURRENT 
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem muudab leitud sektsiooni andmeid.
    • Süsteem uuendab leitud Objektid#AssessmentModelComponentSection objekti andmeid:
      • name = Sisendis esitatud name väärtus.
      • helpText = Sisendis esitatud helpText väärtus.
      • shortName = Sisendis esitatud shortName väärtus.
      • audit (muutmine) = audit (muutmine)
  5. Süsteem uuendab muudetud sektsiooni hindamise komponentide järjestust.
    • 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#AssessmentModelComponentOrder objekti.
  6. Süsteem tagastab muudetud andmed.