Items - Update Report Definition

Servizio:

Report

Versione API:

v1

Esegue l'override della definizione per il report specificato.
Questa API supporta operazioni con esecuzione prolungata (LRO).

L'aggiornamento della definizione del report non influisce sull'etichetta di riservatezza.

Autorizzazioni

Il chiamante deve disporre delle autorizzazioni di lettura e scrittura per il report.

Ambiti delegati obbligatori

Report.ReadWrite.All o Item.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Assistenza
Utente	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
reportId	path	True	string (uuid)	ID report.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
updateMetadata	query		boolean	Se impostato su true e il file con estensione platform viene fornito come parte della definizione, i metadati dell'elemento vengono aggiornati usando i metadati nel file con estensione platform

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
definition	True	ReportDefinition	Oggetto definizione pubblica del report. Per altre informazioni su come creare una definizione pubblica del report, vedere questo articolo .

Risposte

Nome	Tipo	Descrizione
200 OK		Richiesta completata correttamente.
202 Accepted		Richiesta accettata. La definizione di aggiornamento è in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: OperationNotSupportedForItem: operazione non supportata per la richiesta. oggetto CorruptedPayload: il payload fornito è danneggiato.

Esempio

Update a report definition example

Esempio di richiesta

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/reports/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Risposta di esempio

Codice di stato:

200

Codice di stato:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.
ReportDefinition	Oggetto definizione pubblica del report. Per altre informazioni su come creare una definizione pubblica del report, vedere questo articolo .
ReportDefinitionPart	Oggetto parte della definizione del report.
UpdateReportDefinitionRequest	Aggiornare il payload della richiesta di definizione pubblica del report.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

ReportDefinition

Oggetto

Oggetto definizione pubblica del report. Per altre informazioni su come creare una definizione pubblica del report, vedere questo articolo .

Nome	Tipo	Descrizione
format	string	Formato della definizione dell'elemento.
parts	ReportDefinitionPart[]	Elenco di parti di definizione.

ReportDefinitionPart

Oggetto

Oggetto parte della definizione del report.

Nome	Tipo	Descrizione
path	string	Percorso della parte del report.
payload	string	Payload della parte del report.
payloadType	PayloadType	Tipo di payload.

UpdateReportDefinitionRequest

Oggetto

Aggiornare il payload della richiesta di definizione pubblica del report.

Nome	Tipo	Descrizione
definition	ReportDefinition	Oggetto definizione pubblica del report. Per altre informazioni su come creare una definizione pubblica del report, vedere questo articolo .