Üldkirjeldus

Teenus võimaldab muuta hindamisega seotud hindamise vormielementide andmeid.

Seotud andmeobjektid:

NSIL-359 - Getting issue details... STATUS NSIL-613 - Getting issue details... STATUS NSIL-810 - Getting issue details... STATUS NSIL-835 - Getting issue details... STATUS NSIL-1099 - Getting issue details... STATUS NSIL-1177 - Getting issue details... STATUS NSIL-1291 - Getting issue details... STATUS NSIL-1347 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kui tegemist on asutusepõhise hindamisega (assessmentScope = INSTITUTIONAL):
- Kasutajal peab olema hindamise valdkonnaga seotud enesehindamise andmete muutmise õigus hindamisega seotud asutuse juures.
  - Classifier.classifierItemCode = Assessment.domain
  - Classifier.classifierAttributeDefinitionCode = ASSESSMENT_SELF_ASSESSMENT_MANAGE_PRIVILEGE
  - Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
  - Assessment.institution.id = Kasutaja poolt valitud rolliga seotud asutus.
  - Assessment.phases.phase.phaseType = SELF_ASSESSMENT
- VÕI kasutajal peab olema hindamise valdkonnaga seotud välishindamise andmete muutmise õigus hindamisega seotud asutuse juures.
  - Classifier.classifierItemCode = Assessment.domain
  - Classifier.classifierAttributeDefinitionCode = ASSESSMENT_EXTERNAL_ASSESSMENT_MANAGE_PRIVILEGE
  - Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
  - Assessment.institution.id = Kasutaja poolt valitud rolliga seotud asutus.
  - Assessment.phases.phase.phaseType = EXTERNAL_ASSESSMENT
Kui tegemist on isikupõhise hindamisega (assessmentScope = INDIVIDUAL) ja mittehierarhilise hindamisega või hierarhilise hindamise peamise hindamisega (assessmentHierarchyType = null või MAIN_ASSESSMENT (!= SUB_ASSESSMENT)):
- Päringu käivitanud kasutaja on isik, kelle suhtes hindamist läbi viiakse.
  - Assessment.personalCode = Päringu käivitanud isiku isikukood.
Kui tegemist on isikupõhise hindamisega (assessmentScope = INDIVIDUAL) ja hierarhilise hindamise alamhindamisega (assessmentHierarchyType = SUB_ASSESSMENT):
- Päringu käivitanud kasutaja on isik, kelle on hindamine suunatud.
  - Assessment.personalCode = Päringu käivitanud isiku isikukood.
- Hindamine ei tohi olla lõpetatud.
  - Assessment.endDate = null
- Hindamine ei tohi olla arhiveeritud.
  - Assessment.archivedAt = null
Kui kasutaja on hindamise meeskonna liige (Kehtib asutusepõhistel ja isikupõhistel hindamistel).
- Kasutajal peab olema hindamise valdkonnaga seotud enesehindamise andmete muutmise õigus töödeldava hindamisega seoses ja kasutaja peab olema seotud hindamisega.
  - AssessmentTeamMember.personalCode = Päringu käivitanud isiku isikukood.
  - AssessmentTeamMember.objectStatus = CURRENT
  - Classifier.classifierItemCode = Assessment.domain
  - Classifier.classifierAttributeDefinitionCode = ASSESSMENT_SELF_ASSESSMENT_MANAGE_PRIVILEGE
  - Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
  - Assessment.phases.phase.phaseType = SELF_ASSESSMENT
- VÕI kasutajal peab olema hindamise valdkonnaga seotud välishindamise andmete muutmise õigus töödeldava hindamisega seoses ja kasutaja peab olema seotud hindamisega.
  - AssessmentTeamMember.personalCode = Päringu käivitanud isiku isikukood.
  - AssessmentTeamMember.objectStatus = CURRENT
  - Classifier.classifierItemCode = Assessment.domain
  - Classifier.classifierAttributeDefinitionCode = ASSESSMENT_EXTERNAL_ASSESSMENT_MANAGE_PRIVILEGE
  - Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
  - Assessment.phases.phase.phaseType = EXTERNAL_ASSESSMENT

