Items - Get Report Definition

Palvelu:: Report

Ohjelmointirajapinnan versio:: v1

Palauttaa määritetyn raportin julkisen määrityksen.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Kun saat raportin julkisen määrityksen, luottamuksellisuustunniste ei ole osa määritelmää.

Käyttöoikeudet

Soittajalla on oltava raportin luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

Report.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Jotta soittaja voi noutaa salatulla luottamuksellisuustunnisteellä suojatun raporttikohteen määrityksen, hänellä on oltava riittävät käyttöoikeudet tunnisteen poistamiseen, kuten Microsoft Purview on määritetty.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/getDefinition

Valinnaisilla parametreilla:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/reports/{reportId}/getDefinition?format={format}

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
reportId	path	True	string (uuid)	Raporttitunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.
format	query		string	Raportin julkisen määrityksen muoto.

Vastaukset

Nimi	Tyyppi	Kuvaus
200 OK	ReportDefinitionResponse	Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty. Määrityksen noutaminen on kesken. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: OperationNotSupportedForItem – Toimintoa ei tueta pyydetylle kohteelle.

Esimerkit

Get a report definition example

Mallipyyntö

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/reports/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Mallivastaus

Tilakoodi:: 200

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Tilakoodi:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Määritelmät

Nimi	Kuvaus
ErrorParameter	Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
ReportDefinition	Raportin julkisen määrityksen objekti. Katso tästä artikkelista lisätietoja raportin määrityksen rakenteesta.
ReportDefinitionPart	Raportin määritysosan objekti.
ReportDefinitionResponse	Raportin julkinen määritysvastaus.

ErrorParameter

Kohde

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi	Tyyppi	Kuvaus
message	string	Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.
name	string	Parametritunniste.
value	string	Parametriarvo.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
InlineBase64	Inline Base 64.

ReportDefinition

Kohde

Raportin julkisen määrityksen objekti. Katso tästä artikkelista lisätietoja raportin määrityksen rakenteesta.

Nimi	Tyyppi	Kuvaus
format	string	Raportin määrityksen muoto.
parts	ReportDefinitionPart[]	Luettelo määritysosista.

ReportDefinitionPart

Kohde

Raportin määritysosan objekti.

Nimi	Tyyppi	Kuvaus
path	string	Raporttiosan polku.
payload	string	Raportin osakuormitus.
payloadType	PayloadType	Hyötykuorman tyyppi.

ReportDefinitionResponse

Kohde

Raportin julkinen määritysvastaus.

Nimi	Tyyppi	Kuvaus
definition	ReportDefinition	Raportin julkisen määrityksen objekti. Katso tästä artikkelista lisätietoja raportin määrityksen rakenteesta.