Üldkirjeldus

Teenus võimaldab lisada eesmärgile uue mõõdiku.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-798 - Getting issue details... STATUS

NSIL-910 - Getting issue details... STATUS

NSIL-1277 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

Kui tegemist on asutusepõhise eesmärgiga (Goal.goalScope = INSTITUTIONAL):
- Kasutajal on seos eesmärgi asutusega ja sama asutuse eesmärkide lisamise ja muutmise õigus.
  - Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
  - Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_MANAGE.
Kui tegemist on isikupõhise eesmärgiga (Goal.goalScope = INDIVIDUAL):
- Kasutaja on eesmärgi omanik ja tal on seos nii eesmärgi asutuse kui ka ametikohaga.
  - Goal.personalCode = Päringu käivitanud kasutaja isikukood
  - Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
  - Goal.jobsite = Kasutaja poolt valitud rolliga seotud ametikoht
  - Eraldi privileegi ei ole vaja.
- Lõpetatud ametikohtade eemärkide andmeid ei saa muuta, seega ei saa neile ka uusi mõõdikuid lisada.
Eesmärgi meeskonnaliikmel ei ole õigust eesmärgile mõõdikuid lisada.

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
goalId	1	String	Eesmärk peab eksisteerima. Goal.id = goalId Eesmärk ei tohi olla arhiveeritud. Goal.arhived = false	Viide eesmärgile, millele mõõdik lisatakse.
description	1	String	Peab olema 3 - 250 tähemärki.	Mõõdiku kirjelduse tekst.
reports	1..*	Array	Vähemalt 1 näitaja (aruanne) on kohustuslik.	Mõõdiku näitajad (aruanded). Eesmärgi mõõdikul võib olla 1..3 näitajat (aruannet).
reports.workspaceId	1	String	Peab olema 3-250 tähemärki.	PBI aruande tööruumi identifikaator.
reports.reportId	1	String	Peab olema 3-250 tähemärki.	PBI aruande identifikaator.
reports.bookmark	0..1	String	PBI aruande filtrite snapshot (bookmark) vastavalt kasutaja tehtud valikutele. Sisu maksimaalne pikkus: 4000 tähemärki. Sisu eeldatav formaat: base64.	Aruandele rakendatud filtrite snapshot (base64 formaadis).
reports.meta	1	Object	-	Näitaja (aruande) metaandmed.
reports.meta.dashboardName	1	String	Peab olema 3 - 250 tähemärki.	Juhtimislaua nimetus.
reports.meta.elementName	1	String	Peab olema 3 - 250 tähemärki.	Vahelehe nimetus.
reports.meta.subelementName	1	String	Peab olema 3 - 250 tähemärki.	Alamteema nimetus.
reports.meta.isPinnedElement	1	Boolean	Võimalikud väärtused: true - on juhtimislaual esiletõstetud false - ei ole esiletõstetud	Määrab, kas näitaja on juhtimislaual esiletõstetud või mitte.
targets	0..*	Array	Eesmärgi mõõdikul võib olla 0..n sihttaset.	Eesmärgi mõõdikuga seotud sihttase.
targets.year	1	Number	Peab olema neljakohaline number. Aasta peab olema määratud lubatud vahemikku: jooksev aasta kuni järgmised 10 aastat.	Sihttaseme aasta.
targets.description	1	String	Peab olema 3-2500 tähemärki.	Sihttaseme kirjeldus.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
id	1	String	Mõõdiku unikaalne identifikaator.
goalId	1	String	Viide eesmärgile, millega mõõdik on seotud.
description	1	String	Mõõdiku kirjelduse tekst.
reports	1..*	Array	Mõõdiku näitajad (aruanded). Eesmärgi mõõdikul võib olla 1..3 näitajat (aruannet).
reports.workspaceId	1	String	PBI aruande tööruumi identifikaator.
reports.reportId	1	String	PBI aruande identifikaator.
reports.bookmark	0..1	String	Aruandele rakendatud filtrite snapshot (base64 formaadis).
reports.meta	1	Object	Näitaja (aruande) metaandmed.
reports.meta.dashboardName	1	String	Juhtimislaua nimetus.
reports.meta.elementName	1	String	Vahelehe nimetus.
reports.meta.subelementName	1	String	Alamteema nimetus.
reports.meta.isPinnedElement	1	Boolean	Määrab, kas näitaja on juhtimislaual esiletõstetud või mitte.
targets	0..*	Array	Eesmärgi mõõdikuga seotud sihttase. Eesmärgi mõõdikul võib olla 0..n sihttaset.
targets.year	1	Number	Sihttaseme aasta.
targets.description	1	String	Sihttaseme kirjeldus.

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 eesmärk (goalId) eksisteerib ja kas päringu käivitanud kasutajal on õigus hallata selle andmeid.
1. Kontroll toimub vastavalt üldreeglites kirjeldatud loogikale.
2. Kui eesmärki ei leita või see ei vasta üldreeglitele, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem lisab leitud eesmärgile uue mõõdiku:
1. Süsteem loob uue Objektid#GoalMetrics objekti järgmiste väärtustega:
  1. id = UUID.
  2. goalId = Sisendis esitatud "goalId" väärtus.
  3. description = Sisendis esitatud "description" väärtus.
  4. Süsteem lisab mõõdikule sisendis esitatud näitajad:
    1. reports.workspaceId = Sisendis esitatud "reports.workspaceId" väärtus.
    2. reports.reportId = Sisendis esitatud "reports.reportId" väärtus.
    3. reports.bookmark = Sisendis esitatud "reports.bookmark" väärtus.
    4. reports.meta.dashboardName = Sisendis esitatud "reports.meta.dashboardName" väärtus.
    5. reports.meta.elementName = Sisendis esitatud "reports.meta.elementName" väärtus.
    6. reports.meta.subelementName = Sisendis esitatud "reports.meta.subelementName" väärtus.
    7. reports.meta.isPinnedElement = Sisendis esitatud "reports.meta.isPinnedElement" väärtus.
  5. Süsteem lisab mõõdikule sisendis esitatud sihttasemed.
    1. targets.year = Sisendis esitatud "targets.year" väärtus.
    2. targets.description = Sisendis esitatud "targets.description" väärtus.
Süsteem tagastab eesmärgile lisatud mõõdiku andmed.