Sviluppare con le API REST per il server di report di Power BI

Il server di report di Power BI supporta le API REST (Representational State Transfer). Le API REST sono endpoint di servizio che supportano un set di operazioni HTTP (metodi), che consentono di creare, recuperare, aggiornare o eliminare l'accesso per le risorse all'interno di un server di report.

L'API REST fornisce l'accesso a livello di codice agli oggetti in un catalogo del server di report di Power BI. Esempi di oggetti sono cartelle, report, indicatori KPI, origini dati, set di dati, piani di aggiornamento, sottoscrizioni e altro ancora. Usando l'API REST è possibile, ad esempio, esplorare la gerarchia di cartelle, individuare il contenuto di una cartella o scaricare una definizione di report. È anche possibile creare, aggiornare ed eliminare oggetti. Esempi di utilizzo di oggetti sono il caricamento di un report, l'esecuzione di un piano di aggiornamento, l'eliminazione di una cartella e così via.

Annotazioni

Se si vuole visualizzare o eliminare dati personali, consultare il materiale sussidiario di Microsoft sul sito Richieste del soggetto dei dati per l'RGPD in Windows. Per informazioni generali sul GDPR, vedere la sezione GDPR del portale Service Trust.

Componenti di una richiesta/risposta dell'API REST

Una coppia richiesta/risposta API REST può essere separata in cinque componenti:

• URI della richiesta, costituito da: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Anche se l'URI della richiesta è incluso nell'intestazione del messaggio di richiesta, viene chiamato separatamente perché la maggior parte dei linguaggi o dei framework richiede di passarlo separatamente dal messaggio di richiesta.

  • Schema URI: indica il protocollo usato per trasmettere la richiesta. Ad esempio, http o https.
  • Host URI: specifica il nome di dominio o l'indirizzo IP del server in cui è ospitato l'endpoint del servizio REST, ad esempio myserver.contoso.com.
  • Percorso risorsa: specifica la risorsa o la raccolta di risorse, che può includere più segmenti usati dal servizio per determinare la selezione di tali risorse. Ad esempio: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties può essere usato per ottenere le proprietà specificate per CatalogItem.
  • Stringa di query (facoltativa): fornisce altri parametri semplici, ad esempio la versione dell'API o i criteri di selezione delle risorse.

• Campi di intestazione del messaggio di richiesta HTTP:

  • Un metodo HTTP obbligatorio (noto anche come operazione o verbo), che indica al servizio il tipo di operazione richiesto. Le API REST di Reporting Services supportano i metodi DELETE, GET, HEAD, PUT, POST e PATCH.
  • Altri campi di intestazione facoltativi, come richiesto dall'URI e dal metodo HTTP specificati.

• Campi facoltativi del corpo del messaggio di richiesta HTTP per supportare l'URI e l'operazione HTTP. Ad esempio, le operazioni POST contengono oggetti con codifica MIME passati come parametri complessi. Per le operazioni POST o PUT, è necessario specificare anche il tipo di codifica MIME per il corpo nell'intestazione della Content-type richiesta. Alcuni servizi richiedono l'uso di un tipo MIME specifico, ad esempio application/json.

• Campi di intestazione del messaggio di risposta HTTP:

  • Codice di stato HTTP, compreso tra codici di errore 2xx e codici di errore 4xx o 5xx. In alternativa, potrebbe essere restituito un codice di stato definito dal servizio, come indicato nella documentazione dell'API.
  • Altri campi di intestazione facoltativi, come richiesto per supportare la risposta della richiesta, ad esempio un'intestazione di Content-type risposta.

• Campi facoltativi del corpo del messaggio di risposta HTTP:

  • Gli oggetti risposta con codifica MIME vengono restituiti nel corpo della risposta HTTP, ad esempio una risposta da un metodo GET che restituisce dati. In genere, questi oggetti vengono restituiti in un formato strutturato, ad esempio JSON o XML, come indicato dall'intestazione della Content-type risposta.

Documentazione dell'API

Una moderna API REST richiede una documentazione API moderna. L'API REST è basata sulla specifica OpenAPI (nota anche come specifica swagger) e la documentazione è disponibile in Microsoft Learn.

Test delle chiamate API

Uno strumento per testare i messaggi di richiesta/risposta HTTP è Fiddler. Fiddler è un proxy di debug Web gratuito in grado di intercettare le richieste REST, semplificando la diagnosi dei messaggi di richiesta/risposta HTTP.

Contenuti correlati

Esaminare le API disponibili in Microsoft Learn.

Gli esempi sono disponibili in GitHub. L'esempio include un'app HTML5 basata su TypeScript, React e webpack insieme a un esempio di PowerShell.

Altre domande? Chiedi alla community di Power BI