Items - Discover Dataflow Parameters

Service:: Dataflow

Version d'API:: v1

Récupère tous les paramètres définis dans le dataflow spécifié.

Permissions

L’appelant doit disposer d’autorisations de lecture pour le flux de données.

Étendues déléguées requises

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

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Support
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dataflowId	path	True	string (uuid)	ID de dataflow.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
continuationToken	query		string	Jeton permettant de récupérer la page suivante des résultats.

Réponses

Nom	Type	Description
200 OK	DataflowParameters	La demande s’est terminée avec succès.
Other Status Codes	ErrorResponse	Codes d’erreur courants : ItemNotFound - L’élément demandé n’a pas été trouvé DataflowNotParametricError - Le flux de données demandé n’est pas paramétrique

Nom

Type

Description

200 OK

DataflowParameters

La demande s’est terminée avec succès.

Other Status Codes

ErrorResponse

Codes d’erreur courants :

ItemNotFound - L’élément demandé n’a pas été trouvé
DataflowNotParametricError - Le flux de données demandé n’est pas paramétrique

Exemples

Get Dataflow Parameters example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
DataflowBooleanParameter	Paramètre de flux de données de type Boolean.
DataflowDateParameter	Paramètre Dataflow de type Date. Chaîne au format `yyyy-MM-dd` (exemple : `2025-09-15` pour la date du 15 septembre 2025). Utilisez le type « Automatic » pour remplacer ce type de paramètre lors de l’exécution du flux de données.
DataflowDateTimeParameter	Paramètre Dataflow de type DateTime. Chaîne au format `yyyy-MM-ddTHH:mm:ss.xxxZ` (Exemple : `2025-09-15T21:45:00.000Z`).
DataflowDateTimeZoneParameter	Paramètre Dataflow de type DateTimeZone. Chaîne au format `yyyy-MM-ddTHH:mm:sszzz` (Exemple : `2025-09-15T21:45:00+02:00`). Utilisez le type « Automatic » pour remplacer ce type de paramètre lors de l’exécution du flux de données.
DataflowDurationParameter	Paramètre Dataflow de type Duration. Chaîne au format `\Pd\DTH\Hm\Ms\S` (Exemple : `P5DT14H35M30S` pendant 5 jours, 14 heures, 35 minutes et 30 secondes). Utilisez le type « Automatic » pour remplacer ce type de paramètre lors de l’exécution du flux de données.
DataflowIntegerParameter	Paramètre Dataflow de type Long.
DataflowNumberParameter	Paramètre dataflow de type double.
DataflowParameters	Liste des paramètres de dataflow.
DataflowStringParameter	Paramètre dataflow de type String.
DataflowTimeParameter	Paramètre Dataflow de type Time. Chaîne au format `HH:mm:ss` (exemple : `21:45:00` pour 19h45). Utilisez le type « Automatic » pour remplacer ce type de paramètre lors de l’exécution du flux de données.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.

DataflowBooleanParameter

Object

Paramètre de flux de données de type Boolean.

Nom	Type	Description
defaultValue	boolean	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données.
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: Boolean	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

DataflowDateParameter

Object

Paramètre Dataflow de type Date. Chaîne au format yyyy-MM-dd (exemple : 2025-09-15 pour la date du 15 septembre 2025). Utilisez le type « Automatic » pour remplacer ce type de paramètre lors de l’exécution du flux de données.

Nom	Type	Description
defaultValue	string	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données.
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: Date	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

DataflowDateTimeParameter

Object

Paramètre Dataflow de type DateTime. Chaîne au format yyyy-MM-ddTHH:mm:ss.xxxZ (Exemple : 2025-09-15T21:45:00.000Z).

Nom	Type	Description
defaultValue	string (date-time)	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données.
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: DateTime	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

DataflowDateTimeZoneParameter

Object

Paramètre Dataflow de type DateTimeZone. Chaîne au format yyyy-MM-ddTHH:mm:sszzz (Exemple : 2025-09-15T21:45:00+02:00). Utilisez le type « Automatic » pour remplacer ce type de paramètre lors de l’exécution du flux de données.

Nom	Type	Description
defaultValue	string	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données.
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: DateTimeZone	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

DataflowDurationParameter

Object

Paramètre Dataflow de type Duration. Chaîne au format \Pd\DTH\Hm\Ms\S (Exemple : P5DT14H35M30S pendant 5 jours, 14 heures, 35 minutes et 30 secondes). Utilisez le type « Automatic » pour remplacer ce type de paramètre lors de l’exécution du flux de données.

Nom	Type	Description
defaultValue	string	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données.
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: Duration	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

DataflowIntegerParameter

Object

Paramètre Dataflow de type Long.

Nom	Type	Description
defaultValue	integer (int64)	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données.
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: Integer	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

DataflowNumberParameter

Object

Paramètre dataflow de type double.

Nom	Type	Description
defaultValue	number (double)	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données.
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: Number	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

DataflowParameters

Object

Liste des paramètres de dataflow.

Nom	Type	Description
continuationToken	string	Jeton du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
continuationUri	string	URI du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	Liste des paramètres définis dans le dataflow.

DataflowStringParameter

Object

Paramètre dataflow de type String.

Nom	Type	Description
defaultValue	string	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données .
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: String	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

DataflowTimeParameter

Object

Paramètre Dataflow de type Time. Chaîne au format HH:mm:ss (exemple : 21:45:00 pour 19h45). Utilisez le type « Automatic » pour remplacer ce type de paramètre lors de l’exécution du flux de données.

Nom	Type	Description
defaultValue	string	Valeur avec laquelle le paramètre sera actualisé si aucun n’est fourni lors de l’exécution du flux de données.
description	string	Description du paramètre.
isRequired	boolean	Indique si le paramètre est requis.
name	string	Nom du paramètre.
type	string: Time	Type du paramètre. Des types de type supplémentaires peuvent être ajoutés au fil du temps.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

Partager via

Items - Discover Dataflow Parameters

Permissions

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

Get Dataflow Parameters example

Exemple de requête

Exemple de réponse

Définitions

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails