NSILM

GS: Assessment: API: POST /quality-api/assessments/{assessmentId}/assessment-component/elements/{elementId}/files

Muutja: Andres Mill · 2025-10-02

Üldkirjeldus

Teenuse abil saab lisada vormielemendile pilte.

Seotud andmeobjektid:

NSIL-615 - Getting issue details... STATUS 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 
  • 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 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.presonalCode = Päringu käivitanud isiku isikukood.
    • Hindamine ei tohi olla lõpetatud.
      • Assessment.endDate = null
    • Hindamine ei tohi olla arhiveeritud.
      • Assessment.archivedAt = null
  • 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 

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
assessmentId1String
  • Hindamine ei tohi olla kustutatud.
    • Assesment.objectStatus = CURRENT
  • Hindamine ei tohi olla lõpetatud.
    • Assesment.endDate > Päringu teostamise aeg või Assesment.endDate = null.
  • Enesehindamise elementide muutmine
    • Enesehindamise elemente saab muuta, kui enesehindamine on kinnitamata ja kasutajal on enesehindamise muutmise õigus.
  • Välishindamise elementide muutmine
    • Välishindamise elemente saab muuta, kui enesehindamine on kinnitatud ja välishindamine ei ole kinnitatud ja kasutajal on välishindamise muutmise õigus.
Hindamise id.
elementId1String
  • Element ei tohi olla kustutatud.
    • AssessmentComponentElement.objectStatus = CURRENT
  • Elemendi tüüp peab olema kasutaja sisend.
    • AssessmentComponentElement.contentType = USER_INPUT
  • Elemendi sisendi formaat peab olema pilt või fail.
    • AssessmentComponentElement.inputType = IMAGE või FILE
Elemendi id.
file1File
  • Lubatud vormingud: 
    • inputType = IMAGE:
      • jpg
      • jpeg
      • png
      • svg
      • bmp
    • inputType = FILE
      • docx
      • doc
      • odt
      • ods
      • txt
      • rtf
      • pdf
      • xls
      • xlsx
      • csv
      • asice
      • cdoc
  • Faili maksimaalne suurus võib olla kuni 25 MB.

Elemendiga seotud fail.

fileModifiedAt0..1Date and timeKui sisendis ei ole väärtust esitatud, siis vaikimisi salvestatakse päringu käivitamise aeg.

Faili viimane muutmise aeg.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
id1UUID

Faili objekti id (UUID).

fileName1StringFaili nimetus koos faililaiendiga. Näiteks "minu pilt.png".
mimeType1StringFaili mime tüüp. Näiteks "image/x-png".
size1IntegerFaili suurus baitides.
fileModifiedAt0..1Date and timeFaili viimane muutmise aeg.
objectStatus1String

Objekti staatus.

  • CURRENT - Kehtiv
  • DELETED - Kustutatud

Tegevused

  1. 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.
  2. 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.
  3. Süsteem otsib päringus esitatud tingimustele vastavad hindamise vormi sektsiooni elemendi andmed.
    • Süsteem otsib Objektid#AssessmentComponentElement objekti, mille
      • id = Sisendis esitatud elementId väärtus.
      • assessmentId = Sisendis esitatud assessmentId väärtus.
      • objectStatus = CURRENT
        1. Kui tingimustele vastavalt objekti ei leitud, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem kontrollib viiruse kontrolliga, kas fail on viirusega nakatunud.
    1. Kui fail on viirusega nakatunud, siis lõpetab süsteem päringu töötlemise, tagastab http veakoodi ja info, et fail on viirusega nakatunud.
  5. Süsteem salvestab faili failisüsteemi.
  6. Süsteem salvestab faili metaandmed.
    • Süsteem loob Objektid#File objekti:
      • id = UUID
      • Faili asukoha andmestik failisüsteemis 
      • fileName = Faili nimetus koos faililaiendiga. Näiteks "minu pilt.png".
      • mimeType = Faili mime tüüp. Näiteks "image/x-png".
      • size = Faili suurus baitides.
      • fileModifiedAt = Sisendist fileModifiedAt väärtus.
      • objectStatus = CURRENT
      • audit (loomine) = audit (loomine)
  7. Süsteem seob faili hindamismudeli vormielemendiga.
    • Süsteem loob AssessmentComponentElement.files objekti:
      • file.fileId = Loodud File.id
      • file.title = null
      • file.templateFile = false
  8. Süsteem tagastab lisatud andmed.