NSILM

GS: DashboardDefinition: API: POST /quality-api/dashboard-definitions/{dashboardDefinitionId}/unpublish

Muutja: Carolina Kask · 2024-05-21

Üldkirjeldus

Teenus abil saab muuta avalikustatud juhtimislaua staatuse avalikustamata staatusesse.

Juhtimislaua staatust saab muuta järgmistesse staatustesse:

  • Avalikustatud → Avalikustamata

Seotud andmeobjektid:

NSIL-420 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kasutaja poolt valitud rollil peab olema juhtimislauaga seotud valdkonna haldamise õigus.
    • DashboardDefinition.domainType = Klassifikaatorid#KlassifikaatorDOMAIN, mis on seotud DASHBOARD_MANAGE_PRIVILEGE  (attributeDefinitionCode) privileegiga, mis on kasutaja poolt valitud rollile lisatud.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
dashboardDefinitionId1UUID
  • Juhtimislaud ei tohi olla kustutatud.
    • DashboardDefinition.objectStatus = CURRENT
  • Juhtimislaua staatus peab olema "Avalikustatud"
    • DashboardDefinition.statusType = "Avalikustatud"
Juhtimislaua id (UUID).

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
Sama, mis GS: DashboardDefinition: API: POST /quality-api/dashboard-definitions#V%C3%A4ljundid

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  2. Süsteem valideerib sisendi.
    1. Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  3. Süsteem otsib juhtimislaua üldandmed.
  4. Süsteem muudab juhtumislaua üldandmeid.
    • Süsteem muudab leitud Objektid#DashboardDefinition objekti andmeid:
      • statusType = Avalikustamata
      • publishedAt = null
      • audit (muutmine) = audit (muutmine)
  5. Süsteem tagastab muudetud andmed.