Items - Discover Dataflow Parameters

Service:: Dataflow

API Version:: v1

Retrieves all parameters defined in the specified Dataflow.

Permissions

The caller must have read permissions for the dataflow.

Required Delegated Scopes

Dataflow.Read.All or Dataflow.ReadWrite.All or Item.Read.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
dataflowId	path	True	string (uuid)	The Dataflow ID.
workspaceId	path	True	string (uuid)	The workspace ID.
continuationToken	query		string	A token for retrieving the next page of results.

Responses

Name	Type	Description
200 OK	DataflowParameters	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found DataflowNotParametricError - The requested dataflow is not parametric

Name

Type

Description

200 OK

DataflowParameters

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

ItemNotFound - The requested item was not found
DataflowNotParametricError - The requested dataflow is not parametric

Examples

Get Dataflow Parameters example

Sample request

HTTP

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

Sample response

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"
    }
  ]
}

Definitions

Name	Description
DataflowBooleanParameter	A Dataflow parameter of type Boolean.
DataflowDateParameter	A Dataflow parameter of type Date. String in the format `yyyy-MM-dd` (Example: `2025-09-15` for the date Sep 15, 2025). Use "Automatic" type to override this type of parameter when executing the dataflow.
DataflowDateTimeParameter	A Dataflow parameter of type DateTime. String in the format `yyyy-MM-ddTHH:mm:ss.xxxZ` (Example: `2025-09-15T21:45:00.000Z`).
DataflowDateTimeZoneParameter	A Dataflow parameter of type DateTimeZone. String in the format `yyyy-MM-ddTHH:mm:sszzz` (Example: `2025-09-15T21:45:00+02:00`). Use "Automatic" type to override this type of parameter when executing the dataflow.
DataflowDurationParameter	A Dataflow parameter of type Duration. String in the format `\Pd\DTH\Hm\Ms\S` (Example: `P5DT14H35M30S` for 5 days, 14 hours, 35 minutes and 30 seconds). Use "Automatic" type to override this type of parameter when executing the dataflow.
DataflowIntegerParameter	A Dataflow parameter of type Long.
DataflowNumberParameter	A Dataflow parameter of type double.
DataflowParameters	A list of Dataflow parameters.
DataflowStringParameter	A Dataflow parameter of type String.
DataflowTimeParameter	A Dataflow parameter of type Time. String in the format `HH:mm:ss` (Example: `21:45:00` for 9:45 PM). Use "Automatic" type to override this type of parameter when executing the dataflow.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

DataflowBooleanParameter

Object

A Dataflow parameter of type Boolean.

Name	Type	Description
defaultValue	boolean	The value with which the parameter will be refreshed if none is provided when executing the dataflow.
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: Boolean	The type of the parameter. Additional type types may be added over time.

DataflowDateParameter

Object

A Dataflow parameter of type Date. String in the format yyyy-MM-dd (Example: 2025-09-15 for the date Sep 15, 2025). Use "Automatic" type to override this type of parameter when executing the dataflow.

Name	Type	Description
defaultValue	string	The value with which the parameter will be refreshed if none is provided when executing the dataflow.
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: Date	The type of the parameter. Additional type types may be added over time.

DataflowDateTimeParameter

Object

A Dataflow parameter of type DateTime. String in the format yyyy-MM-ddTHH:mm:ss.xxxZ (Example: 2025-09-15T21:45:00.000Z).

Name	Type	Description
defaultValue	string (date-time)	The value with which the parameter will be refreshed if none is provided when executing the dataflow.
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: DateTime	The type of the parameter. Additional type types may be added over time.

DataflowDateTimeZoneParameter

Object

A Dataflow parameter of type DateTimeZone. String in the format yyyy-MM-ddTHH:mm:sszzz (Example: 2025-09-15T21:45:00+02:00). Use "Automatic" type to override this type of parameter when executing the dataflow.

Name	Type	Description
defaultValue	string	The value with which the parameter will be refreshed if none is provided when executing the dataflow.
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: DateTimeZone	The type of the parameter. Additional type types may be added over time.

DataflowDurationParameter

Object

A Dataflow parameter of type Duration. String in the format \Pd\DTH\Hm\Ms\S (Example: P5DT14H35M30S for 5 days, 14 hours, 35 minutes and 30 seconds). Use "Automatic" type to override this type of parameter when executing the dataflow.

Name	Type	Description
defaultValue	string	The value with which the parameter will be refreshed if none is provided when executing the dataflow.
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: Duration	The type of the parameter. Additional type types may be added over time.

DataflowIntegerParameter

Object

A Dataflow parameter of type Long.

Name	Type	Description
defaultValue	integer (int64)	The value with which the parameter will be refreshed if none is provided when executing the dataflow.
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: Integer	The type of the parameter. Additional type types may be added over time.

DataflowNumberParameter

Object

A Dataflow parameter of type double.

Name	Type	Description
defaultValue	number (double)	The value with which the parameter will be refreshed if none is provided when executing the dataflow.
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: Number	The type of the parameter. Additional type types may be added over time.

DataflowParameters

Object

A list of Dataflow parameters.

Name	Type	Description
continuationToken	string	The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri	string	The URI of the next result set batch. If there are no more records, it's removed from the response.
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	A list of parameters defined in the Dataflow.

DataflowStringParameter

Object

A Dataflow parameter of type String.

Name	Type	Description
defaultValue	string	The value with which the parameter will be refreshed if none is provided when executing the dataflow .
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: String	The type of the parameter. Additional type types may be added over time.

DataflowTimeParameter

Object

A Dataflow parameter of type Time. String in the format HH:mm:ss (Example: 21:45:00 for 9:45 PM). Use "Automatic" type to override this type of parameter when executing the dataflow.

Name	Type	Description
defaultValue	string	The value with which the parameter will be refreshed if none is provided when executing the dataflow.
description	string	A description of the parameter.
isRequired	boolean	Indicates whether the parameter is required.
name	string	The name of the parameter.
type	string: Time	The type of the parameter. Additional type types may be added over time.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

Share via

Items - Discover Dataflow Parameters

Permissions

Required Delegated Scopes

Microsoft Entra supported identities

Interface

URI Parameters

Responses

Examples

Get Dataflow Parameters example

Sample request

Sample response

Definitions

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails