Items - Discover Dataflow Parameters

Služba:: Dataflow

Verzia rozhrania API:: v1

Načíta všetky parametre definované v zadanom toku údajov.

Povolenia

Volajúci musí mať povolenia na čítanie toku údajov.

Povinné delegované rozsahy

Dataflow.Read.All alebo Dataflow.ReadWrite.All alebo Item.Read.All alebo Item.ReadWrite.All

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identity	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Áno

Interface

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

S voliteľnými parametrami:

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

Parametre URI

Name	V	Povinné	Typ	Description
dataflowId	path	True	string (uuid)	ID toku údajov.
workspaceId	path	True	string (uuid)	ID pracovného priestoru.
continuationToken	query		string	Token na načítanie ďalšej stránky výsledkov.

Odpovede

Name Typ Description

200 OK

Name	Typ	Description
200 OK	DataflowParameters	Požiadavka sa úspešne dokončila.
429 Too Many Requests	ErrorResponse	Prekročil sa limit rýchlosti služby. Server vráti hlavičku `Retry-After` v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: ItemNotFound – požadovaná položka sa nenašla. Tok údajovNotParametricError – požadovaný tok údajov nie je parametrický

DataflowParameters

Požiadavka sa úspešne dokončila.

429 Too Many Requests

ErrorResponse

Prekročil sa limit rýchlosti služby. Server vráti hlavičku Retry-After v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Bežné kódy chýb:

ItemNotFound – požadovaná položka sa nenašla.
Tok údajovNotParametricError – požadovaný tok údajov nie je parametrický

Príklady

Get Dataflow Parameters example

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 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"
    }
  ]
}

Definície

Name	Description
DataflowBooleanParameter	Parameter toku údajov typu Booleovská hodnota.
DataflowDateParameter	Parameter toku údajov typu Dátum. Reťazec vo formáte `yyyy-MM-dd` (príklad: `2025-09-15` pre dátum 15. sep 2025). Ak chcete tento typ parametra prepísať pri spúšťaní toku údajov, použite automatický typ.
DataflowDateTimeParameter	Parameter toku údajov typu Dátum a čas. Reťazec vo formáte `yyyy-MM-ddTHH:mm:ss.xxxZ` (príklad: `2025-09-15T21:45:00.000Z`).
DataflowDateTimeZoneParameter	Parameter toku údajov typu DateTimeZone. Reťazec vo formáte `yyyy-MM-ddTHH:mm:sszzz` (príklad: `2025-09-15T21:45:00+02:00`). Ak chcete tento typ parametra prepísať pri spúšťaní toku údajov, použite automatický typ.
DataflowDurationParameter	Parameter toku údajov typu Trvanie. Reťazec vo formáte `\Pd\DTH\Hm\Ms\S` (príklad: `P5DT14H35M30S` pre 5 dní, 14 hodín, 35 minút a 30 sekúnd). Ak chcete tento typ parametra prepísať pri spúšťaní toku údajov, použite automatický typ.
DataflowIntegerParameter	Parameter toku údajov typu Dlhý.
DataflowNumberParameter	Parameter toku údajov typu double.
DataflowParameters	Zoznam parametrov toku údajov.
DataflowStringParameter	Parameter toku údajov typu Reťazec.
DataflowTimeParameter	Parameter toku údajov typu Čas. Reťazec vo formáte `HH:mm:ss` (príklad: `21:45:00` pre 21:45). Ak chcete tento typ parametra prepísať pri spúšťaní toku údajov, použite automatický typ.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.

DataflowBooleanParameter

Object

Parameter toku údajov typu Booleovská hodnota.

Name	Typ	Description
defaultValue	boolean	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je po spustení toku údajov poskytnutá žiadna.
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: Boolean	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

DataflowDateParameter

Object

Parameter toku údajov typu Dátum. Reťazec vo formáte yyyy-MM-dd (príklad: 2025-09-15 pre dátum 15. sep 2025). Ak chcete tento typ parametra prepísať pri spúšťaní toku údajov, použite automatický typ.

Name	Typ	Description
defaultValue	string	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je po spustení toku údajov poskytnutá žiadna.
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: Date	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

DataflowDateTimeParameter

Object

Parameter toku údajov typu Dátum a čas. Reťazec vo formáte yyyy-MM-ddTHH:mm:ss.xxxZ (príklad: 2025-09-15T21:45:00.000Z).

Name	Typ	Description
defaultValue	string (date-time)	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je po spustení toku údajov poskytnutá žiadna.
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: DateTime	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

DataflowDateTimeZoneParameter

Object

Parameter toku údajov typu DateTimeZone. Reťazec vo formáte yyyy-MM-ddTHH:mm:sszzz (príklad: 2025-09-15T21:45:00+02:00). Ak chcete tento typ parametra prepísať pri spúšťaní toku údajov, použite automatický typ.

Name	Typ	Description
defaultValue	string	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je po spustení toku údajov poskytnutá žiadna.
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: DateTimeZone	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

DataflowDurationParameter

Object

Parameter toku údajov typu Trvanie. Reťazec vo formáte \Pd\DTH\Hm\Ms\S (príklad: P5DT14H35M30S pre 5 dní, 14 hodín, 35 minút a 30 sekúnd). Ak chcete tento typ parametra prepísať pri spúšťaní toku údajov, použite automatický typ.

Name	Typ	Description
defaultValue	string	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je po spustení toku údajov poskytnutá žiadna.
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: Duration	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

DataflowIntegerParameter

Object

Parameter toku údajov typu Dlhý.

Name	Typ	Description
defaultValue	integer (int64)	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je po spustení toku údajov poskytnutá žiadna.
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: Integer	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

DataflowNumberParameter

Object

Parameter toku údajov typu double.

Name	Typ	Description
defaultValue	number (double)	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je po spustení toku údajov poskytnutá žiadna.
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: Number	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

DataflowParameters

Object

Zoznam parametrov toku údajov.

Name	Typ	Description
continuationToken	string	Token pre ďalšiu dávku množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
continuationUri	string	Identifikátor URI ďalšej série množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	Zoznam parametrov definovaných v toku údajov.

DataflowStringParameter

Object

Parameter toku údajov typu Reťazec.

Name	Typ	Description
defaultValue	string	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je pri spustení toku údajov poskytnutá žiadna .
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: String	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

DataflowTimeParameter

Object

Parameter toku údajov typu Čas. Reťazec vo formáte HH:mm:ss (príklad: 21:45:00 pre 21:45). Ak chcete tento typ parametra prepísať pri spúšťaní toku údajov, použite automatický typ.

Name	Typ	Description
defaultValue	string	Hodnota, pomocou ktorej sa parameter obnoví, ak nie je po spustení toku údajov poskytnutá žiadna.
description	string	Popis parametra.
isRequired	boolean	Udáva, či je parameter povinný.
name	string	Názov parametra.
type	string: Time	Typ parametra. V priebehu času je možné pridať ďalšie typy typov.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string (uuid)	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

Zdieľať cez

Items - Discover Dataflow Parameters

Povolenia

Povinné delegované rozsahy

Podporované identity v aplikácii Microsoft Entra

Interface

Parametre URI

Odpovede

Príklady

Get Dataflow Parameters example

Vzorová požiadavka

Vzorová odpoveď

Definície

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails