NSILM

PM: API: DevelopmentPlan: PATCH /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/hide

Muutja: Natalja Selivjorstova · 2025-05-17

Üldkirjeldus

Teenus võimaldab salvestada sektsiooni peitmise märke või selle eemaldamist.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1015 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kui tegemist on asutusepõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INSTITUTIONAL):
    • Kasutajal peab olema seos arengukava asutusega ning sama asutuse arengukava lisamise ja muutmise õigus. 
      • DevelopmentPlan.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_MANAGE.
  • Kui tegemist on isikupõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INDIVIDUAL):
    • Kasutaja peab olema arengukava omanik ja tal peab olema seos nii arengukava asutuse kui ka ametikohaga.
      • DevelopmentPlan.personalCode = Kasutaja isikukood
      • DevelopmentPlan.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • DevelopmentPlan.jobsite = Kasutaja poolt valitud rolliga seotud ametikoht
    • Eraldi privileegi ei ole vaja.
  • Arhiivi ja meeskonnaliikme rolli valinud kasutaja ei saa muuta arengukava.

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
sectionId

1

String
  • Peab eksisteerima ja olema seotud arengukavaga (developmentPlanId). 
    • sectionId = DevelopmentPlanSection.id, mille developmentPlanId = sisendis esitatud developmentPlanId
Arengukava sektsiooni unikaalne identifikaator.

developmentPlanId

1

String
  • Peab eksisteerima ja olema muudetav.
    • developmentPlanId = DevelopmentPlan.id, mille editable = true
Viide arengukavale, kuhu sektsioon kuulub.
hidden1Boolean
  • Peab erinema süsteemis salvestatud olekust.
    • hidden != DevelopmentPlanSection.hidden, mille id = sectionId
Määrab, kas sektsioon lisatakse arengukava PDF-i või URL-iga jagatavasse versiooni.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
Samad nagu teenusel PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections.

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui kasutajal puudub vastav õigus, 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 arengukava on muudetav:
    1. Süsteem otsib Objektid#DevelopmentPlan objekti, mille:
      1. id = sisendis esitatud developmentPlanId väärtus
      2. editable = true
    2. Kui tingimustele vastavat arengukava ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.

  4. Süsteem kontrollib, kas sisendis esitatud sektsioon (sectionId) eksisteerib ja on seotud sisendis esitatud arengukavaga:

    1. Süsteem otsib Objektid#DevelopmentPlanSection objekti, mille:
      1. id =  sisendis esitatud sectionId väärtus
      2. developmentPlanId = sisendis esitatud developmentPlanId väärtus
    2. Kui vastavat sektsiooni ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem märgib sektsiooni peidetuks või eemaldab peitmise märke:
    1. Süsteem muudab Objektid#DevelopmentPlanSection objekti, mille id = sisendis esitatud sectionId väärtus, järgmiselt:
      1. hidden= sisendis esitatud hidden väärtus
  6. Süsteem tagastab muudetud sektsiooni andmed.