Items - Discover Dataflow Parameters

Служба:: Dataflow

Версия API:: v1

Извлекает все параметры, определенные в указанном потоке данных.

Permissions

Вызывающий объект должен иметь разрешения на чтение для потока данных.

Обязательные делегированные области

Dataflow.Read.All или Dataflow.ReadWrite.All или Item.Read.All или Item.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Support
User	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
dataflowId	path	True	string (uuid)	Идентификатор потока данных.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
continuationToken	query		string	Маркер получения следующей страницы результатов.

Ответы

Имя Тип Описание

200 OK

Имя	Тип	Описание
200 OK	DataflowParameters	Запрос успешно завершен.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — запрошенный элемент не найден DataflowNotParametricError — запрошенный поток данных не является параметричным

DataflowParameters

Запрос успешно завершен.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

ItemNotFound — запрошенный элемент не найден
DataflowNotParametricError — запрошенный поток данных не является параметричным

Примеры

Get Dataflow Parameters example

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
    }
  ]
}

Определения

Имя	Описание
DataflowBooleanParameter	Параметр потока данных типа Boolean.
DataflowDateParameter	Параметр потока данных типа Date. Строка в формате `yyyy-MM-dd` (пример: `2025-09-15` для даты 15 сентября 2025 г.). Используйте тип Automatic, чтобы переопределить этот тип параметра при выполнении потока данных.
DataflowDateTimeParameter	Параметр потока данных типа DateTime. Строка в формате `yyyy-MM-ddTHH:mm:ss.xxxZ` (пример: `2025-09-15T21:45:00.000Z`).
DataflowDateTimeZoneParameter	Параметр потока данных типа DateTimeZone. Строка в формате `yyyy-MM-ddTHH:mm:sszzz` (пример: `2025-09-15T21:45:00+02:00`). Используйте тип Automatic, чтобы переопределить этот тип параметра при выполнении потока данных.
DataflowDurationParameter	Параметр потока данных типа Duration. Строка в формате `\Pd\DTH\Hm\Ms\S` (например, `P5DT14H35M30S` в течение 5 дней, 14 часов, 35 минут и 30 секунд). Используйте тип Automatic, чтобы переопределить этот тип параметра при выполнении потока данных.
DataflowIntegerParameter	Параметр потока данных типа Long.
DataflowNumberParameter	Параметр потока данных типа double.
DataflowParameters	Список параметров потока данных.
DataflowStringParameter	Параметр потока данных типа String.
DataflowTimeParameter	Параметр потока данных типа Time. Строка в формате `HH:mm:ss` (пример: `21:45:00` для 9:45 вечера). Используйте тип Automatic, чтобы переопределить этот тип параметра при выполнении потока данных.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.

DataflowBooleanParameter

Объект

Параметр потока данных типа Boolean.

Имя	Тип	Описание
defaultValue	boolean	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: Boolean	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

DataflowDateParameter

Объект

Параметр потока данных типа Date. Строка в формате yyyy-MM-dd (пример: 2025-09-15 для даты 15 сентября 2025 г.). Используйте тип Automatic, чтобы переопределить этот тип параметра при выполнении потока данных.

Имя	Тип	Описание
defaultValue	string	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: Date	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

DataflowDateTimeParameter

Объект

Параметр потока данных типа DateTime. Строка в формате yyyy-MM-ddTHH:mm:ss.xxxZ (пример: 2025-09-15T21:45:00.000Z).

Имя	Тип	Описание
defaultValue	string (date-time)	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: DateTime	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

DataflowDateTimeZoneParameter

Объект

Параметр потока данных типа DateTimeZone. Строка в формате yyyy-MM-ddTHH:mm:sszzz (пример: 2025-09-15T21:45:00+02:00). Используйте тип Automatic, чтобы переопределить этот тип параметра при выполнении потока данных.

Имя	Тип	Описание
defaultValue	string	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: DateTimeZone	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

DataflowDurationParameter

Объект

Параметр потока данных типа Duration. Строка в формате \Pd\DTH\Hm\Ms\S (например, P5DT14H35M30S в течение 5 дней, 14 часов, 35 минут и 30 секунд). Используйте тип Automatic, чтобы переопределить этот тип параметра при выполнении потока данных.

Имя	Тип	Описание
defaultValue	string	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: Duration	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

DataflowIntegerParameter

Объект

Параметр потока данных типа Long.

Имя	Тип	Описание
defaultValue	integer (int64)	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: Integer	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

DataflowNumberParameter

Объект

Параметр потока данных типа double.

Имя	Тип	Описание
defaultValue	number (double)	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: Number	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

DataflowParameters

Объект

Список параметров потока данных.

Имя	Тип	Описание
continuationToken	string	Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri	string	Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	Список параметров, определенных в потоке данных.

DataflowStringParameter

Объект

Параметр потока данных типа String.

Имя	Тип	Описание
defaultValue	string	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: String	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

DataflowTimeParameter

Объект

Параметр потока данных типа Time. Строка в формате HH:mm:ss (пример: 21:45:00 для 9:45 вечера). Используйте тип Automatic, чтобы переопределить этот тип параметра при выполнении потока данных.

Имя	Тип	Описание
defaultValue	string	Значение, с помощью которого параметр будет обновлен, если при выполнении потока данных нет.
description	string	Описание параметра.
isRequired	boolean	Указывает, является ли параметр обязательным.
name	string	Имя параметра.
type	string: Time	Тип параметра. С течением времени могут добавляться дополнительные типы типов.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.