NSILM

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

Muutja: Natalja Selivjorstova · 2025-08-06

Üldkirjeldus

Teenus võimaldab lisada arengukava vormielemendile pildi.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1003 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kui tegemist on asutusepõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INSTITUTIONAL):
    • Kasutajal on seos arengukava asutusega ning sama asutuse arengukava lisamise ja muutmise õigus. 
      • DevelopmentPlan.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_MANAGE.
  • Kui tegemist on isikupõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INDIVIDUAL):
    • Kasutaja on arengukava omanik ja tal on seos nii arengukava asutuse kui ka ametikohaga.
      • DevelopmentPlan.personalCode = Kasutaja isikukood
      • DevelopmentPlan.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • DevelopmentPlan.jobsite = Kasutaja poolt valitud rolliga seotud ametikoht
    • Eraldi privileegi ei ole vaja.
  • Arhiivi ja meeskonnaliikme rollis kasutajatel puudub õigus arengukava 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 pildi tüüpi ning olema seotud sektsiooniga.
    • elementId = DevelopmentPlanElement.id, mille developmentPlanSectionId = sectionId ja inputType = IMAGE
Viide vormielemendile, millega üleslaetav pilt seotakse.
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 ja olema muudetav.
    • developmentPlanId = DevelopmentPlan.id, mille editable = true
Viide arengukavale, kuhu sektsioon kuulub.
file1File
  • Lubatud vormingud: 
    • jpg
    • jpeg
    • png
    • svg
    • bmp
  • Faili maksimaalne suurus võib olla kuni 15 MB.

Sektsioonile vormielemendina üleslaetav fail.

Väljundid

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

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 sektsioon (sectionId) eksisteerib ja on seotud muudetava arengukavaga:

    1. Otsitakse objekt Objektid#DevelopmentPlanSection, mille:
      1. id =  sisendis esitatud sectionId väärtus
      2. developmentPlanId = sisendis esitatud developmentPlanId väärtus
    2. Kui vastavat sektsiooni ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
    3. Otsitakse objekt Objektid#DevelopmentPlan, mille:
      1. id =  sisendis esitatud developmentPlanId väärtus
      2. editable = true
    4. Kui vastavat arengukava ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.

  4. Süsteem kontrollib, kas sisendis esitatud vormielement (elementId) eksisteerib ja kuulub määratud sektsiooni:

    1. Otsitakse objekt Objektid#DevelopmentPlanElement, mille:
      1. id =  sisendis esitatud elementId väärtus
      2. developmentPlanSectionId = sisendis esitatud sectionId väärtus
      3. inputType = IMAGE
    2. Kui vastavat vormielementi ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem kontrollib viiruse kontrolliga, kas sisendis esitatud fail on viirusega nakatunud.
    1. Kui fail on nakatunud, siis lõpetab süsteem päringu töötlemise, tagastab http veakoodi ja info, et fail on viirusega nakatunud.
  6. Süsteem salvestab faili failisüsteemi.
  7. Süsteem salvestab failiga seotud metaandmed:
    1. Luuakse objekt Objektid#File järgmiste andmetega:
      1. id = UUID
      2. Faili asukoha andmestik failisüsteemis 
      3. fileName = Faili nimetus koos faililaiendiga (nt. "minu pilt.png")
      4. mimeType = Faili MIME tüüp (nt. "image/x-png")
      5. size = Faili suurus baitides
      6. audit (loomine) = audit (loomine)
  8. Süsteem seob loodud faili objekti vastava vormielemendiga:
    1. Uuendatakse objekt Objektid#DevelopmentPlanElement, mille id = sisendis esitatud elementId väärtus, määrates:
      1. file.id = just loodud Objektid#File.id
      2. file.title = NULL
  9. Süsteem tagastab vormielemendile lisatud pildi andmed.