NSILM

GS: Assessment: API: GET /quality-api/public/assessments/{assessmentSummaryId}/assessment-component/elements/{elementId}/files/{fileId}/download

Muutja: Andres Mill · 2024-12-19

Üldkirjeldus

Teenus võimaldab otsida autentimata kasutajal jagatud lingi identifikaatori abil hindamisega seotud enesehindamise ja välishindamise elementide faile.

Seotud andmeobjektid:

NSIL-741 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Puuduvad

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
assessmentSummaryId1String
  • Kokkuvõte ei tohi olla kustutatud.
    • AssessmentSummary.id = assessmentSummaryId
  • Kokkuvõtte tüüp peab olema URL.
    • AssessmentSummary.assessmentSummaryType = URL
  • Kokkuvõttega seotud hindamine ei tohi olla kustutatud.
    • AssessmentSummary.assessmentId = Assessment.id
  • Kokkuvõttele peab olema lisatud enesehindamise või välishindamise või hindamise tulemuste etapp.
    • AssessmentSummary.phaseTypes = SELF_ASSESSMENT või EXTERNAL_ASSESSMENT või NEEDS_FOR_IMPROVEMENT
Hindamise URL jagatava kokkuvõtva aruande id.
elementId1String
  • Element ei tohi olla kustutatud.
    • AssessmentComponentElement.objectStatus = CURRENT
  • Kui kokkuvõttel on ainult enesehindamise etapp ja kokkuvõttel puudub välishindamise etapp, siis on lubatud otsida ainult enesehindamise etapi elemendi faile.
  • Kui kokkuvõttele on lisatud välishindamise etapp või hindamise tulemuste etapp, siis on lubatud otsida enesehindamise ja välishindamise etappide faile. 
Elemendi id.
fileId1
  • Faili viide ei tohi elemendi küljest olla kustutatud.
    • AssessmentComponentElement.files.id = Sisendis esitatud fileId väärtus.

Elemendiga seotud fail.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
file0..1file

Fail

Tegevused

  1. 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.
  2. Süsteem otsib päringus esitatud tingimustele vastava hindamise komponendi elemendi faili.
    • Süsteem otsib Objektid#AssessmentComponentElement objekti, mille
      • id = Sisendis esitatud elementId väärtus.
      • assessmentId = AssessmentSummary.assessmentId 
      • files.fileId = Sisendis esitatud fileId väärtus.
      • objectStatus = CURRENT
  3. Süsteem otsib failisüsteemist faili, mille File.id = AssessmentComponentElement.files.fileId ja AssessmentComponentElement.files.id = Sisendis esitatud fileId väärtus.
  4. Süsteem tagastab leitud faili.