Üldkirjeldus

Teenus võimaldab salvestada märkme andmed.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-868 - 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
goalNoteId	1	String	Märge peab eksisteerima ja olema seotud eesmärgiga. GoalNote.id = goalNoteId GoalNote.goalId = goalId	Eesmärgi märkme unikaalne identifikaator, mille andmeid muudetakse.
goalId	1	String	Eesmärk peab eksisteerima ja ei tohi olla arhiveeritud. Goal.id = goalId Goal.archived = false	Viide eesmärgile, millega märge on seotud.
description	1	String	Lubatud 3-2500 tähemärki.	Märkme kirjeldus.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
Samad mis teenusel PM: API: Goal: POST /planning-api/goals/{goalId}/notes.

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.
Süsteem kontrollib, et sisendis esitatud märge (goalNoteId) eksisteerib ja on seotud eesmärgiga:
1. Süsteem otsib Objektid#GoalNote objekti, mille:
  1. id = Sisendis esitatud "goalNoteId" väärtus
  2. goalId = Sisendis esitatud "goalId" väärtus
2. Kui märget ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
3. Kui tegemist on tööülesande märkmega, siis kontrollitakse, tööülesanne ei oleks lõpetatud:
  1. Kui leitud märkme Objektid#GoalNote.goalActivityTask != NULL:
    1. Süsteem otsib Objektid#GoalActivityTask objekti, mille:
      1. id = Objektid#GoalNote.goalActivityTask, mille id = Sisendis esitatud "goalNoteId" väärtus
      2. goalId = Sisendis esitatud "goalId" väärtus
      3. done = false
    2. Kui tingimustele vastavat tööülesannet ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem kontrollib, kas päringu käivitanud kasutaja tohib märget muuta:
1. Kui leitud märkme Objektid#GoalNote.visibilityType = "PRIVATE", kontrollitakse, et päringu käivitanud kasutaja oleks märkme looja:
  1. Objektid#GoalNote.personalCode = Päringu käivitanud kasutaja isikukood
2. Kui tingimused pole täidetud, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem uuendab märkme andmed:
1. Süsteem uuendab leitud Objektid#GoalNote objekti andmed järgmiselt:
  - description = Sisendis esitatud "description" väärtus
  - modifiedBy = Päringu käivitanud kasutaja nimi
  - modifiedBy = Päringu käivitamise aeg
  - Ülejäänud andmed jäävad samaks.
Süsteem tagastab muudetud märkme andmed.