Items - Get Dataflow Definition

Servizio:: Dataflow

Versione API:: v1

Restituisce la definizione pubblica del flusso di dati specificata.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Quando si ottiene la definizione pubblica di un flusso di dati, l'etichetta di riservatezza non fa parte della definizione.

Autorizzazioni

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

Ambiti delegati obbligatori

Dataflow.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}/dataflows/{dataflowId}/getDefinition

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
dataflowId	path	True	string (uuid)	ID flusso di dati.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.

Risposte

Nome	Tipo	Descrizione
200 OK	DataflowDefinitionResponse	Richiesta completata correttamente.
202 Accepted		Richiesta accettata. Il recupero della definizione è 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 l'elemento richiesto.

Esempio

Get a Dataflow public definition example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "definition": {
    "parts": [
      {
        "path": "queryMetadata.json",
        "payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "mashup.pq",
        "payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Codice di stato:: 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

Definizioni

Nome	Descrizione
DataflowDefinition	Oggetto definizione pubblica del flusso di dati. Per altre informazioni su come creare una definizione pubblica del flusso di dati, vedere questo articolo .
DataflowDefinitionPart	Oggetto parte della definizione del flusso di dati.
DataflowDefinitionResponse	Risposta alla definizione pubblica del flusso di dati.
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.

DataflowDefinition

Oggetto

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

Nome	Tipo	Descrizione
parts	DataflowDefinitionPart[]	Elenco di parti di definizione.

DataflowDefinitionPart

Oggetto

Oggetto parte della definizione del flusso di dati.

Nome	Tipo	Descrizione
path	string	Percorso della parte definizione pubblica flusso di dati.
payload	string	Payload della parte di definizione pubblica del flusso di dati.
payloadType	PayloadType	Tipo di payload.

DataflowDefinitionResponse

Oggetto

Risposta alla definizione pubblica del flusso di dati.

Nome	Tipo	Descrizione
definition	DataflowDefinition	Oggetto definizione pubblica del flusso di dati. Per altre informazioni su come creare una definizione pubblica del flusso di dati, vedere questo articolo .

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.

Condividi tramite

Items - Get Dataflow Definition

Autorizzazioni

Ambiti delegati obbligatori

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Risposte

Esempio

Get a Dataflow public definition example

Esempio di richiesta

Risposta di esempio

Definizioni

DataflowDefinition

DataflowDefinitionPart

DataflowDefinitionResponse

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PayloadType