Published - List Datasource Elements

Servizio:: DataAgent

Versione API:: v1

Restituisce gli elementi dello schema a un livello dell'albero dello schema per un'origine dati pubblicata.

Note

La gestione della configurazione dell'agente dati è attualmente disponibile in anteprima (altre informazioni).

Gli elementi rappresentano l'albero dello schema di un'origine dati (schemi, tabelle, colonne). Spostarsi a livello per livello usando il rootId parametro .

Questa API supporta paginazione.

Autorizzazioni

Il chiamante deve disporre delle autorizzazioni di lettura per DataAgent.

Ambiti delegati obbligatori

Item.Read.All o Item.ReadWrite.All o DataAgent.Read.All o DataAgent.ReadWrite.All

Identità supportate da Microsoft Entra

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

Identità	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interfaccia

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/elements

Con parametri facoltativi:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/elements?rootId={rootId}&continuationToken={continuationToken}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
dataAgentId	path	True	string (uuid)	ID DataAgent.
datasourceId	path	True	string (uuid)	ID origine dati.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
continuationToken	query		string	Token per il recupero della pagina successiva dei risultati.
rootId	query		string	Identificatore di un elemento padre. Omettere per ottenere il livello radice.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	DataSourceElements	Richiesta completata correttamente.
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: ItemNotFound: l'elemento richiesto non è stato trovato.

DataSourceElements

Richiesta completata correttamente.

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:

ItemNotFound: l'elemento richiesto non è stato trovato.

Esempio

List published DataAgent datasource elements example

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/datasources/c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30/elements

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "U2NoZW1hcw==",
      "isSelected": false,
      "displayName": "Schemas",
      "type": "Schemas",
      "hasSubElements": true,
      "state": "Available",
      "lastSyncDateTime": "2025-06-15T10:30:00Z"
    },
    {
      "id": "VGFibGVz",
      "isSelected": false,
      "displayName": "Tables",
      "type": "Tables",
      "hasSubElements": true,
      "state": "Available",
      "lastSyncDateTime": "2025-06-15T10:30:00Z"
    }
  ],
  "continuationToken": null,
  "continuationUri": null
}

Definizioni

Nome	Descrizione
DataSourceElement	Elemento dello schema dell'origine dati.
DataSourceElements	Elenco impaginato degli elementi dello schema dell'origine dati.
ElementState	Indica la disponibilità corrente dell'elemento nello schema dell'origine dati. È possibile aggiungere altri tipi ElementState nel tempo.
ElementType	Tipo pubblico di un elemento dello schema dell'origine dati. È possibile aggiungere altri tipi ElementType nel tempo.
ErrorRelatedResource	Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
IndexState	Stato dell'indice per le directory dei file lakehouse. È possibile aggiungere altri tipi IndexState nel tempo.

DataSourceElement

Oggetto

Elemento dello schema dell'origine dati.

Nome	Tipo	Descrizione
dataType	string	Tipo di dati per le colonne (ad esempio, int, string). Presente solo per gli elementi della colonna.
description	string	Descrizione dell'elemento impostata dall'utente.
displayName	string	Nome leggibile dell'elemento.
hasSubElements	boolean	Indica se l'elemento include elementi figlio da analizzare.
id	string	Identificatore dell'elemento. Usare come rootId per eseguire il drill-down nell'albero dello schema.
indexState	IndexState	Stato dell'indice per le directory dei file lakehouse.
isSelected	boolean	Indica se questo elemento è selezionato per l'uso da parte di DataAgent.
lastSyncDateTime	string	L'ultima volta che questo elemento è stato sincronizzato dallo schema dell'origine dati, come timestamp ISO 8601 (ad esempio, 2025-06-15T10:30:00Z).
state	ElementState	Indica se l'elemento esiste nello schema attivo.
type	ElementType	Tipo di elemento dello schema.

DataSourceElements

Oggetto

Elenco impaginato degli elementi dello schema dell'origine dati.

Nome	Tipo	Descrizione
continuationToken	string	Token per il batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
continuationUri	string	URI del batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
value	DataSourceElement[]	Elenco di elementi dello schema.

ElementState

Enumerazione

Indica la disponibilità corrente dell'elemento nello schema dell'origine dati. È possibile aggiungere altri tipi ElementState nel tempo.

Valore	Descrizione
Available	L'elemento è disponibile nello schema dell'origine dati.
NotAvailable	L'elemento è stato configurato in precedenza, ma non è più disponibile nello schema dell'origine dati.
AccessDenied	Impossibile leggere lo schema dell'origine dati perché l'accesso è stato negato.
AccessDeniedOap	Impossibile leggere lo schema dell'origine dati perché l'accesso è bloccato da criteri di accesso dell'organizzazione.
DatasourceNotFound	Impossibile trovare l'origine dati.
SchemaUnavailable	Lo schema dell'origine dati non è attualmente disponibile.

ElementType

Enumerazione

Tipo pubblico di un elemento dello schema dell'origine dati. È possibile aggiungere altri tipi ElementType nel tempo.

Valore	Descrizione
Root	Elemento radice di un albero dello schema dell'origine dati.
Files	Elemento contenitore di file.
Directory	Elemento della directory.
Schemas	Contenitore di raggruppamento per gli elementi dello schema.
Tables	Contenitore di raggruppamento per gli elementi della tabella.
Views	Contenitore di raggruppamento per gli elementi di visualizzazione.
Functions	Contenitore di raggruppamento per gli elementi della funzione.
ScalarFunctions	Contenitore di raggruppamento per gli elementi della funzione scalari.
TableValuedFunctions	Contenitore di raggruppamento per gli elementi di funzione con valori di tabella.
Shortcuts	Contenitore di raggruppamento per gli elementi di scelta rapida.
MaterializedViews	Contenitore di raggruppamento per gli elementi di visualizzazione materializzati.
Schema	Elemento dello schema.
Table	Elemento table.
ExternalTable	Elemento di tabella esterno.
MaterializedView	Elemento di visualizzazione materializzato.
View	Elemento di visualizzazione.
Column	Elemento column.
Measure	Elemento measure.
Function	Elemento della funzione.
FunctionParameter	Elemento del parametro della funzione.
FunctionReturnValue	Elemento value restituito dalla funzione.
NodeType	Elemento del tipo di nodo del grafo.
EdgeType	Elemento del tipo di bordo del grafo.
Entity	Elemento dell'entità ontologia.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo 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.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
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.

IndexState

Enumerazione

Stato dell'indice per le directory dei file lakehouse. È possibile aggiungere altri tipi IndexState nel tempo.

Valore	Descrizione
Indexed	La directory è stata indicizzata per la ricerca non strutturata.
Indexing	La directory è attualmente in fase di indicizzazione.
NotIndexed	Directory non indicizzata.