Sisendid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Vaikeväärtus, valideerimine	Kirjeldus, täiendav info
assessmentId	1	String	Hindamine ei tohi olla kustutatud. Assessment.objectStatus = CURRENT Hindamine ei tohi olla lõpetatud. Assessment.endDate > Päringu teostamise aeg või Assessment.endDate = null. Enesehindamise elementide muutmine Enesehindamise elemente saab muuta, kui enesehindamine on kinnitamata ja kasutajal on enesehindamise muutmise õigus. Välishindamise elementide muutmine Välishindamise elemente saab muuta, kui enesehindamine on kinnitatud ja välishindamine ei ole kinnitatud ja kasutajal on enesehindamise muutmise õigus.	Hindamise id.
elementId	1	String	Element ei tohi olla kustutatud. AssessmentComponentElement.objectStatus = CURRENT Elemendi tüüp peab olema kasutaja sisend. AssessmentComponentElement.contentType = USER_INPUT	Elemendi id.
textAreaValue	0..1	String	Saab muuta, kui elemendi tüüp on tekstiala. AssessmentComponentElement.inputType = TEXT_AREA Ei ole kohustuslik, kui elemendi tüüp on tekstiala. Lubatud kuni 4500 tähemärki.	Elemendi väärtus, kui vormielement on tekstiala (TEXT_AREA).
numberValue	0..1	Double	Saab muuta, kui elemendi tüüp on arv. AssessmentComponentElement.inputType = NUMBER Ei ole kohustuslik, kui elemendi tüüp on arv.	Elemendi väärtus, kui vormielement on arv (NUMBER).
options.option.selected	0..*	Boolean	Saab muuta, kui elemendi tüüp on mitmikvalik või üksikvalik. AssessmentComponentElement.inputType = MULTIPLE_CHOICE või SINGLE_CHOICE Kohustuslik, kui elemendi tüüp on mitmikvalik või üksikvalik. Lubatud väärtused: true false Kui tegemist on üksikvalikuga, siis saab ainult ühe valiku väärtus olla true. Ülejäänud väärtused peavad olema false. Kõik saavad false ka olla.	Määrab, kas variant on valitud või mitte. Kasutatakse mitmikvaliku (MULTIPLE_CHOICE) ja üksikvaliku (SINGLE_CHOICE) korral.
percentage.partValue	0..1	Integer	Saab muuta, kui elemendi tüüp on osakaal. AssessmentComponentElement.inputType = PERCENTAGE Ei ole kohustuslik, kui elemendi tüüp on osakaal.	Osa väärtus. Kasutatakse kui sisendi formaat väärtuseks on "osakaal" (PERCENTAGE).
percentage.wholeValue	0..1	Integer	Saab muuta, kui elemendi tüüp on osakaal. AssessmentComponentElement.inputType = PERCENTAGE Ei ole kohustuslik, kui elemendi tüüp on osakaal.	Tervik väärtus. Kasutatakse kui sisendi formaat väärtuseks on "osakaal" (PERCENTAGE).
hyperlinks	0..*	Array	Saab muuta, kui elemendi tüüp on veebilehe link. AssessmentComponentElement.inputType = HYPERLINK Ei ole kohustuslik, kui elemendi tüüp on veebilehe link. Kui ühtegi linki ei ole sisendis esitatud, siis eemaldatakse andmebaasist salvestatud veebilingid.	Nimekiri veebilehe linkidest. Kasutatakse kui sisendi formaadi väärtuseks on veebilehe link (HYPERLINK).
hyperlinks.name	1	String	Peab olema 3-250 tähemärki pikk.	Lingi nimetus.
hyperlinks.url	1	String	Peab vastama veebilehe lingi nõuetele.	Veebilehe link.
scale.values.id	0..*	UUID	Saab muuta, kui elemendi tüüp on skaala. AssessmentComponentElement.inputType = SCALE Kohustuslik, kui elemendi tüüp on skaala. Päringus tuleb esitada kõik elemendiga seotud skaala id väärtused.	Skaala väärtuse id.
scale.values.selected	0..*	Boolean	Saab muuta, kui elemendi tüüp on skaala. AssessmentComponentElement.inputType = SCALE Kohustuslik, kui elemendi tüüp on skaala. Lubatud väärtused: true false Ainult ühe elemendi väärtus saab olla true. Ülejäänud väärtused peavad olema false.	Määrab, kas skaala variant on valitud või mitte. true - valitud false - valimata.
files.fileId	1	UUID	Kohustuslik esitada väärtus, kui vormielemendi sisendi tüüp on pilt või fail (inputType = IMAGE või FILE). Elemendi faili objekt peab olemas olema (AsessmentComponentElement.files.id = Sisendis esitatud files.id).	Faili objekti id.
files.title	0..1	String	Lubatud kuni 250 tähemärki.	Failile lisatud pealkiri.
reports	0..1	Array	Võib esitada kui elemendi tüüp on PBI aruanne AssessmentComponentElement.inputType = REPORT Kui ühtegi reports väärtust ei ole sisendis esitatud, siis eemaldatakse andmebaasist salvestatud näitajad.	Nimekiri juhtimislaua aruannetest.
reports.reportTitle	1	String	Kohustuslik esitada 3-250 tähemärki.	Näitaja pealkiri.
reports.reportDescription	0..1	String	Lubatud kuni 2500 tähemärki. Ei ole kohustuslik.	Näitaja kirjeldus.
reports.selectedReports	1..*	Array	Võib sisestada mitme aruande andmed. Kohustuslik sisestada vähemalt 1 aruande andmed. Kui ühtegi selectedReports väärtust ei ole sisendis esitatud, siis eemaldatakse andmebaasist salvestatud andmed.	PBI aruande andmed. Kasutatakse kui elemendi tüüp on PBI aruanne (REPORT) ja kasutaja sisend (USER_INPUT).
reports.selectedReports.workspaceId	1	String	Kohustuslik 3-250 tähemärki.	PBI aruande tööruumi identifikaator.
reports.selectedReports.reportId	1	String	Kohustuslik 3-250 tähemärki.	PBI aruande identifikaator.
reports.selectedReports.bookmark	0..1	String	PBI aruande filtrite snapshot (bookmark) vastavalt kasutaja tehtud valikutele. Sisu maksimaalne pikkus: 4000 tähemärki Sisu eeldatav formaat: base64	Aruandele rakendatud filtrite snapshot (base64 formaadis).
reports.selectedReports.dashboardId	0..1	String		Juhtimislaua id, millel aruanne lisati.
reports.selectedReports.elementId	0..1	String		Elemendi id, mis aruandele lisati.
reports.selectedReports.pbiFilters	1	String		PBI filter json kujul.
reports.selectedReports.pageName	1	String		PBI raporti sektsiooni tunnus.
cells	0..*	Object Array	Saab muuta, kui elemendi tüüp on tabel. AssessmentComponentElement.inputType = TABLE	Tabeli lahtrite väärtused ja nende asukoht tabelis. lahtri asukoha määravad lahtri ja veeru võtmed/aadressid.
cells.rowKey	1	Number	Sama rowKey ja columnKey kombinatsiooni tohib sisendis esitada ühe korra. Esitatud columnKey peab olema AssessmentComponentElement.table.columns.key hulgas.	Rea võti (rea järjekorranumber tabelis).
cells.columnKey	1	Number		Veeru võti (veeru järjekorranumber tabelis).
cells.value	0..1	String	Lubatud kuni 2500 tähemärki.	Lahtri väärtus.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
id	1	UUID	Hindamise komponendi vormi sektsiooni lisatud vormielemendi id (UUID).
definitionId	1	UUID	Vormielemendi id (UUID) hindamismudeli juures. Viitab AssessmentModelComponentElement.id väärtusele.
assessmentId	1	UUID	Viide hindamismudelile, millega hindamise komponendi vormielemendi seadistus on seotud. Viitab Assessment.id väärtusele.
contentType	1	EHIS Classifier	Määrab elemendi tüübi. Väärtusena klassifikaatori CONTENT_TYPE elemendi viide.
label	0..1	String	Vormielemendi silt. Kui silti on lubatud kasutajale kuvada, siis tagastatakse vastuses sildi väärtus. Kui labelDisplayedOnAssessment = true, siis label = label. Kui silti ei ole lubatud kasutajale kuvada, siis kuvatakse kasutajale tühi vastus. Kui labelDisplayedOnAssessment = false, siis label = null.
labelDisplayedOnAssessment	1	Boolean	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	Vormielemendi selgitus/abitekst.
reports	0..1	Array	Nimekiri juhtimislaua aruannetest.
reports.reportTitle	0..1	String	Näitaja pealkiri.
reports.reportDescription	0..1	String	Näitaja kirjeldus.
reports.selectedReports	0..*	Object	PBI aruande andmed. Kasutatakse kui elemendi tüüp on PBI aruanne (REPORT) ja kasutaja sisend (USER_INPUT).
reports.selectedReports.workspaceId	1	String	PBI aruande tööruumi identifikaator.
reports.selectedReports.reportId	1	String	PBI aruande identifikaator.
reports.selectedReports.bookmark	0..1	String	Aruandele rakendatud filtrite snapshot (base64 formaadis).
reports.selectedReports.dashboardId	0..1	String	Juhtimislaua id, millel aruanne lisati.
reports.selectedReports.elementId	0..1	String	Elemendi id, mis aruandele lisati.
reports.selectedReports.pbiFilters	1	String	PBI filter json kujul.
reports.selectedReports.pageName	1	String	PBI raporti sektsiooni tunnus.
pbiMetadata	0..1	Object	PBI aruande andmed. Kasutatakse kui elemendi tüüp on PBI aruanne (REPORT) ja mudeli haldaja sisend (ADMIN_INPUT).
pbiMetadata.workspaceId	1	String	PBI aruande tööruumi identifikaator.
pbiMetadata.reportId	1	String	PBI aruande identifikaator.
phaseType	0..1	EHIS Classifier	Etapp, kus elementi kasutatakse. Väärtusena klassifikaatori ASSESSMENT_PHASE elemendi viide.
inputType	0..1	EHIS Classifier	Vormielemendi sisendi formaat Väärtusena klassifikaatori INPUT_TYPE elemendi viide. Kohustuslik kui elemendi tüüp on kasutaja sisend (USER_INPUT).
mandatory	0..1	Boolean	Märge, mis näitab kas vormielemendi täitmine on kohustuslik või mitte.
synchronizedToDwh	1	Boolean	Määrab, kas andmed sünkroniseeritakse hindamise juurest andmelattu või mitte. true - andmed sünkroniseeritakse andmelattu. false - andmeid ei sünkroniseerita andmelattu.
textAreaValue	0..1	String	Elemendi väärtus, kui vormielement on tekstiala (TEXT_AREA).
options	0..*	Array	Vormielemendi vastusevariandid. Kasutatakse kui vormielemendi tüüp on MULTIPLE_CHOICE (Mitmikvalik) või SINGLE_CHOICE (üksikvalik).
options.option	1	Object	Vastusevariandi objekt.
options.option.id	1	UUID	Vastusevariandi id (UUID).
options.option.seqNo	1	Integer	Valiku järjekorranumber vormil.
options.option.text	1	String	Vastusevariandi tekst.
options.option.selected	1	Boolean	Määrab, kas variant on valitud või mitte. true - valitud false - valimata.
objectStatus	1	String	Objekti staatus. CURRENT - Kehtiv DELETED - Kustutatud
numberValue	0..1	Double	Elemendi väärtus, kui vormielement on arv (NUMBER).
percentage	0..1		Osakaalu objekt. Kasutatakse juhul kui sisendi formaat väärtuseks on "osakaal" (PERCENTAGE).
percentage.targetLevel	1	Integer	Osakaalu sihttase.
percentage.partValue	1	Integer	Osa väärtus.
percentage.wholeValue	1	Integer	Tervik väärtus.
hyperlinks.name	1	String	Lingi nimetus.
hyperlinks.url	1	String	Veebilehe link.
scale	0..1	Object	Skaala objekt Kasutatakse juhul kui sisendi formaat väärtuseks on "skaala" (SCALE).
scale.values	0..*	Array	Skaala väärtused.
scale.values.id	1	UUID	Skaala väärtuse id.
scale.values.value	1	Integer	Skaala väärtus. Peab jääma ValuesFrom ja ValuesUntil vahele. Mõlemad on kaasaarvatud.
scale.values.valueText	0..1	String	Skaala väärtuse selgitus.
scale.values.selected	1	Boolean	Määrab, kas variant on valitud või mitte. true - valitud false - valimata.
files	0..*	Array	Nimekiri failidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on pilt (inputType = IMAGE).
file.id	1	UUID	Faili objekti id.
files.fileId	1	FK	Viide faili metaandmetele. Viitab File.id väärtusele.
files.title	0..1	String	Failile lisatud pealkiri.
files.fileName	1	String	Faili nimetus koos faililaiendiga. Näiteks "minu pilt.png".
files.mimeType	1	String	Faili mime tüüp. Näiteks "image/x-png".
files.size	1	Integer	Faili suurus baitides.
files.fileModifiedAt	0..1	Date and time	Faili viimane muutmise aeg.
files.templateFile	1	Boolean	Määrab, kas tegemist on näidisega.
source	1	Enum	Elemendi allikas. Võimalikud väärtused: ASSESSMENT_MODEL Assessment
table	0..1	Object	Tabeli element, mis sisaldab veergude definitsioone ja ridade väärtusi. Kasutatakse, kui elemendi tüüp on tabel (TABLE).
table.columns	1..*	Object array	Nimekiri tabeli komponentide veergudest. Igale veeru objektile määratakse nimetus ja kas on kohustuslik või mitte.
table.columns.key	1	Number	Veeru võti (järjekorranumber tabelis).
table.columns.title	1	String	Veeru pealkiri.
table.columns.mandatory	1	Boolean	Määrab, kas veeru täitmine on kohustuslik või mitte.
table.cells	0..*	Object Array	Tabeli lahtrite väärtused ja nende asukoht tabelis. lahtri asukoha määravad lahtri ja veeru võtmed/aadressid.
table.cells.rowKey	1	Number	Rea võti (rea järjekorranumber tabelis).
table.cells.columnKey	1	Number	Veeru võti (veeru järjekorranumber tabelis).
table.cells.value	0..1	String	Lahtri väärtus.
objectStatus	1	String	Objekti staatus. CURRENT - Kehtiv DELETED - Kustutatud

Tegevused

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.
Süsteem kontrollib, kas andmed vastavad nõuetele.
1. Kui andmed ei vasta nõuetele, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem otsib päringus esitatud tingimustele vastavad hindamise hindamise vormi sektsiooni elemendi andmed.
- Süsteem otsib Objektid#AssessmentComponentElement objekti, mille
  - id = Sisendis esitatud elementId väärtus.
  - assessmentId = Sisendis esitatud assessmentId väärtus.
  - objectStatus = CURRENT
    1. Kui tingimustele vastavalt objekti ei leitud, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem muudab elemendi andmeid.
- Süsteem uuendab leitud Objektid#AssessmentComponentElement objekti andmeid:
  - textAreaValue = Sisendis esitatud textAreaValue väärtus.
  - options.option.selected = Sisendis esitatud options.option.selected väärtused.
  - numberValue = Sisendis esitatud numberValue väärtus.
  - percentage.partValue = Sisendis esitatud percentage.partValue väärtus.
  - percentage.wholeValue = Sisendis esitatud percentage.wholeValue väärtus.
  - hyperlinks = Sisendis esitatud hyperlinks väärtus.
  - scale.values.selected = Sisendis esitatud scale.values.selected väärtused.
  - files.title (, mille files.id = sisendis esitatud files.id väärtused) = Sisendis esitatud files.title väärtused.
  - reports = Sisendis esitatud reports väärtus.
  - cells = Sisendis esitatud cells väärtused.
  - audit (muutmine) = audit (muutmine)
