Üldkirjeldus

Teenus muudab hindamismudeli planeerimise etapi sektsiooni vormi elemendi andmeid.

Seotud andmeobjektid:

NSIL-100 - Getting issue details... STATUS NSIL-1284 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kasutajal peab olema privileeg NSILM_ASSESSMENT_MODEL_MANAGE

Sisendid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Vaikeväärtus, valideerimine	Kirjeldus, täiendav info
modelId	1	UUID	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: isConfirmed = true, validFrom <= päringu teostamise aeg, validUntil > päringu teostamise aeg. Hindamismudelile peab olema lisatud planeerimise etapp. AssessmentModel.phases hulgas peab olema etapp "Planeerimine" Kasutajal peab olema hindamismudeliga seotud valdkonna haldamise õigus. AssessmentModel.domain = Valdkonnal (Klassifikaatorid#KlassifikaatorDOMAIN) on seos kehtiva privileegiga (attributeDefinitionCode = PRIVILEGE), mis on kasutajal.	Hindamismudeli id (UUID).
sectionId	1		Sektsioon ei tohi olla kustutatud. AssessmentModel.planning.sections.section.objectStatus = CURRENT	Hindamismudeli paneerimise etapi sektsiooni id (UUID).
elementId	1	UUID	Element ei tohi olla kustutatud. AssessmentModelPlanningSectionElement.objectStatus = CURRENT	Hindamismudeli vormi sektsiooni lisatud vormielemendi id (UUID).
contentType	1	EHIS 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	Peab olema 3 - 250 tähemärki.	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.	Vormielemendi selgitus/abitekst.
inputType	1	EHIS Classifier	Peab olema Klassifikaatorid#KlassifikaatorINPUT_TYPE hulgas kehtiv kirje, mille ADMIN_CONTEXT (attributeDefinitionCode) = PLANNING (attributeDefinitionValue). 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). Saab muuta, kui hindamismudeli äriline staatus peab olema "Mustand" või "Kinnitatud". Kehtivas staatuses muuta ei saa ja andmed jäävad samaks. Mustand: AssessmentModel.isConfirmed = false Kinnitatud: AssessmentModel.isConfirmed = true, validFrom > päringu teostamise aeg.	Vormielemendi sisendi formaat.
mandatory	1	Boolean	Lubatud väärtused: true false Saab muuta, kui hindamismudeli äriline staatus peab olema "Mustand" või "Kinnitatud". Kehtivas staatuses muuta ei saa ja andmed jäävad samaks. Mustand: AssessmentModel.isConfirmed = false Kinnitatud: AssessmentModel.isConfirmed = true, validFrom > päringu teostamise aeg.	Märge, mis näitab kas vormielemendi täitmine on kohustuslik või mitte.
optionTexts	0..*	Array	Lubatud kasutada, kui inputType = MULTIPLE_CHOICE või SINGLE_CHOICE. Muudel juhtudel peab olema 0 elementi nimekirjas. Kui inputType = MULTIPLE_CHOICE või SINGLE_CHOICE , siis peab nimekirja olema lisatud vähemalt üks element. Saab muuta, kui hindamismudeli äriline staatus peab olema "Mustand" või "Kinnitatud". Kehtivas staatuses muuta ei saa ja andmed jäävad samaks. Mustand: AssessmentModel.isConfirmed = false Kinnitatud: AssessmentModel.isConfirmed = true, validFrom > päringu teostamise aeg.	Vormielemendi vastusevariandid. Kasutatakse kui vormielemendi tüüp on MULTIPLE_CHOICE (Mitmikvalik) või SINGLE_CHOICE (Üksikvalik).
percentageTargetLevel	0..1	Integer	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..1	Object	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	1	Integer	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..1	String	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	1	String	Peab olema 3-250 tähemärki pikk.	Lingi nimetus.
hyperlinks.url	1	String	Peab vastama veebilehe lingi nõuetele.	Veebilehe link.
textAreaValue	0..1	String	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 (inputType = IMAGE).
files.fileId	1	UUID	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 (AssessmentModelPlanningSectionElement.files.id = Sisendis esitatud files.id).	Faili objekti id.
files.title	0..1	String	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	1	String	Lubatud kuni 250 tähemärki.	Veeru pealkiri.
columns.mandatory	1	Boolean	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

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
GS: AssessmentModel: API: POST /quality-api/assessment-models/{modelId}/planning/sections/{sectionId}/elements#V%C3%A4ljundid

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 valideerib sisendi.
1. Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem otsib planeerimise etapi sektsiooni elemendi andmed.
- Süsteem otsib Objektid#AssessmentModelPlanningSectionElement objekti, mille:
  - id = Sisendis esitatud elementId väärtus
  - assessmentModelPlanningSectionId = Sisendis esitatud sectionId väärtus.
  - objectStatus = CURRENT
    1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem muudab hindamismudelisse planeerimise etapi sektsiooni vormi elemendi andmed.
- Süsteem muudab leitud Objektid#AssessmentModelPlanningSectionElement 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.
  - inputType = Sisendis esitatud inputType väärtus.
  - mandatory = Sisendis esitatud mandatory 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)
Kui elemendi tüüpi (contentType) või elemendi sisendi formaati (inputType) muudeti ja enne muudatust oli elemendiga oli seotud faile (AssessmentModelPlanningSectionElement.files != null), siis:
1. Süsteem kustutab faili metaandmestiku süsteemist.
  - Süsteem kustutab Objektid#File objekte, mille id = AssessmentModelPlanningSectionElement.files.fileId ja objectStatus = CURRENT.
2. Süsteem kustutab kustutatud failide meteandmetega seotud failid failisüsteemist.
3. Süsteem kustutab elemendi viited failidele.
  - Süsteem uuendab leitud Objektid#AssessmentModelPlanningSectionElement objekti andmeid:
    - files = null
Süsteem tagastab muudetud andmed.

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

Üldkirjeldus

Eeltingimused ja kasutusõigused

Sisendid

Väljundid

Tegevused