Items - Discover Dataflow Parameters

Usługa:: Dataflow

Wersja interfejsu API:: v1

Pobiera wszystkie parametry zdefiniowane w określonym przepływie danych.

Permissions

Obiekt wywołujący musi mieć uprawnienia do odczytu dla przepływu danych.

Wymagane zakresy delegowane

Dataflow.Read.All lub Dataflow.ReadWrite.All lub Item.Read.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Support
User	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataflowId	path	True	string (uuid)	Identyfikator przepływu danych.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
continuationToken	query		string	Token do pobierania następnej strony wyników.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DataflowParameters	Żądanie zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Typowe kody błędów: ItemNotFound — żądany element nie został znaleziony DataflowNotParametricError — żądany przepływ danych nie jest parametriczny

Nazwa

Typ

Opis

200 OK

DataflowParameters

Żądanie zostało ukończone pomyślnie.

Other Status Codes

ErrorResponse

Typowe kody błędów:

ItemNotFound — żądany element nie został znaleziony
DataflowNotParametricError — żądany przepływ danych nie jest parametriczny

Przykłady

Get Dataflow Parameters example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
DataflowBooleanParameter	Parametr przepływu danych typu Wartość logiczna.
DataflowDateParameter	Parametr przepływu danych typu Date. Ciąg w formacie `yyyy-MM-dd` (przykład: `2025-09-15` data 15 września 2025 r.). Użyj typu "Automatyczny", aby zastąpić ten typ parametru podczas wykonywania przepływu danych.
DataflowDateTimeParameter	Parametr przepływu danych typu DateTime. Ciąg w formacie `yyyy-MM-ddTHH:mm:ss.xxxZ` (przykład: `2025-09-15T21:45:00.000Z`).
DataflowDateTimeZoneParameter	Parametr przepływu danych typu DateTimeZone. Ciąg w formacie `yyyy-MM-ddTHH:mm:sszzz` (przykład: `2025-09-15T21:45:00+02:00`). Użyj typu "Automatyczny", aby zastąpić ten typ parametru podczas wykonywania przepływu danych.
DataflowDurationParameter	Parametr przepływu danych typu Czas trwania. Ciąg w formacie `\Pd\DTH\Hm\Ms\S` (na przykład przez `P5DT14H35M30S` 5 dni, 14 godzin, 35 minut i 30 sekund). Użyj typu "Automatyczny", aby zastąpić ten typ parametru podczas wykonywania przepływu danych.
DataflowIntegerParameter	Parametr przepływu danych typu Long.
DataflowNumberParameter	Parametr przepływu danych typu double.
DataflowParameters	Lista parametrów przepływu danych.
DataflowStringParameter	Parametr przepływu danych typu Ciąg.
DataflowTimeParameter	Parametr przepływu danych typu Time. Ciąg w formacie `HH:mm:ss` (przykład: `21:45:00` dla 19:45). Użyj typu "Automatyczny", aby zastąpić ten typ parametru podczas wykonywania przepływu danych.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.

DataflowBooleanParameter

Objekt

Parametr przepływu danych typu Wartość logiczna.

Nazwa	Typ	Opis
defaultValue	boolean	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden z nich nie zostanie podany podczas wykonywania przepływu danych.
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: Boolean	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

DataflowDateParameter

Objekt

Parametr przepływu danych typu Date. Ciąg w formacie yyyy-MM-dd (przykład: 2025-09-15 data 15 września 2025 r.). Użyj typu "Automatyczny", aby zastąpić ten typ parametru podczas wykonywania przepływu danych.

Nazwa	Typ	Opis
defaultValue	string	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden z nich nie zostanie podany podczas wykonywania przepływu danych.
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: Date	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

DataflowDateTimeParameter

Objekt

Parametr przepływu danych typu DateTime. Ciąg w formacie yyyy-MM-ddTHH:mm:ss.xxxZ (przykład: 2025-09-15T21:45:00.000Z).

Nazwa	Typ	Opis
defaultValue	string (date-time)	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden z nich nie zostanie podany podczas wykonywania przepływu danych.
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: DateTime	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

DataflowDateTimeZoneParameter

Objekt

Parametr przepływu danych typu DateTimeZone. Ciąg w formacie yyyy-MM-ddTHH:mm:sszzz (przykład: 2025-09-15T21:45:00+02:00). Użyj typu "Automatyczny", aby zastąpić ten typ parametru podczas wykonywania przepływu danych.

Nazwa	Typ	Opis
defaultValue	string	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden z nich nie zostanie podany podczas wykonywania przepływu danych.
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: DateTimeZone	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

DataflowDurationParameter

Objekt

Parametr przepływu danych typu Czas trwania. Ciąg w formacie \Pd\DTH\Hm\Ms\S (na przykład przez P5DT14H35M30S 5 dni, 14 godzin, 35 minut i 30 sekund). Użyj typu "Automatyczny", aby zastąpić ten typ parametru podczas wykonywania przepływu danych.

Nazwa	Typ	Opis
defaultValue	string	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden z nich nie zostanie podany podczas wykonywania przepływu danych.
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: Duration	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

DataflowIntegerParameter

Objekt

Parametr przepływu danych typu Long.

Nazwa	Typ	Opis
defaultValue	integer (int64)	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden z nich nie zostanie podany podczas wykonywania przepływu danych.
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: Integer	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

DataflowNumberParameter

Objekt

Parametr przepływu danych typu double.

Nazwa	Typ	Opis
defaultValue	number (double)	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden z nich nie zostanie podany podczas wykonywania przepływu danych.
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: Number	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

DataflowParameters

Objekt

Lista parametrów przepływu danych.

Nazwa	Typ	Opis
continuationToken	string	Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri	string	Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	Lista parametrów zdefiniowanych w przepływie danych.

DataflowStringParameter

Objekt

Parametr przepływu danych typu Ciąg.

Nazwa	Typ	Opis
defaultValue	string	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden nie zostanie podany podczas wykonywania przepływu danych .
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: String	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

DataflowTimeParameter

Objekt

Parametr przepływu danych typu Time. Ciąg w formacie HH:mm:ss (przykład: 21:45:00 dla 19:45). Użyj typu "Automatyczny", aby zastąpić ten typ parametru podczas wykonywania przepływu danych.

Nazwa	Typ	Opis
defaultValue	string	Wartość, za pomocą której parametr zostanie odświeżony, jeśli żaden z nich nie zostanie podany podczas wykonywania przepływu danych.
description	string	Opis parametru.
isRequired	boolean	Wskazuje, czy parametr jest wymagany.
name	string	Nazwa parametru.
type	string: Time	Typ parametru. Dodatkowe typy typów mogą być dodawane w czasie.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

Udostępnij przez

Items - Discover Dataflow Parameters

Permissions

Wymagane zakresy delegowane

Tożsamości obsługiwane przez Microsoft Entra

Interfejs

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Get Dataflow Parameters example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails