Üldkirjeldus

Teenus võimaldab otsida hindamisega seotud planeerimise etapi sektsioonide elemente.

Seotud andmeobjektid:

NSIL-136 - Getting issue details... STATUS NSIL-638 - Getting issue details... STATUS NSIL-810 - Getting issue details... STATUS NSIL-833 - Getting issue details... STATUS NSIL-1100 - Getting issue details... STATUS NSIL-1290 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kui tegemist on asutusepõhise hindamisega (assessmentScope = INSTITUTIONAL):
- Kasutajal peab olema hindamise valdkonnaga seotud hindamise andmete muutmise õigus hindamisega seotud asutuse juures.
  - Classifier.classifierItemCode = Assessment.domain
  - Classifier.classifierAttributeDefinitionCode = ASSESSMENT_MANAGE_PRIVILEGE
  - Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
  - Assessment.institution.id = Kasutaja poolt valitud rolliga seotud asutus.
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.presonalCode = Päringu käivitanud isiku isikukood.
Kui kasutaja on hindamise meeskonna liige (Kehtib asutusepõhistel ja isikupõhistel hindamistel).
- Kasutajal peab olema hindamise valdkonnaga seotud hindamise 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_MANAGE_PRIVILEGE
  - Classifier.attributeValue = Kasutaja poolt valitud rolli privileegide hulgas olev privileeg.
Kui tegemist on isikupõhise hierarhilise hindamise alamhindamisega (assessmentHierarchyType = SUB_ASSESSMENT), siis objekti andmeid hallata ei saa.

Sisendid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Vaikeväärtus, valideerimine	Kirjeldus, täiendav info
assessmentId	1	String	Hindamine ei tohi olla kustutatud. Assesment.id = assessmentId Hindamine ei tohi olla lõpetatud. Assesment.endDate > Päringu teostamise aeg või Assesment.endDate = null.	Hindamise id.
sectionId	1	String	Sektsioon ei tohi olla kustutatud. AssessmentPlanningSection.id = sectionId	Sektsiooni id.
elementId	1	String	Element ei tohi olla kustutatud. AssessmentPlanningSectionElement.id =elementId Elemendi tüüp peab olema kasutaja sisend. AssessmentPlanningSectionElement.contentType = USER_INPUT	Elemendi id.
textAreaValue	0..1	String	Saab muuta, kui elemendi tüüp on tekstiala. AssessmentPlanningSectionElement.inputType = TEXT_AREA Ei ole kohustuslik, kui elemendi tüüp on tekstiala. Lubatud kuni 4500 tähtmärki.	Elemendi väärtus, kui vormielement on tekstiala (TEXT_AREA).
options.option.id	0..*	UUID	Saab muuta, kui elemendi tüüp on mitmikvalik. AssessmentPlanningSectionElement.inputType = MULTIPLE_CHOICE või SINGLE_CHOICE Kohustuslik, kui elemendi tüüp on mitmikvalik või üksikvalik. Päringus tuleb esitada kõik elemendiga seotud valikute id väärtused.	Vastusevariandi id (UUID). Kasutatakse mitmikvaliku (MULTIPLE_CHOICE) ja üksikvaliku (SINGLE_CHOICE) korral.
options.option.selected	0..*	Boolean	Saab muuta, kui elemendi tüüp on mitmikvalik või üksikvalik. AssessmentPlanningSectionElement.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. AssessmentPlanningSectionElement.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. AssessmentPlanningSectionElement.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. AssessmentPlanningSectionElement.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	0..1	String	Peab olema 3-250 tähemärki pikk.	Lingi nimetus.
hyperlinks.url	0..1	String	Peab vastama veebilehe lingi nõuetele.
scale.values.id	0..*	UUID	Saab muuta, kui elemendi tüüp on skaala. AssessmentPlanningSectionElement.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. AssessmentPlanningSectionElement.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.
numberValue	0..1	Double	Saab muuta, kui elemendi tüüp on arv. AssessmentPlanningSectionElement.inputType = NUMBER Ei ole kohustuslik, kui elemendi tüüp on arv.	Elemendi väärtus, kui vormielement on arv (NUMBER).
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.
cells	0..*	Object Array	Saab muuta, kui elemendi tüüp on tabel. AssessmentPlanningSectionElement.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 AssessmentPlanningSectionElement.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	Vormi sektsiooni lisatud vormielemendi id (UUID) hindamise juures.
label	1	String	Vormielemendi silt
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.
contentType	1	EHIS Classifier	Määrab elemendi tüübi. Väärtusena klassifikaatori CONTENT_TYPE elemendi viide.
inputType	1	EHIS Classifier	Vormielemendi sisendi formaat Väärtusena klassifikaatori INPUT_TYPE elemendi viide.
mandatory	1	Boolean	Märge, mis näitab kas vormielemendi täitmine on kohustuslik või mitte.
seqNo	1	Integer	Vormi sektsiooni elemendi järjekorranumber.
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.
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.
numberValue	0..1	Double	Elemendi väärtus, kui vormielement on arv (NUMBER).
percentage	0..1	Object	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	0..*	Array	Nimekiri veebilehe linkidest. Kasutatakse kui sisendi formaadi väärtuseks on veebilehe link (HYPERLINK).
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.
files.fileId	1	FK	Viide faili metaandmetele. Viitab File.id väärtusele.
files.title	0..1	String	Failile lisatud pealkiri.
files.fileModifiedAt	0..1	Date and time	Faili viimane muutmise aeg.
files.templateFile	1	Boolean	Määrab, kas tegemist on näidisega.
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 planeerimise vormi sektsiooni elemendi andmed.
- Süsteem otsib Objektid#AssessmentPlanningSectionElement objekti, mille
  - id = Sisendis elementId väärtus.
  - assessmentId = Sisendis esitatud assessmentId väärtus.
  - sectionId = Sisendis esitatud sectionId väärtus
  - contentType = USER_INPUT
  - 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#AssessmentPlanningSectionElement 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äärtused.
  - 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.
  - table.cells = Sisendis esitatud cells väärtused.
  - audit (muutmine) = audit (muutmine)
Süsteem tagastab muudetud andmed.

GS: Assessment: API: PUT /quality-api/assessments/{assessmentId}/planning/sections/{sectionId}/elements/{elementId}

Üldkirjeldus

Eeltingimused ja kasutusõigused

Sisendid

Väljundid

Tegevused