Üldkirjeldus

Teenus võimaldab lisada eesmärgile, tegevusele või tööülesandele uue märkme.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-867 - 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 eesmärgi asutuse ja 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.
Või kasutaja on eesmärgi meeskonnas ja planeerimise meeskonna liikme rollil on eesmärkide lisamise ja muutmise õigus.
- Goal.goalScope = INSTITUTIONAL või INDIVIDUAL
- Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Päringu käivitanud kasutaja isikukood
- Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_MANAGE.

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 ja ei tohi olla arhiveeritud. Goal.id = goalId Goal.archived = false	Viide eesmärgile, millega märge seotakse.
goalActivityId	0..1	String	Antud atribuut ei tohi olla täidetud, kui goalActivityId on täidetud. Tegevus peab eksisteerima ja olema seotud eesmärgiga. GoalActivity.id = goalActivityId GoalActivity.goalId = goalId	Viide eesmärgi tegevusele, millele märge lisatakse.
goalActivityTaskId	0..1	String	Antud atribuut ei tohi olla täidetud, kui goalActivityId on täidetud. Tööülesanne peab eksisteerima ja olema seotud eesmärgiga. GoalActivityTask.id = goalActivityTaskId GoalActivityTask.goalId = goalId Tööülesanne ei tohi olla lõpetatud. GoalActivityTask.done = false	Viide tööülesandele, millele märge lisatakse.
visibilityType	1	String	Väärtus peab vastama EHIS klassifikaatorile HSILM_VISIBILITY.	Näitab kas kasutaja lisatud märge on nähtav kõigile kasutajatele, kellel ligipääs planeerimismoodulisse, või ainult märkme lisajale. Väärtusena klassifikaatori HSILM_VISIBILITY elemendi viide.
description	1	String	Lubatud 3-2500 tähemärki.	Märkme kirjeldus.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
id	1	String	Eesmärgi märkme unikaalne identifikaator.
goalId	1	String	Viide eesmärgile, millega märge on seotud.
goalActivityId	0..1	String	Viide eesmärgi tegevusele, millega märge on seotud.
goalActivityTaskId	0..1	String	Viide eesmärgi tööülesandele, millega märge on seotud.
description	0..1	String	Märkme kirjeldus.
visibilityType	1	String	Näitab kas kasutaja lisatud märge on nähtav kõigile kasutajatele, kellel ligipääs planeerimismoodulisse, või ainult märkme lisajale. Väärtusena klassifikaatori HSILM_VISIBILITY elemendi viide.
createdBy	1	String	Märkme lisanud kasutaja nimi.
createdAt	1	Datetime	Märkme lisamise aeg.
modifiedBy	1	String	Märke uuendanud kasutaja nimi.
modifiedAt	1	Datetime	Märke uuendamise aeg.

Tegevused

Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
1. Kui õigust pole, 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 seda hallata.
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.
Kui märge lisatakse tegevusele või tööülesandele, kontrollib süsteem, et see eksisteerib ja on seotud eesmärgiga. Tööülesande puhul kontrollitakse lisaks, et see ei oleks lõpetatud:
1. Kui sisendis on täidetud "goalActivityId" parameeter:
  1. Süsteem otsib Objektid#GoalActivity objekti, mille:
    1. id = Sisendis esitatud "goalActivityId" väärtus
    2. goalId = Sisendis esitatud "goalId" väärtus
    3. Kui tegevust ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
2. Kui sisendis on täidetud "goalActivityTaskId" parameeter:
  1. Süsteem otsib Objektid#GoalActivityTask objekti, mille:
    1. id = Sisendis esitatud "goalActivityTaskId" väärtus
    2. goalId = Sisendis esitatud "goalId" väärtus
    3. done = false
    4. Kui tööülesannet ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem lisab sisendis esitatud eesmärgile, tegevusele või tööülesandele uue märkme:
1. Süsteem loob uue Objektid#GoalNote objekti, mille:
  - id = UUID
  - goalId = Sisendis esitatud "goalId" väärtus
  - goalActivityId = Sisendis esitatud "goalActivityId" väärtus (kui määratud)
  - goalActivityTaskId = Sisendis esitatud "goalActivityTaskId" väärtus (kui määratud)
  - description = Sisendis esitatud "description" väärtus
  - visibilityType = Sisendis esitatud "visibilityType" väärtus
  - personalCode = Päringu käivitanud kasutaja isikukood
  - createdBy = Päringu käivitanud kasutaja nimi
  - createdAt = Päringu käivitamise aeg
  - modifiedBy = Päringu käivitanud kasutaja nimi
  - modifiedAt = Päringu käivitamise aeg
Süsteem tagastab loodud märkme.