NSILM

PM: API: Goal: PUT /planning-api/goals/{goalId}/team-members/{teamMemberId}

Muutja: Natalja Selivjorstova · 2025-03-24

Üldkirjeldus

Teenus võimaldab salvestada eesmärgi meeskonnaliikme detailandmed.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-800 - Getting issue details... STATUS

NSIL-912 - Getting issue details... STATUS

NSIL-979 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kui tegemist on asutusepõhise eesmärgiga (Goal.goalScope = INSTITUTIONAL):
    • Enda andmete muutmiseks:  
      • Kasutaja peab olema eesmärgi meeskonnas.
        • Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Kasutaja isikukood
      • Kasutajal peab olema 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.
      • Või planeerimise meeskonna liikme rollil peab olema eesmärkide lisamise ja muutmise õigus.
        • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_MANAGE.
    • Teiste meeskonnaliikmete andmete muutmiseks:
      • Kasutajal peab olema seos eesmärgi asutusega ja sama asutuse meeskonnaliikmete lisamise ja muutmise õigus. 
        • Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
        • Õigust reguleerib privileeg: HSILM_PLANNING_TEAM_MEMBER_MANAGE.
      • Või kasutaja peab olema eesmärgi meeskonnas ja planeerimise meeskonna liikme rollil peab olema meeskonnaliikmete lisamise ja muutmise õigus.
        • Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Kasutaja isikukood
        • Õigust reguleerib privileeg: HSILM_PLANNING_TEAM_MEMBER_MANAGE.
  • Kui tegemist on isikupõhise eesmärgiga (Goal.goalScope = INDIVIDUAL):
    • Enda andmete muutmiseks: 
      • Kasutaja peab olema eesmärgi meeskonnas.
        • Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Kasutaja isikukood
      • Kasutaja peab olema eesmärgi omanik.
        • Goal.personalCode = Päringu käivitanud kasutaja isikukood.
        • Kasutajal peab olema ka seos eesmärgi asutuse ja ametikohaga.
          • 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 peab olema eesmärgi meeskonnas ja planeerimise meeskonna liikme rollil peab olema eesmärkide lisamise ja muutmise õigus.
        • Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Kasutaja isikukood
        • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_MANAGE.
    • Teiste meeskonnaliikmete andmete muutmiseks:
      • Kasutaja peab olema eesmärgi omanik.
        • Goal.personalCode = Kasutaja isikukood.
        • Kasutajal peab olema ka seos eesmärgi asutuse ja ametikohaga.
          • 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 peab olema eesmärgi meeskonnas ja planeerimise meeskonna liikme rollil peab olema meeskonnaliikmete lisamise ja muutmise õigus.
        • Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Kasutaja isikukood
        • Õigust reguleerib privileeg: HSILM_PLANNING_TEAM_MEMBER_MANAGE.

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

teamMemberId

1

String
  • Peab olema üks eesmärgi meeskonnaliikmetest.
    • GoalTeamMember.id = goalTeamMemberId
    • GoalTeamMember.goalId = goalId
Meeskonnaliikme unikaalne identifikaator, kelle andmeid muudetakse

goalId

1

String
  • Eesmärk peab eksisteerima.
    • Goal.id = goalId
  • Eesmärk ei tohi olla arhiveeritud.
    • Goal.arhived = false
Viide eesmärgile, millega meeskonnaliige on seotud.

email

0..1

String
  • Peab vastama e-posti aadressi reeglitele.
  • Kuni 250 tähemärki.
Meeskonna liikme e-posti aadress.

phoneNumber

0..1

String
  • Lubatud kuni 12 tähemärki.
Meeskonna liikme telefoninumber.

institution

0..1

String
  • Kuni 250 tähemärki.
Meeskonna liikme asutuse nimetus.

jobTitle

0..1

String
  • Kuni 250 tähemärki.
Meeskonna liikme ametinimetus.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info

Samad mis teenusel PM: API: Goal: POST /planning-api/goals/{goalId}/team-members.

Tegevused

  1. 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.
  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 hallata selle andmeid.
    1. Kontroll teostatakse 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 meeskonnaliige on eesmärgi meeskonnas.
    1. Süsteem otsib Objektid#Goal objekti, mille:
      1. id = Sisendis esitatud "goalId" väärtus
      2. teamMembers.id = Sisendis esitatud "teamMemberId" väärtus
    2. Kui tingimustele vastavat eesmärki ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem uuendab meeskonnaliikme andmed:
    1. Süsteem uuendab leitud Objektid#GoalTeamMember objekti järgmisi välju:
      1. email = Sisendis esitatud "email" väärtus
      2. phoneNumber = Sisendis esitatud "phoneNumber" väärtus
      3. institution = Sisendis esitatud "institution" väärtus
      4. jobTitle = Sisendis esitatud "jobTitle" väärtus
  6. Süsteem tagastab muudetud meeskonnaliikme andmed.