Üldkirjeldus

Teenus võimaldab kasutajal alla laadida arengukava PDF-versiooni faili.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1091 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kui tegemist on asutusepõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INSTITUTIONAL):
- Kasutajal peab olema 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 peab olema arengukava omanik.
  - DevelopmentPlan.personalCode = kasutaja isikukood
- Eraldi privileegi ei ole vaja - õiguse alla laadida oma ametikohaga seotud arengukava PDF-versioone annab kasutajale tema isikukood.
Planeerimise meeskonnaliikme rollis kasutajatel puudub ligipääs arengukavadele.

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

Sisendid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Vaikeväärtus, valideerimine	Kirjeldus, täiendav info
developmentPlanId	1	String	Peab eksisteerima ja olema muudetav. developmentPlanId = DevelopmentPlan.id, mille editable = true	Viide arengukavale, mille versiooniga on tegemist.
versionId	1	String	Peab eksisteerima ja olema seotud failiga ja arengukavaga. versionId = DevelopmentPlanVersion.id, mille developmentPlanId = developmentPlanId ja fileId = fileId	Viide arengukava versioonile, mille faili alla laetakse.
fileId	1	String	Peab eksisteerima. File.id = fileId	Arengukava versiooniga seotud faili ID.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
Samad nagu teenusel PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/logos/{logoFileId}/download.

Tegevused

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.
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.
Süsteem kontrollib, kas sisendis esitatud versioon (versionId) eksisteerib ja on seotud arengukava (developmentPlanId) ja failiga (fileId):
1. Otsitakse Objektid#DevelopmentPlanVersion objekti, mille:
  1. id = sisendis esitatud versionId väärtus
  2. developmentPlanId = sisendis esitatud developmentPlanId väärtus
  3. file.id = leitud Objektid#File.id väärtus
2. Kui vastavat versiooni ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem kontrollib, kas arengukava eksisteerib ja on muudetav:
1. Otsitakse Objektid#DevelopmentPlan objekti, mille:
  1. id = sisendis esitatud developmentPlanId väärtus
  2. editable = true
2. Kui vastavat arengukava ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem otsib failisüsteemist faili:
1. Otsitakse faili metaandmed:
  1. Otsitakse Objektid#File objekti, mille:
    1. id = leitud versiooni Objektid#DevelopmentPlanVersion.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.
Süsteem tagastab leitud faili.