GS: AssessmentInstruction: API: GET /quality-api/assessment-instructions/{instructionId}/elements
Üldkirjeldus
Teenuse abil saab otsida hindamise juhendi elemente.
Seotud andmeobjektid:
NSIL-1268 - Getting issue details... STATUS
Eeltingimused ja kasutusõigused
- Kasutaja peab olema autenditud ja autoriseeritud.
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| instructionId | 1 | String |
| Hindamise juhendi id. |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| id | 1 | String | Hindamise juhendile lisatud vormielemendi id (UUID). |
| assessmentInstructionId | 1 | FK | Viide juhendile, millega komponendi seadistus on seotud. Viitab AssessmentInstruction.id väärtusele. |
| inputType | 1 | EHIS Classifier | Vormielemendi sisendi formaat. Väärtusena klassifikaatori INPUT_TYPE elemendi viide. |
| label | 1 | String | Vormielemendi silt. Kui labelDisplayedOnAssessment = false, siis label = null |
| helpText | 0..1 | String | Vormielemendi selgitus/abitekst. |
pbiMetadata | 0..1 | Object | PBI aruande andmed. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on PBI aruanne (inputType = REPORT). |
pbiMetadata.workspaceId | 1 | String | PBI aruande tööruumi identifikaator. |
pbiMetadata.reportId | 1 | String | PBI aruande identifikaator. |
files | 0..* | Array | Nimekiri failidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on pilt (inputType = IMAGE). |
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. |
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). |
| objectStatus | 1 | String | Objekti staatus.
|
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 otsib juhendi elemendid.
- Süsteem otsib Objektid#AssessmentInstructionElement objekte, mille:
- assessmentInstructionId = Sisendis esitatud instructionId väärtus.
- Süsteem otsib Objektid#AssessmentInstructionElement objekte, mille:
- Süsteem tagastab leitud andmed.