GS: AssessmentModel: API: POST /quality-api/assessment-models/{modelId}/planning/sections/{sectionId}/elements
Üldkirjeldus
Teenus salvestab hindamismudeli planeerimise etapi sektsiooni vormi elemendi andmed.
Seotud andmeobjektid:
NSIL-98 - 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 |
| Hindamismudeli id (UUID). |
| sectionId | 1 | UUID |
| Hindamismudeli paneerimise etapi sektsiooni id (UUID). |
| contentType | 1 | EHIS Classifier | Peab olema CONTENT_TYPE hulgas kehtiv kirje. | Määrab elemendi tüübi. |
| label | 1 | String | Peab olema 3 - 250 tähemärki. | Vormielemendi silt. |
| labelDisplayedOnAssessment | 1 | Boolean |
| Määrab, kas vormielemendi silti kuvatakse hindamise vormil või mitte.
|
| 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).
| Vormielemendi sisendi formaat. |
| mandatory | 1 | Boolean | Lubatud väärtused:
| Märge, mis näitab kas vormielemendi täitmine on kohustuslik või mitte. |
| optionTexts | 0..* | Array |
| Vormielemendi vastusevariandid. Kasutatakse kui vormielemendi tüüp on MULTIPLE_CHOICE (Mitmikvalik) või SINGLE_CHOICE (Üksikvalik). |
percentageTargetLevel | 0..1 | Integer |
| Osakaalu sihttase. |
scale | 0..1 | Object |
| Skaala objekt Kasutatakse juhul kui sisendi formaat väärtuseks on "skaala" (SCALE). |
| scale.valuesFrom | 1 | Integer |
| Skaala väärtuste algus. |
| scale.valuesUntil | 1 | Integer |
| Skaala väärtuste lõpp. |
scale.values | 1..* | Array |
| Skaala väärtuste selgitused. |
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 | Lubatud kuni 250 tähemärki. | Skaala väärtuse selgitus. |
hyperlinks | 0..* | Array |
| 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 |
| Lingi nimetus. |
hyperlinks.url | 1 | String |
| Veebilehe link. |
textAreaValue | 0..1 | String |
| 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). |
columns | 0..* | Object Array |
| 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 |
| Määrab, kas veeru täitmine on kohustuslik või mitte. |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| id | 1 | String | Hindamismudeli vormi sektsiooni lisatud vormielemendi id (UUID). |
| contentType | 1 | EHIS Classifier | Määrab elemendi tüübi. Väärtusena klassifikaatori CONTENT_TYPE elemendi viide. |
| label | 1 | String | Vormielemendi silt |
| labelDisplayedOnAssessment | 1 | Boolean | Määrab, kas vormielemendi silti kuvatakse hindamise vormil või mitte.
|
| helpText | 0..1 | String | Vormielemendi selgitus/abitekst. |
| 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. (Lisamise järjekord) |
optionTexts | 0..* | Array | Vormielemendi vastusevariandid. Kasutatakse kui vormielemendi tüüp on MULTIPLE_CHOICE (Mitmikvalik). |
pbiMetadata | 0..1 | Object | PBI aruande andmed. Kasutatakse kui elemendi tüüp on PBI aruanne (REPORT). |
pbiMetadata.workspaceId | 1 | String | PBI aruande tööruumi identifikaator. |
pbiMetadata.reportId | 1 | String | PBI aruande identifikaator. |
percentageTargetLevel | 0..1 | Integer | Osakaalu sihttase. Kasutatakse juhul kui sisendi formaat väärtuseks on "osakaal" (PERCENTAGE). |
scale | 0..1 | Object | Skaala objekt Kasutatakse juhul kui sisendi formaat väärtuseks on "skaala" (SCALE). |
| scale.valuesFrom | 0..1 | Integer | Skaala väärtuste algus. |
| scale.valuesUntil | 0..1 | Integer | Skaala väärtuste lõpp. |
scale.values | 0..* | Array | Skaala väärtuste selgitused. |
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. |
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. Loetakse faili enda metaandmetest. |
hyperlinks | 0..* | Array | 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 | Lingi nimetus. |
hyperlinks.url | 1 | String | Veebilehe link. |
textAreaValue | 0..1 | String | 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). |
columns | 0..* | Object Array | Nimekiri tabeli komponentide veergudest. Igale veeru objektile määratakse nimetus ja kas on kohustuslik või mitte. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on tabel (inputType = TABLE). |
columns.title | 1 | String | Veeru pealkiri. |
columns.mandatory | 1 | Boolean | Määrab, kas veeru täitmine on kohustuslik või mitte.
|
Tegevused
- Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
- Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem valideerib sisendi.
- Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem loob hindamismudelisse planeerimise etapi vormi sektsiooni vormi elemendi andmed.
- Süsteem loob Objektid#AssessmentModelPlanningSectionElement objekti:
- id = UUID
- assessmentModelPlanningSectionId = Sisendis esitatud sectionId väärtus.
- contentType = Sisendis esitatud contentType väärtus.
- label = Sisendis esitatud label väärtus.
- labelDisplayedOnAssessment = Sisendis esitatud labelDisplayedOnAssessment väärtus.
- helpText = Sisendis esitatud helpText väärtus.
- inputType = Sisendis esitatud inputType väärtus.
- mandatory = Sisendis esitatud mandatory väärtus.
- optionTexts = Sisendis esitatud optionTexts väärtused.
- pbiMetadata = Sisendis esitatud pbiMetadata väärtus.
- percentageTargetLevel = Sisendis esitatud percentageTargetLevel väärtus.
- scale = Sisendis esitatud scale väärtus.
- files = null
- hyperlinks = Sisendis esitatud hyperlinks väärtused.
- textAreaValue = Sisendis esitatud textAreaValue väärtus.
- columns = Sisendis esitatud columns väärtused.
- objectStatus = CURRENT
- audit (loomine) = audit (loomine)
- Süsteem loob Objektid#AssessmentModelPlanningSectionElement objekti:
- Süsteem tagastab loodud andmed.