Üldkirjeldus

Teenus võimaldab salvestada arengukava vormielemendi andmed.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1007 - 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 rolli valinud kasutaja ei saa muuta arengukava.

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
elementId	1	String	Peab eksisteerima ja olema seotud sektsiooniga. elementId = DevelopmentPlanElement.id, mille developmentPlanSectionId = sectionId	Arengukava vormielemendi unikaalne identifikaator.
sectionId	1	String	Peab eksisteerima ja olema seotud arengukavaga. sectionId = DevelopmentPlanSection.id, mille developmentPlanId = developmentPlanId	Viide arengukava sektsioonile, kuhu vormielement kuulub.
developmentPlanId	1	String	Peab eksisteerima ja olema muudetav. developmentPlanId = DevelopmentPlan.id, mille editable = true	Viide arengukavale, kuhu sektsioon kuulub.
inputType	1	String	Väärtus peab vastama klassifikaatorile INPUT_TYPE. On lubatud ainult väärtused: TEXT_AREA IMAGE REPORT	Vormielemendi tüüp: tekst, pilt või aruanne.
textValue	0..1	String	Kohustuslik ja tohib olla määratud ainult siis, kui inputType = TEXT_AREA. Väärtuseks peab olema tekst, milles on lubatud järgmised vormingud: B, I, U, numbritega ja nummerdamata nimekirjad, link. Peab olema 3 - 2500 tähemärki pikk.	Teksti tüüpi vormielemendina sektsioonile lisatud tekst.
file	0..1	Object	Kohustuslik ja tohib olla määratud ainult siis, kui inputType = IMAGE.	Vormielemendiga seotud faili andmed.
file.id	1	String	Faili metaandmete objekt peab eksisteerima. fileId = File.id	Viide vormielemendiga seotud failile.
file.title	0..1	String	Peab olema 3 - 250 tähemärki pikk.	Failile lisatud pealkiri.
report	0..1	Object	Kohustuslik ja tohib olla määratud ainult siis, kui inputType = REPORT.	Vormielemendina lisatud näitaja andmed.
report.description	1	String	Peab olema 3 - 250 tähemärki.	Aruannete kirjeldus.
report.selectedReports	1..*	Array	Vähemalt 1 näitaja (aruanne) on kohustuslik.	Nimekiri valitud juhtimislaua aruannetest.
report.selectedReports.workspaceId	1	String	Peab olema 3 - 250 tähemärki.	PBI aruande tööruumi identifikaator.
report.selectedReports.reportId	1	String	Peab olema 3 - 250 tähemärki.	PBI aruande identifikaator.
report.selectedReports.bookmark	0..1	String	PBI aruande filtrite snapshot (bookmark) vastavalt kasutaja tehtud valikutele. Sisu maksimaalne pikkus: 4000 tähemärki. Sisu eeldatav formaat: base64.	PBI aruandele rakendatud filtrite snapshot (base64 formaadis).

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
Samad nagu teenusel PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.

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 arengukava vormielement (elementId) eksisteerib, on seotud sektsiooniga ja kas selle tüüp vastab sisendile:
1. Süsteem otsib Objektid#DevelopmentPlanElement objekti, mille:
  1. id = sisendis esitatud elementId väärtus
  2. developmentPlanSectionId = sisendis esitatud sectionId väärtus
  3. inputType = sisendis esitatud inputType väärtus
2. Kui vastavat vormielementi ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem kontrollib, kas sektsioon eksisteerib ja on seotud arengukavaga:
1. Otsitakse Objektid#DevelopmentPlanSection objekti, mille:
  1. id = leitud vormielemendi Objektid#DevelopmentPlanElement.developmentPlanSectionId väärtus
  2. developmentPlanId = sisendis esitatud developmentPlanId väärtus.
2. Kui sellist sektsiooni ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem kontrollib, kas arengukava on muudetav:
1. Otsitakse Objektid#DevelopmentPlan objekti, mille:
  1. id = leitud sektsiooni Objektid#DevelopmentPlanSection.developmentPlanId väärtus
  2. editable = true
2. Kui vastavat arengukava ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem uuendab vormielemendi andmed järgmiselt.
1. Kui sisendis esitatud inputType = "TEXT_AREA", uuendatakse varem leitud Objektid#DevelopmentPlanElement andmed:
  1. textValue = sisendis esitatud textValue väärtus
2. Kui sisendis esitatud inputType = "IMAGE":
  1. Kontrollitakse, kas Objektid#DevelopmentPlanElement.file.id vastab sisendis esitatud fileId väärtusele.
    1. Kui tingimus ei ole täidetud, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  2. Kui tingimus on täidetud, uuendatakse Objektid#DevelopmentPlanElement andmed:
    1. file.title = sisendis esitatud fileTitle väärtus (kui see on määratud)
3. Kui sisendis esitatud inputType = "REPORT", uuendatakse Objektid#DevelopmentPlanElement andmed järgmiselt:
  1. report.description = sisendis esitatud report.description väärtus
  2. Süsteem kirjutab üle Objektid#DevelopmentPlanElement.report.selectedReports nimekirja. Iga sisendis esitatud aruande kohta luuakse kirje järgmiste andmetega:
    1. workspaceId = Sisendis esitatud report.selectedReports.workplaceId väärtus.
    2. reportId = Sisendis esitatud report.selectedReports.reportId väärtus.
    3. bookmark = Sisendis esitatud report.selectedReports.bookmark väärtus.
Süsteem tagastab muudetud vormielemendi andmed.