Items - Discover Dataflow Parameters

Servicio:: Dataflow

Versión de la API:: v1

Recupera todos los parámetros definidos en el flujo de datos especificado.

Permissions

El autor de la llamada debe tener permisos de lectura para el flujo de datos.

Ámbitos delegados necesarios

Dataflow.Read.All o Dataflow.ReadWrite.All o Item.Read.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad	Support
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interfaz

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dataflowId	path	True	string (uuid)	Identificador de flujo de datos.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
continuationToken	query		string	Token para recuperar la siguiente página de resultados.

Respuestas

Nombre	Tipo	Description
200 OK	DataflowParameters	Solicitud completada correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: ItemNotFound: no se encontró el elemento solicitado. DataflowNotParametricError: el flujo de datos solicitado no es paramétrico

Nombre

Tipo

Description

200 OK

DataflowParameters

Solicitud completada correctamente.

Other Status Codes

ErrorResponse

Códigos de error comunes:

ItemNotFound: no se encontró el elemento solicitado.
DataflowNotParametricError: el flujo de datos solicitado no es paramétrico

Ejemplos

Get Dataflow Parameters example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
    }
  ]
}

Definiciones

Nombre	Description
DataflowBooleanParameter	Parámetro de flujo de datos de tipo Boolean.
DataflowDateParameter	Parámetro de flujo de datos de tipo Date. Cadena con el formato `yyyy-MM-dd` (ejemplo: `2025-09-15` para la fecha 15 de septiembre de 2025). Use el tipo "Automático" para invalidar este tipo de parámetro al ejecutar el flujo de datos.
DataflowDateTimeParameter	Parámetro dataflow de tipo DateTime. Cadena con el formato `yyyy-MM-ddTHH:mm:ss.xxxZ` (ejemplo: `2025-09-15T21:45:00.000Z`).
DataflowDateTimeZoneParameter	Parámetro de flujo de datos de tipo DateTimeZone. Cadena con el formato `yyyy-MM-ddTHH:mm:sszzz` (ejemplo: `2025-09-15T21:45:00+02:00`). Use el tipo "Automático" para invalidar este tipo de parámetro al ejecutar el flujo de datos.
DataflowDurationParameter	Parámetro de flujo de datos de tipo Duration. Cadena con el formato `\Pd\DTH\Hm\Ms\S` (ejemplo: `P5DT14H35M30S` durante 5 días, 14 horas, 35 minutos y 30 segundos). Use el tipo "Automático" para invalidar este tipo de parámetro al ejecutar el flujo de datos.
DataflowIntegerParameter	Parámetro de flujo de datos de tipo Long.
DataflowNumberParameter	Parámetro de flujo de datos de tipo double.
DataflowParameters	Lista de parámetros de flujo de datos.
DataflowStringParameter	Parámetro de flujo de datos de tipo String.
DataflowTimeParameter	Parámetro de flujo de datos de tipo Time. Cadena con el formato `HH:mm:ss` (ejemplo: `21:45:00` para las 9:45 p. m.). Use el tipo "Automático" para invalidar este tipo de parámetro al ejecutar el flujo de datos.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.

DataflowBooleanParameter

Object

Parámetro de flujo de datos de tipo Boolean.

Nombre	Tipo	Description
defaultValue	boolean	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos.
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: Boolean	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

DataflowDateParameter

Object

Parámetro de flujo de datos de tipo Date. Cadena con el formato yyyy-MM-dd (ejemplo: 2025-09-15 para la fecha 15 de septiembre de 2025). Use el tipo "Automático" para invalidar este tipo de parámetro al ejecutar el flujo de datos.

Nombre	Tipo	Description
defaultValue	string	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos.
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: Date	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

DataflowDateTimeParameter

Object

Parámetro dataflow de tipo DateTime. Cadena con el formato yyyy-MM-ddTHH:mm:ss.xxxZ (ejemplo: 2025-09-15T21:45:00.000Z).

Nombre	Tipo	Description
defaultValue	string (date-time)	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos.
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: DateTime	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

DataflowDateTimeZoneParameter

Object

Parámetro de flujo de datos de tipo DateTimeZone. Cadena con el formato yyyy-MM-ddTHH:mm:sszzz (ejemplo: 2025-09-15T21:45:00+02:00). Use el tipo "Automático" para invalidar este tipo de parámetro al ejecutar el flujo de datos.

Nombre	Tipo	Description
defaultValue	string	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos.
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: DateTimeZone	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

DataflowDurationParameter

Object

Parámetro de flujo de datos de tipo Duration. Cadena con el formato \Pd\DTH\Hm\Ms\S (ejemplo: P5DT14H35M30S durante 5 días, 14 horas, 35 minutos y 30 segundos). Use el tipo "Automático" para invalidar este tipo de parámetro al ejecutar el flujo de datos.

Nombre	Tipo	Description
defaultValue	string	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos.
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: Duration	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

DataflowIntegerParameter

Object

Parámetro de flujo de datos de tipo Long.

Nombre	Tipo	Description
defaultValue	integer (int64)	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos.
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: Integer	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

DataflowNumberParameter

Object

Parámetro de flujo de datos de tipo double.

Nombre	Tipo	Description
defaultValue	number (double)	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos.
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: Number	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

DataflowParameters

Object

Lista de parámetros de flujo de datos.

Nombre	Tipo	Description
continuationToken	string	Token del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
continuationUri	string	Identificador URI del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	Lista de parámetros definidos en el flujo de datos.

DataflowStringParameter

Object

Parámetro de flujo de datos de tipo String.

Nombre	Tipo	Description
defaultValue	string	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos .
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: String	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

DataflowTimeParameter

Object

Parámetro de flujo de datos de tipo Time. Cadena con el formato HH:mm:ss (ejemplo: 21:45:00 para las 9:45 p. m.). Use el tipo "Automático" para invalidar este tipo de parámetro al ejecutar el flujo de datos.

Nombre	Tipo	Description
defaultValue	string	Valor con el que se actualizará el parámetro si no se proporciona ninguno al ejecutar el flujo de datos.
description	string	Una descripción del parámetro.
isRequired	boolean	Indica si el parámetro es necesario.
name	string	Nombre del parámetro.
type	string: Time	Tipo del parámetro. Se pueden agregar tipos de tipo adicionales a lo largo del tiempo.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

Compartir a través de

Items - Discover Dataflow Parameters

Permissions

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Respuestas

Ejemplos

Get Dataflow Parameters example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails