NSILM

GS: AssessmentModel: API: PUT /quality-api/assessment-models/{assessmentModelId}/assessment-component/elements/{elementId}

Muutja: Andres Mill · 2025-10-13

Üldkirjeldus

Teenus muudab hindamismudeli komponentide vormielementide andmeid.

Seotud andmeobjektid:

NSIL-389 - Getting issue details... STATUS NSIL-605 - Getting issue details... STATUS NSIL-1286 - 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
assessmentModelId1UUID
  • 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).

elementId1UUID
  • Element ei tohi olla kustutatud.
    • AssessmentModelComponentElement.objectStatus = CURRENT

Elemendi id (UUID)

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:
      • AssessmentModelComponentElement.objectStatus = CURRENT, mille AssessmentModelComponentElement.id = previousComponent.id
  • Kohustuslik, kui previousComponent.type on määratud.
  • Peab olema vormielemendi ülemtaseme sektsiooni alakomponent.
  • Lubatud muuta kui hindamismudeli 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.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

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

contentType1EHIS Classifier
  • Peab olema CONTENT_TYPE hulgas kehtiv kirje.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Määrab elemendi tüübi.

label

1

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

1

Boolean
  • Lubatud alati muuta.
  • Lubatud väärtused: 
    • true
    • false

Määrab, kas vormielemendi silti kuvatakse hindamise vormil või mitte.

  • true (Vaikimisi) - Silti kuvatakse hindamise vormil
  • false - Silti ei kuvata hindamise vormil.
helpText

0..1

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

pbiMetadata

0..1

Object
  • Kohustuslik, kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja elemendi sisendi tüüp on PBI raport (inputType = REPORT). Muudel juhtudel ei tohi kasutada.
PBI aruande andmed. Kasutatakse kui elemendi sisendi tüüp on PBI aruanne (REPORT).

pbiMetadata.workspaceId

1

String
  • Peab olema 3 - 250 tähemärki.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud"
PBI aruande tööruumi identifikaator.

pbiMetadata.reportId

1

String
  • Peab olema 3 - 250 tähemärki.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud"
PBI aruande identifikaator.
phaseTypes

0..*

EHIS Classifier list
  • Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT). Muudel juhtudel ei tohi kasutada.
  • Peab olema ASSESSMENT_PHASE hulgas kehtiv kirje.
  • Etapp peab olema lisatud hindamismudelile (AssessmentModel.phaseTypes = phaseTypes).
  • Kohustuslik vähemalt üks etapp, kui elemendi tüüp on kasutaja sisend.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".
Nimekiri etappidest, kus elementi kasutatakse.
inputType

0..1

EHIS Classifier
  • Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT). Muudel juhtudel ei tohi kasutada.
  • Peab olema INPUT_TYPE hulgas kehtiv kirje, mille ADMIN_CONTEXT (attributeDefinitionCode) = ASSESSMENT (attributeDefinitionValue).
  • Kohustuslik, kui elemendi tüüp on kasutaja sisend.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".
  • inputType peab olema lubatud määratud contentType juures.
    • Kui contentType = USER_INPUT, siis klassifikaatori atribuut CONTENT_TYPE (attributeDefinitionCode) = USER_INPUT (attributeDefinitionValue).
    • Kui contentType = ADMIN_INPUT, siis klassifikaatori atribuut CONTENT_TYPE (attributeDefinitionCode) = ADMIN_INPUT (attributeDefinitionValue).

Vormielemendi sisendi formaat.

mandatory

0..1

Boolean
  • Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT). Muudel juhtudel ei tohi kasutada.
  • Kohustuslik, kui elemendi tüüp on kasutaja sisend.
  • Lubatud väärtused:
    • true
    • false
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".
Märge, mis näitab kas vormielemendi täitmine on kohustuslik või mitte.
synchronizedToDwh

0..1

Boolean
  • Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT). Muudel juhtudel ei tohi kasutada.
  • Kohustuslik, kui elemendi tüüp on kasutaja sisend.
  • Lubatud väärtused:
    • true
    • false
  • Vaikeväärtus, kui elemendi sisendi tüüp on PBI raport: false
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Määrab, kas andmed sünkroniseeritakse hindamise juurest andmelattu või mitte.

optionTexts

0..*Array
  • Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT) ja vormielemendi tüüp on MULTIPLE_CHOICE (Mitmikvalik) või SINGLE_CHOICE (üksikvalik). Muudel juhtudel ei tohi kasutada.
  • Nimekirjas peab olema vähemalt üks element.
  • Variandi tekst peab olema 3 - 250 tähemärki.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Vormielemendi vastusevariandid.

percentageTargetLevel

0..1Integer
  • Lubatud kasutada kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT) ja vormielemendi tüüp on osakaal (PERCENTAGE). Muudel juhtudel ei tohi kasutada.
  • Ei ole kohustuslik.
  • Lubatud väärtused 0 - 100.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Osakaalu sihttase.

scale

0..1Object
  • Kohustuslik kasutada, kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT) ja vormielemendi tüüp on skaala (SCALE). Muudel juhtudel ei tohi kasutada.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Skaala objekt Kasutatakse juhul kui sisendi formaat väärtuseks on "skaala" (SCALE).

scale.valuesFrom

1

Integer
  • Lubatud väärtused 0 - 10.
  • valuesFrom <= valuesUntil
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".
Skaala väärtuste algus. 
scale.valuesUntil

1

Integer
  • Lubatud väärtused 0 - 10.
  • valuesFrom <= valuesUntil
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".
Skaala väärtuste lõpp. 

scale.values

1..*Array
  • Kõik skaala väärtused peavad olema esitatud.
  • Skaala vahemiku algus ja lõpp on väärtuste hulka kaasaarvatud.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Skaala väärtuste selgitused.

scale.values.value

1Integer
  • scale.valuesFrom <= scale.values.value <= scale.valuesUntil
  • Kõik väärtused võivad olla esitatud ühe korra.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Skaala väärtus. Peab jääma ValuesFrom ja ValuesUntil vahele. Mõlemad on kaasaarvatud.

scale.values.valueText

0..1String
  • Lubatud kuni 250 tähemärki.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Skaala väärtuse selgitus.

hyperlinks

0..*Array
  • Lubatud kasutada kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on veebilehe link (inputType = HYPERLINK). Muudel juhtudel ei tohi kasutada.
  • Vähemalt üks veebilehe link peab olema lisatud, kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on veebilehe link (inputType = HYPERLINK).
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Nimekiri veebilehe linkidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on veebilehe link (inputType = HYPERLINK).

hyperlinks.name

1String
  • Peab olema 3-250 tähemärki pikk.

Lingi nimetus.

hyperlinks.url

1String
  • Peab vastama veebilehe lingi nõuetele.

Veebilehe link.

textAreaValue

0..1String
  • Lubatud kasutada kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on tekstiala (inputType = TEXT_AREA). Muudel juhtudel ei tohi kasutada.
  • Kohustuslik esitada kolm tähemärki, kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on tekstiala (inputType = TEXT_AREA).
  • Maksimaalne pikkus kuni 2500 tähemärki.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Elemendi väärtus, kui vormielement on tekstiala (TEXT_AREA). Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on tekstiala (inputType = TEXT_AREA).

files

0..*Array
  • Lubatud kasutada:
    • kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on pilt (inputType = IMAGE).
    • Või elemendi sisendi tüüp on fail (inputType = FILE)
    • Muudel juhtudel ei tohi kasutada.
  • Lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Nimekiri failidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on pilt või fail (inputType = IMAGE  või FILE).

files.fileId

1UUID
  • Kohustuslik esitada väärtus:
    • kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja vormielemendi sisendi tüüp on pilt (inputType = IMAGE).
    • Või elemendi sisendi tüüp on fail (inputType = FILE)
  • Elemendi faili objekt peab olemas olema (AssessmentModelComponentElement.files.id = Sisendis esitatud files.id).

Faili objekti id.

files.title

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

Failile lisatud pealkiri.

columns

0..*Object Array
  • Kohustuslik esitada vähemalt üks veeru objekt, kui elemendi tüüp on kasutaja sisend (contentType = USER_INPUT) ja vormielemendi tüüp on tabel (TABLE). Muudel juhtudel ei tohi kasutada.
  • Maksimaalselt tohib esitada kuni 7 veeru objekti.
  • Arrayd ja selle atribuute lubatud muuta kui hindamismudeli staatus on "Mustand" või "Kinnitatud".

Nimekiri tabeli komponentide veergudest. Igale veeru objektile määratakse nimetus ja kas on kohustuslik või mitte.

columns.title

1StringLubatud kuni 250 tähemärki.

Veeru pealkiri.

columns.mandatory

1Boolean
  • Lubatud väärtused:
    • true - veeru täitmine on hindamises kohustuslik.
    • false - veeru täitmine ei ole hindamises kohustuslik.

Määrab, kas veeru täitmine on kohustuslik või mitte.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
GS: AssessmentModel: API: POST /quality-api/assessment-models/{assessmentModelId}/assessment-component/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 komponendi elemendi andmed.
    • Süsteem otsib Objektid#AssessmentModelComponentElement objekti, mille:
      • id = Sisendis esitatud elementId väärtus
      • assessmentModelId = Sisendis esitatud assessmentModelId väärtus.
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem muudab hindamise komponenti elemendi andmeid.
    • Süsteem uuendab leitud Objektid#AssessmentModelComponentElement objekti andmeid:
      • contentType = Sisendis esitatud contentType väärtus.
      • label = Sisendis esitatud label väärtus.
      • labelDisplayedOnAssessment = Sisendis esitatud labelDisplayedOnAssessment väärtus.
      • helpText = Sisendis esitatud helpText väärtus.
      • pbi.workspaceId = Sisendis esitatud pbi.workspaceId väärtus.
      • pbi.reportId = Sisendis esitatud pbi.reportId väärtus.
      • phaseTypes 
        • Kui contentType = ADMIN_INPUT, siis phaseTypes = Enesehindamine.
        • Kui contentType != ADMIN_INPUT, siis phaseTypes = Sisendis esitatud phaseTypes väärtused. 
        • Kui inputType = REPORT (contentType = USER_INPUT või ADMIN_INPUT), siis phaseTypes = Enesehindamine.
      • inputType = Sisendis esitatud inputType väärtus.
      • mandatory = Sisendis esitatud mandatory väärtus.
      • synchronizedToDwh = Sisendis esitatud synchronizedToDwh väärtus.
      • optionTexts = Sisendis esitatud optionTexts väärtus.
      • percentageTargetLevel = Sisendis esitatud percentageTargetLevel väärtus.
      • scale.valuesFrom = Sisendis esitatud scale.valuesFrom väärtus.
      • scale.valuesUntil = Sisendis esitatud scale.valuesUntil väärtus.
      • scale.values = Sisendis esitatud scale.values väärtus.
      • scale.values.value = Sisendis esitatud scale.values.value väärtus.
      • scale.values.valueText = Sisendis esitatud scale.values.valueText väärtus.
      • textAreaValue = Sisendis esitatud textAreaValue väärtus.
      • hyperlinks = Sisendis esitatud hyperlinks väärtused.
      • files.title (, mille files.id = sisendis esitatud files.id väärtused) = Sisendis esitatud files.title väärtused.
      • columns = Sisendis esitatud columns väärtused.
      • audit (muutmine) = audit (muutmine)
  5. Kui elemendi tüüpi (contentType) või elemendi sisendi formaati muudeti (inputType) ja enne muudatust oli elemendi sisendi formaat oli pilt või fail (inputType = IMAGE või FILE) ja elemendiga oli seotud faile (AssessmentModelComponentElement.files != null), siis:
    1. Süsteem kustutab faili metaandmestiku süsteemist.
      • Süsteem kustutab Objektid#File objektid, mille id = AssessmentModelComponentElement.files.fileId ja objectStatus = CURRENT, füüsiliselt andmebaasist.
    2. Süsteem kustutab kustutatud failide meteandmetega seotud failid failisüsteemist.
    3. Süsteem kustutab elemendi viited failidele.
  6. Süsteem muudab muudetud elemendi hindamise komponentide järjekorda.
    • Kui previousComponent väärtus ei ole määratud, siis lisatakse vormielement elemendi tasemel hindamise komponentide järjekorras esimeseks.
    • Kui previousComponent väärtus on määratud, siis lisatakse loodud vormielement elemendi tasemel hindamise komponentide järjekorras määratud hindamise komponendi järele.
    • Andmed salvestatakse Objektid#AssessmentModelComponentOrder objekti.
  7. Süsteem tagastab muudetud andmed.