NSILM

PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements

Muutja: Natalja Selivjorstova · 2025-05-20

Üldkirjeldus

Teenus väljastab arengukava sektsiooni vormielemendid.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1070 - 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 vaatamise õigus. 
      • DevelopmentPlan.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_VIEW.
  • Kui tegemist on isikupõhise arengukavaga (developmentPlan.developmentPlanScope = INDIVIDUAL):
    • Kasutaja peab olema arengukava omanik.
      • DevelopmentPlan.personalCode = Päringu käivitanud kasutaja isikukood.
    • Eraldi privileegi ei ole vaja.
  • Meeskonnaliikme rollis kasutajal ei ole antud funktsionaalsusele ligipääsu.

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. 
    • sectionId = DevelopmentPlanSection.id, mille developmentPlanId = developmentPlanId
Viide arengukava sektsioonile, kuhu vormielement kuulub.
developmentPlanId

1

String
  • Peab eksisteerima.
    • developmentPlanId = DevelopmentPlan.id

Viide arengukavale, kuhu sektsioon kuulub.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
elements0..*Array

Nimekiri sektsiooni vormielementidest.

Array objektid samad nagu teenusel PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/sections/{sectionId}/elements.

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 sektsioon (sectionId) eksisteerib ja on seotud arengukavaga:

    1. Otsitakse Objektid#DevelopmentPlanSection objekti, mille:
      1. id =  sisendis esitatud sectionId väärtus
      2. developmentPlanId = sisendis esitatud developmentPlanId väärtus
    2. Kui sellist sektsiooni ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem kontrollib, et arengukava eksisteerib:
    1. Otsitakse Objektid#DevelopmentPlan objekti, mille:
      1. id = sisendis esitatud developmentPlanId väärtus
    2. Kui vastavat arengukava ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem otsib sektsiooni vormielemente.
    1. Otsitakse Objektid#DevelopmentPlanElement objekte, mille:
      1. developmentPlanSectionId = sisendis esitatud sectionId väärtus.
    2. Kui ühtegi vormielementi ei leita, tagastatakse tühi vastus. 
    3. Iga leitud vormielemendi kohta, mille inputType = "IMAGE", otsitakse sellega seotud faili metaandmed:
      1. Otsitakse objekti Objektid#File, mille:
        1. id = vormielemendi juures märgitud faili ID (Objektid#DevelopmentPlanElement.file.id).
      2. Kui sellist faili ei leita, logitakse viga.
  6. Süsteem tagastab leitud vormielementide nimekirja.