GS: Assessment: API: POST /quality-api/assessments/{assessmentId}/assessment-component/elements
Üldkirjeldus
Teenus võimaldab hindamise vormil kasutajal hindamise vormielemente luua.
Seotud andmeobjektid:
NSIL-835 - Getting issue details... STATUS NSIL-1099 - 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
- Kasutajal peab olema hindamise valdkonnaga seotud enesehindamise andmete muutmise õigus hindamisega seotud asutuse juures.
- 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.
- Päringu käivitanud kasutaja on isik, kelle suhtes hindamist läbi viiakse.
- 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
- Päringu käivitanud kasutaja on isik, kelle on hindamine suunatud.
- 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
- Kasutajal peab olema hindamise valdkonnaga seotud enesehindamise andmete muutmise õigus töödeldava hindamisega seoses ja kasutaja peab olema seotud hindamisega.
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| assessmentId | 1 | String |
| Hindamise id. |
| sectionId | 1 | UUID |
| Hindamise komponendi sektsiooni id (UUID). |
| previousComponent.id | 0..1 | String |
| Hindamise komponendi sektsiooni seadistuse objektile eelneva hindamise komponendi (sektsiooni, vormielemendi) id. |
| previousComponent.type | 0..1 |
| Hindamise komponendi sektsiooni seadistuse objektile eelneva hindamise komponendi (sektsiooni, vormielemendi) tüüp. | |
| inputType | 1 | EHIS Classifier |
| Vormielemendi sisendi formaat. |
| phaseType | 1 | EHIS Classifier list |
| Nimekiri etappidest, kus elementi kasutatakse. |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| GS: Assessment: API: PUT /quality-api/assessments/{assessmentId}/assessment-component/elements/{elementId}#V%C3%A4ljundid | |||
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 kontrollib, kas andmed vastavad nõuetele.
- Kui andmed ei vasta nõuetele, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem lisab hindamise komponentide hulka uue elemendi andmed.
- Süsteem loob Objektid#AssessmentComponentElement objekti:
- id = UUID
- definitionId = UUID
- assessmentId = Sisendis esitatud assessmentId väärtus.
- contentType = USER_INPUT
- label = null
- labelDisplayedOnAssessment = false
- helpText = null
- pbiMetadata = null
- phaseType = Sisendis esitatud phaseType väärtus.
- inputType = Sisendis esitatud inputType väärtus.
- mandatory = false
- synchronizedToDwh = false
- options = null
- percentage = null
- numberValue = null
- scale = null
- files = null
- textAreaValue = null
- reports = null
- hyperlinks = null
- table = null
- source = ASSESSMENT
- objectStatus = CURRENT
- audit (loomine) = audit (loomine)
- Süsteem loob Objektid#AssessmentComponentElement objekti:
- Süsteem lisab loodud elemendi hindamise komponentide järjekorras õigesse asukohta.
- sectionId väärtus määrab vormielemendi ülemtaseme hindamise komponendi, mille alla vormielement lisatakse.
- Kui previousComponent väärtus ei ole määratud, siis lisatakse vormielement vastava taseme hindamise komponentide järjekorras esimeseks.
- Kui previousComponent väärtus on määratud, siis lisatakse loodud vormielement vastava taseme hindamise komponentide järjekorras määratud hindamise komponendi järele.
- Andmed salvestatakse Objektid#AssessmentComponentOrder objekti.
- Süsteem tagastab loodud andmed.