NSILM

PM: API: Goal: GET /planning-api/goals/{goalId}/notes/{goalNoteId}

Muutja: Natalja Selivjorstova · 2025-06-02

Üldkirjeldus

Teenus võimaldab pärida märkme andmeid märkme ID järgi.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-943 - 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 vaatamise õigus. 
      • Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_VIEW.
  • Kui tegemist on isikupõhise eesmärgiga (Goal.goalScope = INDIVIDUAL):
    • Kasutaja on eesmärgi omanik.
      • Goal.personalCode = Päringu käivitanud kasutaja isikukood.
      • Eraldi privileegi ei ole vaja.
  • Või kasutaja on eesmärgi meeskonnas ja planeerimise meeskonna liikme rollil on eesmärkide vaatamise õigus.
    • Goal.goalScope = INSTITUTIONAL või INDIVIDUAL
    • Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Kasutaja isikukood
    • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_VIEW.

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

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
goalNoteId

1

String
  • Märge peab eksisteerima ja olema seotud eesmärgiga.
    • goalNoteId = GoalNotes.id, mille goalId = sisendis esitatud "goalId"
Eesmärgi märkme unikaalne identifikaator, mille andmeid päritakse.

goalId

1

String
  • Eesmärk peab eksisteerima.
    • Goal.id = goalId
Viide eesmärgile, millega märge on seotud.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

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

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui õigust pole, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  2. 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.
  3. 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.
  4. Süsteem kontrollib, kas sisendis esitatud märge (goalNoteId) eksisteerib ja on seotud sisendis esitatud eesmärgiga (goalId):  
    1. Süsteem otsib Objektid#GoalNote objekti, mille:
      1. id = Sisendis esitatud "goalNoteId" väärtus
      2. goalId =  Sisendis esitatud "goalId" väärtus
      3. Kui visibilityType = "PRIVATE", siis personalCode peab vastama päringu käivitanud kasutaja isikukoodile.
    2. Kui vastavat märget ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem tagastab muudetud märkme andmed.