Items - Discover Dataflow Parameters

Serviço:: Dataflow

Versão da API:: v1

Recupera todos os parâmetros definidos no Dataflow especificado.

Permissions

O chamador deve ter permissões de leitura para o fluxo de dados.

Escopos delegados necessários

Dataflow.Read.All ou Dataflow.ReadWrite.All ou Item.Read.All ou Item.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

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

Identidade	Support
User	Yes
Entidade de serviço e identidades geridas	Yes

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/parameters

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/parameters?continuationToken={continuationToken}

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.
continuationToken	query		string	Um token para recuperar a próxima página de resultados.

Respostas

Name	Tipo	Description
200 OK	DataflowParameters	Pedido concluído com sucesso.
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - O item solicitado não foi encontrado DataflowNotParametricError - O fluxo de dados solicitado não é paramétrico

Name

Tipo

Description

200 OK

DataflowParameters

Pedido concluído com sucesso.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

ItemNotFound - O item solicitado não foi encontrado
DataflowNotParametricError - O fluxo de dados solicitado não é paramétrico

Exemplos

Get Dataflow Parameters example

Pedido de amostra

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/parameters

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "name": "manufacturer",
      "isRequired": true,
      "description": "Manufacturer of the item",
      "type": "String",
      "defaultValue": "test-value"
    },
    {
      "name": "isImported",
      "isRequired": false,
      "description": "Is the item imported",
      "type": "Boolean",
      "defaultValue": true
    },
    {
      "name": "quantity",
      "isRequired": false,
      "description": "Quantity of item",
      "type": "Integer",
      "defaultValue": 123456789
    },
    {
      "name": "weightThreshold",
      "isRequired": true,
      "description": "Weight threshold for item",
      "type": "Number",
      "defaultValue": 3.14
    },
    {
      "name": "datetimeOfOrder",
      "isRequired": true,
      "description": "Datetime of order",
      "type": "DateTime",
      "defaultValue": "2025-09-15T21:45:00.000Z"
    },
    {
      "name": "datetimeZoneOfOrder",
      "isRequired": true,
      "description": "DatetimeZone of order",
      "type": "DateTimeZone",
      "defaultValue": "2025-09-15T21:45:00+02:00"
    },
    {
      "name": "dateOfImport",
      "isRequired": true,
      "description": "Date of import",
      "type": "Date",
      "defaultValue": "2025-09-15"
    },
    {
      "name": "timeOfImport",
      "isRequired": true,
      "description": "Time of import",
      "type": "Time",
      "defaultValue": "21:45:00"
    },
    {
      "name": "durationOfImport",
      "isRequired": true,
      "description": "Duration of import",
      "type": "Duration",
      "defaultValue": "P5DT21H35M30S"
    }
  ]
}

Definições

Name	Description
DataflowBooleanParameter	Um parâmetro Dataflow do tipo Boolean.
DataflowDateParameter	Um parâmetro Dataflow do tipo Date. String no formato `yyyy-MM-dd` (Exemplo: `2025-09-15` para a data 15 de setembro de 2025). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o fluxo de dados.
DataflowDateTimeParameter	Um parâmetro Dataflow do tipo DateTime. String no formato `yyyy-MM-ddTHH:mm:ss.xxxZ` (Exemplo: `2025-09-15T21:45:00.000Z`).
DataflowDateTimeZoneParameter	Um parâmetro Dataflow do tipo DateTimeZone. String no formato `yyyy-MM-ddTHH:mm:sszzz` (Exemplo: `2025-09-15T21:45:00+02:00`). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o fluxo de dados.
DataflowDurationParameter	Um parâmetro Dataflow do tipo Duration. String no formato `\Pd\DTH\Hm\Ms\S` (Exemplo: `P5DT14H35M30S` por 5 dias, 14 horas, 35 minutos e 30 segundos). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o fluxo de dados.
DataflowIntegerParameter	Um parâmetro Dataflow do tipo Long.
DataflowNumberParameter	Um parâmetro Dataflow do tipo double.
DataflowParameters	Uma lista de parâmetros de fluxo de dados.
DataflowStringParameter	Um parâmetro Dataflow do tipo String.
DataflowTimeParameter	Um parâmetro Dataflow do tipo Time. String no formato `HH:mm:ss` (Exemplo: `21:45:00` para 21:45). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o 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.

DataflowBooleanParameter

Object

Um parâmetro Dataflow do tipo Boolean.

Name	Tipo	Description
defaultValue	boolean	O valor com o qual o parâmetro será atualizado se nenhum for fornecido durante a execução do fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: Boolean	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowDateParameter

Object

Um parâmetro Dataflow do tipo Date. String no formato yyyy-MM-dd (Exemplo: 2025-09-15 para a data 15 de setembro de 2025). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o fluxo de dados.

Name	Tipo	Description
defaultValue	string	O valor com o qual o parâmetro será atualizado se nenhum for fornecido durante a execução do fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: Date	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowDateTimeParameter

Object

Um parâmetro Dataflow do tipo DateTime. String no formato yyyy-MM-ddTHH:mm:ss.xxxZ (Exemplo: 2025-09-15T21:45:00.000Z).

Name	Tipo	Description
defaultValue	string (date-time)	O valor com o qual o parâmetro será atualizado se nenhum for fornecido durante a execução do fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: DateTime	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowDateTimeZoneParameter

Object

Um parâmetro Dataflow do tipo DateTimeZone. String no formato yyyy-MM-ddTHH:mm:sszzz (Exemplo: 2025-09-15T21:45:00+02:00). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o fluxo de dados.

Name	Tipo	Description
defaultValue	string	O valor com o qual o parâmetro será atualizado se nenhum for fornecido durante a execução do fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: DateTimeZone	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowDurationParameter

Object

Um parâmetro Dataflow do tipo Duration. String no formato \Pd\DTH\Hm\Ms\S (Exemplo: P5DT14H35M30S por 5 dias, 14 horas, 35 minutos e 30 segundos). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o fluxo de dados.

Name	Tipo	Description
defaultValue	string	O valor com o qual o parâmetro será atualizado se nenhum for fornecido durante a execução do fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: Duration	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowIntegerParameter

Object

Um parâmetro Dataflow do tipo Long.

Name	Tipo	Description
defaultValue	integer (int64)	O valor com o qual o parâmetro será atualizado se nenhum for fornecido durante a execução do fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: Integer	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowNumberParameter

Object

Um parâmetro Dataflow do tipo double.

Name	Tipo	Description
defaultValue	number (double)	O valor com o qual o parâmetro será atualizado se nenhum for fornecido durante a execução do fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: Number	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowParameters

Object

Uma lista de parâmetros de fluxo de dados.

Name	Tipo	Description
continuationToken	string	O token para o próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	Uma lista de parâmetros definidos no fluxo de dados.

DataflowStringParameter

Object

Um parâmetro Dataflow do tipo String.

Name	Tipo	Description
defaultValue	string	O valor com o qual o parâmetro será atualizado se nenhum for fornecido ao executar o fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: String	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowTimeParameter

Object

Um parâmetro Dataflow do tipo Time. String no formato HH:mm:ss (Exemplo: 21:45:00 para 21:45). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o fluxo de dados.

Name	Tipo	Description
defaultValue	string	O valor com o qual o parâmetro será atualizado se nenhum for fornecido durante a execução do fluxo de dados.
description	string	Uma descrição do parâmetro.
isRequired	boolean	Indica se o parâmetro é necessário.
name	string	O nome do parâmetro.
type	string: Time	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

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.

Partilhar via

Items - Discover Dataflow Parameters

Permissions

Escopos delegados necessários

Identidades suportadas pelo Entra da Microsoft

Interfaz

Parâmetros do URI

Respostas

Exemplos

Get Dataflow Parameters example

Pedido de amostra

Resposta da amostra

Definições

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails