NSILM

GS: DashboardDefinitionElementReportUrl: API: GET /dashboard/public/v1/dashboard-elements/{urlId}

Muutja: Carolina Kask · 2024-11-04

Üldkirjeldus

Teenus otsib kasutaja poolt loodud juhtimislaua elemendi jagamise lingi andmed.

Seotud andmeobjektid:

NSIL-650 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Autentimata ja autoriseerimata kasutajad saavad päringut käivitada.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
urlId1UUID
  • Jagamise link ei tohi olla kustutatud.
    • DashboardDefinitionElementReportUrl.id = urlId
Juhtimislaua elemendi raporti jagamise lingi id.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
dashboardDefinitionName

1

String
  • Juhtimislaua nimetus.
  • DashboardDefinition.name
dashboardDefinitionSectionName

1

String
  • Juhtimislaua vahelehe nimetus.
  • DashboardDefinitionSection.name
dashboardDefinitionSubSectionName

0..1

String
  • Juhtimislaua alateema nimetus.
  • DashboardDefinitionSection.name, mis on dashboardDefinitionComponentOrder.components objektis dashboardDefinitionSectionName väärtuse aluseks oleva objekti sees.
  • Väärtus võib puududa, kui elemendile ei ole alateemat määratud.
dashboardDefinitionElementName



  • Juhtimislaua elemendi nimetus.
  • DashboardDefinitionElement.name
dashboardDefinitionElementHelpText

0..1

String
  • Juhtimislaua elemendi selgitus.
  • DashboardDefinitionElement.helpText
report

1

Object
  • Juhtimislaua komponendiga seotud aruanne.
  • DashboardDefinitionElementReport

report.mainReport

1

booleanMärge, et tegemist on näitaja põhiaruandega.
report.pbiWorkspaceId

1

String
  • PBI aruande tööruumi identifikaator.
  • DashboardDefinitionElementReport.pbiWorkspaceId
report.pbiReportId

1

String
  • PBI aruande identifikaator.
  • DashboardDefinitionElementReport.pbiReportId
report.reportType

1

EHIS Classifier
  • Juhtimislaua aruande tüüp.
  • DashboardDefinitionElementReport.reportType
  • Väärtusena klassifikaatori REPORT_TYPE elemendi viide.
report.bookmark

0..1

String
  • Aruandele rakendatud filtrite snapshot (bookmark) base64 formaadis
  • DashboardDefinitionElementReportUrl.bookmark

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 jagamise lingi.
    • Süsteem otsib Objektid#DashboardDefinitionElementReportUrl objekti, mille:
      • id = Sisendis esitatud urlId väärtus.
      • objectStatus = CURRENT
        1. Kui objekti ei leitud, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem otsib jagamise lingiga seotud juhtimislaua andmed.
    • Süsteem otsib Objektid#DashboardDefinition objekti, mille:
      • id =  DashboardDefinitionElementUrl.dashboardDefinitionId
      • objectStatus = CURRENT
        1. Kui objekti ei leitud, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem otsib jagamise lingiga seotud juhtimislaua elemendi andmed.
    • Süsteem otsib Objektid#DashboardDefinitionElement objekti, mille: 
      • id = Leitud DashboardDefinitionElementUrl.dashboardDefinitionElementId
      • dashboardDefinitionId = Leitud DashboardDefinitionElementUrl.dashboardDefinitionId
      • objectStatus = CURRENT
        1. Kui objekti ei leitud, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  6. Süsteem otsib jagamise lingiga seotud juhtimislaua elemendi vahelehe objekti ja alateema objekti andmed juhtimislaua komponentide järjekorrast.
    1. Süsteem otsib Objektid#DashboardDefinitionComponentOrder.components SECTION tüüpi haru objektid (elemendile eelnevad sektsioonid), mille: 
      • dashboardDefinitionId = Leitud DashboardDefinitionElementUrl.dashboardDefinitionId
      • components.id = Leitud DashboardDefinitionElement.id
      • components.type = ELEMENT
      • objectStatus = CURRENT
        1. Kui vähemalt ühte SECTION tüüpi komponenti ei leitud, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  7. Süsteem otsib jagamise lingiga seotud juhtimislaua sektsioonide andmed.
    • Süsteem otsib Objektid#DashboardDefinitionSection objektid, mille:
      • id = Leitud DashboardDefinitionComponentOrder.components.id, mille components.type = SECTION
      • dashboardDefinitionId = Leitud DashboardDefinitionElementUrl.dashboardDefinitionId
      • objectStatus = CURRENT 
        1. Kui järjekorrast leitud (DashboardDefinitionComponentOrder.components) sektsioone (DashboardDefinitionSection) ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  8. Süsteem otsib juhtimislaua elemendiga seotud aruanded.
    • Süsteem otsib Objektid#DashboardDefinitionElementReport objektid, mille:
      • dashboardDefinitionId = Leitud DashboardDefinitionElementReportUrl.dashboardDefinitionId
      • dashboardDefinitionElementId = Leitud DashboardDefinitionElementReportUrl.dashboardDefinitionElementId
      • objektStatus = CURRENT
        1. Kui ühtegi objekti ei leitud, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  9. Süsteem tagastab leitud andmed.