Kui kasutaja muutis vormielementi, mille tüüp on PBI aruanne, siis loob süsteem PBI aruandest pildi, et seda hiljem hindamise pdf kokkuvõttel kasutada.
1. Süsteem genereerib PBI aruandest pildid.
  1. Rakendatakse filtreid:
    - Kui Assessment.institution.type = LOCAL_GOVERNMENT, siis kasutatakse PBI päringus vaikimisi filtrit DimPidaja/Pidaja_Regkood = Assessment.institution.regCode
    - Kui Assessment.institution.type = EDUCATIONAL_INSTITUTION, siis kasutatakse PBI päringus vaikimisi filtrit DimPidaja/Pidaja_Regkood = Assessment.institution.regCode
2. Süsteem salvestab loodud pildi failihoidlasse.
3. Süsteem salvestab faili objekti.
4. Süsteem loob seose faili objekti ja vormielemendi vahel.
  - Süsteem lisab leitud Objektid#AssessmentComponentElement objektil files arraysse seose faili objektiga.
5. Süsteem kustutab kõik leitud PBI aruannete piltide eelmised versioonid failihoidlast, file objektist ja files arrayst, ja asendab loodud piltidega.
Süsteem tagastab muudetud andmed.

GS: Assessment: API: PUT /quality-api/assessments/{assessmentId}/assessment-component/elements/{elementId}

Üldkirjeldus

Eeltingimused ja kasutusõigused

Sisendid

Väljundid

Tegevused