Partilhar via

Items - Get Dataflow Definition

Serviço:
Dataflow
Versão da API:
v1

Retorna a definição pública de fluxo de dados especificada.
Esta API suporta operações de longa duração (LRO).

Quando você obtém a definição pública de um fluxo de dados, o rótulo de sensibilidade não faz parte da definição.

Permissões

O chamador deve ter permissões de leitura e gravação para o fluxo de dados.

Escopos delegados necessários

Dataflow.ReadWrite.All ou Item.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades geridas Sim

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/getDefinition

Parâmetros do URI

Name Em Necessário Tipo Description
dataflowId
 path True

string (uuid)

O ID do fluxo de dados.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Respostas

Name Tipo Description
200 OK

DataflowDefinitionResponse

Pedido concluído com sucesso.
202 Accepted

Pedido aceite. Está em curso a recuperação da definição.

Cabeçalhos

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • OperationNotSupportedForItem - Operação não suportada para o item solicitado.

Exemplos

Get a Dataflow public definition example

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "definition": {
    "parts": [
      {
        "path": "queryMetadata.json",
        "payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "mashup.pq",
        "payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Código de estado:
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

Definições

Name Description
DataflowDefinition

Objeto de definição pública de fluxo de dados. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de fluxo de dados.
DataflowDefinitionPart

Objeto de parte de definição de fluxo de dados.
DataflowDefinitionResponse

Resposta de definição pública de fluxo de dados.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
PayloadType

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

DataflowDefinition

Object

Objeto de definição pública de fluxo de dados. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de fluxo de dados.

Name Tipo Description
parts

DataflowDefinitionPart[]

Uma lista de partes de definição.

DataflowDefinitionPart

Object

Objeto de parte de definição de fluxo de dados.

Name Tipo Description
path

string

O caminho da parte de definição pública do fluxo de dados.
payload

string

A carga útil parcial da definição pública do Dataflow.
payloadType

PayloadType

O tipo de carga útil.

DataflowDefinitionResponse

Object

Resposta de definição pública de fluxo de dados.

Name Tipo Description
definition

DataflowDefinition

Objeto de definição pública de fluxo de dados. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de fluxo de dados.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor Description
InlineBase64

Base em linha 64.