NSILM

PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements/{elementId}/files/{fileId}/download

Muutja: Natalja Selivjorstova · 2025-08-06

Üldkirjeldus

Teenus võimaldab alla laadida vormielemendile lisatud faili.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1071 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kui tegemist on asutusepõhise arengukavaga (developmentPlanScope = INSTITUTIONAL):
    • Kasutajal on seos arengukava asutusega ning tal on selle asutuse arengukava vaatamise õigus.
      • DevelopmentPlan.institution.id = kasutaja valitud rolliga seotud asutus
      • Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_VIEW.
  • Kui tegemist on isikupõhise arengukavaga (developmentPlanScope = INDIVIDUAL):
    • Kasutaja on nii arengukava omanik.
      • DevelopmentPlan.personalCode = kasutaja isikukood
    • Eraldi privileegi ei ole vaja.
  • Meeskonnaliikme rolli valinud kasutajal ei ole õigust arengukava lisada ega muuta.

Planeerimise mooduli kasutusrollide ja õiguste kohta saab täpsemalt infot leida lehelt Kasutusõigused ja rollid.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info

elementId

1

String
  • Peab eksisteerima, olema seotud sektsiooniga ning selle tüüp peab olema pilt.
    • elementId = DevelopmentPlanElement.id, mille developmentPlanSectionId = sectionId ja inputType = IMAGE
Viide vormielemendile, mille pilti soovitakse alla laadida.
sectionId

1

String
  • Peab eksisteerima ja olema seotud arengukavaga.
    • sectionId = DevelopmentPlanSection.id, mille developmentPlanId = developmentPlanId
Viide sektsioonile, kuhu vormielement kuulub.
developmentPlanId

1

String
  • Peab eksisteerima.
    • developmentPlanId = DevelopmentPlan.id
Viide arengukavale, kuhu sektsioon kuulub.
fileId

1

String
  • Peab eksisteerima ja olema seotud vormielemendiga.
    • File.id = fileId
    • DevelopmentPlanElement.file.id = fileId
Viide vormielemendiga seotud failile.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
Samad nagu teenusel PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/logos/{logoFileId}/download.

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui kasutajal ei ole õigust, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  2. Süsteem kontrollib, kas sisendandmed vastavad nõuetele.
    1. Kui andmed ei vasta nõuetele, lõpetatakse päringu töötlemine ja tagastatakse http veakood.

  3. Süsteem kontrollib, kas sisendis esitatud vormielement (elementId) eksisteerib, kas selle tüüp on pilt ning kas sellega on seotud sisendis esitatud fail (fileId) ja sektsioon (sectionId):

    1. Otsitakse Objektid#DevelopmentPlanElement objekti, mille:
      1. id =  sisendis esitatud elementId väärtus
      2. developmentPlanSectionId = sisendis esitatud sectionId väärtus
      3. imageType = IMAGE
      4. file.id =  sisendis esitatud fileId väärtus
    2. Kui vastavat vormielementi ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem otsib failisüsteemist faili:
    1. Otsitakse faili metaandmed:
      1. Otsitakse Objektid#File objekti, mille:
        1. id = leitud vormielemendi Objektid#DevelopmentPlanElement.file.id väärtus.
      2. Kui vastavat objekti ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
    2. Failihoidlast otsitakse fail, mille:
      1. id = leitud Objektid#File.fileSystemId
    3. Kui vastavat faili ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem tagastab leitud faili.