NSILM

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

Muutja: Andres Mill · 2024-12-13

Üldkirjeldus

Teenuse abil saab muuta hindamismudeli hindamise tulemuste sektsioonide vormielementide andmed.

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 parendustegevuste kavandamise etapp.
    • AssessmentModel.phases hulgas peab olema etapp "Parandustegevuste kavandamine"

Hindamismudeli id (UUID).

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

Hindamise komponendi sektsiooni id (UUID).

elementId1UUID
  • Element ei tohi olla kustutatud.
    • AssessmentModel.result.sections.section.elements.element.objectStatus = CURRENT

Vormielemendi id (UUID).

label

1

String
  • 3 - 250 tähemärki.
  • Lubatud alati muuta.
Vormielemendi silt
helpText

0..1

String
  • Lubatud kuni 1000 tähemärki.
  • Lubatud alati muuta.
Vormielemendi selgitus/abitekst.
inputType

1

EHIS Classifier
  • Peab olema INPUT_TYPE hulgas kehtiv kirje, mille ADMIN_CONTEXT (attributeDefinitionCode) = NEEDS_FOR_IMPROVEMENT (attributeDefinitionValue).
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud" ja kui tegemist ei ole vaikimisi lisatud vormielemendiga (defaultElement = false). Muudel juhtudel ei ole lubatud muuta.

Vormielemendi sisendi formaat.

mandatory

1

Boolean
  • Lubatud väärtused:
    • true
    • false
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud" ja kui tegemist on kasutaja poolt lisatud elemendiga (defaultElement = false).
Märge, mis näitab kas vormielemendi täitmine on kohustuslik või mitte.
scale.valuesUntil

0..1

Integer
  • Lubatud kasutada ja kohustuslik kui vormielemendi tüüp on punktid (SCORE) ja hindamismudeli staatus on "Mustand" või "Kinnitatud". Muudel juhtudel ei tohi kasutada.
  • Lubatud väärtused 2 - 10.
Skaala väärtuste lõpp. 
ehisClassifierCode

0..1

String
  • Peab olema kehtiv EHIS klassifikaatori definitsiooni kood.
  • Lubatud kasutada ja kohustuslik kui vormielemendi tüüp on klassifikaator (CLASSIFIER) ja hindamismudeli staatus on "Mustand" või "Kinnitatud". Muudel juhtudel ei tohi kasutada.
EHISe klassifikaatori definitsiooni kood.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
GS: AssessmentModel: API: POST /quality-api/assessment-models/{modelId}/result/sections/{sectionId}/elements#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 hindamise tulemuste sektsiooni vormielemendi andmed.
    • Süsteem otsib Objektid#AssessmentModel.result.sections.section.elements.element objekti, mille:
      • AssessmentModel.id = Sisendis esitatud modelId väärtus.
      • AssessmentModel.phases = Parandustegevuste kavandamine
      • AssessmentModel.objectStatus = CURRENT
      • AssessmentModel.result.sections.section.id = Sisendis esitatud sectionId väärtus.
      • AssessmentModel.result.sections.section.objectStatus = CURRENT
      • AssessmentModel.result.sections.section.elements.element.id = Sisendis esitatud elementId väärtus.
      • AssessmentModel.result.sections.section.elements.element.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 hindamisetulemuste sektsiooni elemendi andmed.
    • Süsteem muudab leitud Objektid#AssessmentModel.result.sections.section.elements.element objekti andmeid:
      • label = Sisendis esitatud label väärtus.
      • helpText = Sisendis esitatud helpText väärtus.
      • inputType = Sisendis esitatud inputType väärtus.
      • mandatory = Sisendis esitatud mandatory väärtus.
      • scale.valuesFrom = 
        • Kui inputType = SCORE, siis scale.valuesFrom = 1.
        • Kui inputType != SCORE, siis scale.valuesFrom = null.
      • scale.valuesUntil = Sisendis esitatud scale.valuesUntil väärtus.
      • ehisClassifierCode = Sisendis esitatud ehisClassifierCode väärtus.
      • audit (muutmine) = audit (muutmine)
  5. Süsteem tagastab muudetud andmed.