Items - Discover Dataflow Parameters

Serviço:: Dataflow

Versão da API:: v1

Recupera todos os parâmetros definidos no fluxo de dados 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 com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Support
Utilizador	Yes
Entidade de serviço e identidades gerenciadas	Yes

Interfase

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 de URI

Nome	Em	Obrigatório	Tipo	Description
dataflowId	path	True	string (uuid)	A ID do fluxo de dados.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.
continuationToken	query		string	Um token para recuperar a próxima página de resultados.

Respostas

Nome	Tipo	Description
200 OK	DataflowParameters	Solicitação concluída com êxito.
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

Nome

Tipo

Description

200 OK

DataflowParameters

Solicitação concluída com êxito.

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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	Description
DataflowBooleanParameter	Um parâmetro de fluxo de dados do tipo Boolean.
DataflowDateParameter	Um parâmetro de fluxo de dados do tipo Date. Cadeia de caracteres no formato `yyyy-MM-dd` (exemplo: `2025-09-15` para a data 15 de set de 2025). Use o tipo "Automático" para substituir esse tipo de parâmetro ao executar o fluxo de dados.
DataflowDateTimeParameter	Um parâmetro de fluxo de dados do tipo DateTime. Cadeia de caracteres no formato `yyyy-MM-ddTHH:mm:ss.xxxZ` (exemplo: `2025-09-15T21:45:00.000Z`).
DataflowDateTimeZoneParameter	Um parâmetro de fluxo de dados do tipo DateTimeZone. Cadeia de caracteres 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 de fluxo de dados do tipo Duração. Cadeia de caracteres 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 de fluxo de dados do tipo Long.
DataflowNumberParameter	Um parâmetro de fluxo de dados do tipo duplo.
DataflowParameters	Uma lista de parâmetros de fluxo de dados.
DataflowStringParameter	Um parâmetro de fluxo de dados do tipo Cadeia de caracteres.
DataflowTimeParameter	Um parâmetro de fluxo de dados do tipo Time. Cadeia de caracteres no formato `HH:mm:ss` (exemplo: `21:45:00` para 21h45). 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

Objeto

Um parâmetro de fluxo de dados do tipo Boolean.

Nome	Tipo	Description
defaultValue	boolean	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: Boolean	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowDateParameter

Objeto

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

Nome	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: Date	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowDateTimeParameter

Objeto

Um parâmetro de fluxo de dados do tipo DateTime. Cadeia de caracteres no formato yyyy-MM-ddTHH:mm:ss.xxxZ (exemplo: 2025-09-15T21:45:00.000Z).

Nome	Tipo	Description
defaultValue	string (date-time)	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: DateTime	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowDateTimeZoneParameter

Objeto

Um parâmetro de fluxo de dados do tipo DateTimeZone. Cadeia de caracteres 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.

Nome	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: DateTimeZone	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowDurationParameter

Objeto

Um parâmetro de fluxo de dados do tipo Duração. Cadeia de caracteres 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.

Nome	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: Duration	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowIntegerParameter

Objeto

Um parâmetro de fluxo de dados do tipo Long.

Nome	Tipo	Description
defaultValue	integer (int64)	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: Integer	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowNumberParameter

Objeto

Um parâmetro de fluxo de dados do tipo duplo.

Nome	Tipo	Description
defaultValue	number (double)	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: Number	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

DataflowParameters

Objeto

Uma lista de parâmetros de fluxo de dados.

Nome	Tipo	Description
continuationToken	string	O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote do 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

Objeto

Um parâmetro de fluxo de dados do tipo Cadeia de caracteres.

Nome	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

Objeto

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

Nome	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: Time	O tipo do parâmetro. Tipos de tipo adicionais podem ser adicionados ao longo do tempo.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

Compartilhar via

Items - Discover Dataflow Parameters

Permissions

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Respostas

Exemplos

Get Dataflow Parameters example

Solicitação de exemplo

Resposta de exemplo

Definições

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails