Freigeben über

Items - Discover Dataflow Parameters

Dienst:
Dataflow
API-Version:
v1

Ruft alle im angegebenen Dataflow definierten Parameter ab.

Erlaubnisse

Der Aufrufer muss über Leseberechtigungen für den Datenfluss verfügen.

Erforderliche delegierte Bereiche

Dataflow.Read.All oder Dataflow.ReadWrite.All oder Item.Read.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Support
Benutzer Yes
Service Principal und Verwaltete Identitäten Yes

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
dataflowId
 path True

string (uuid)

Die Datenfluss-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
continuationToken
 query

string

Ein Token zum Abrufen der nächsten Seite mit Ergebnissen.

Antworten

Name Typ Beschreibung
200 OK

DataflowParameters

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • ItemNotFound – Das angeforderte Element wurde nicht gefunden.

  • DataflowNotParametricError – Der angeforderte Datenfluss ist nicht parametrisch.

Beispiele

Get Dataflow Parameters example

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
DataflowBooleanParameter

Ein Dataflow-Parameter vom Typ Boolean.
DataflowDateParameter

Ein Dataflow-Parameter vom Typ Date. Zeichenfolge im Format yyyy-MM-dd (Beispiel: 2025-09-15 für das Datum 15. September 2025). Verwenden Sie den Typ "Automatisch", um diesen Parametertyp beim Ausführen des Datenflusses außer Kraft zu setzen.
DataflowDateTimeParameter

Ein Dataflow-Parameter vom Typ DateTime. Zeichenfolge im Format yyyy-MM-ddTHH:mm:ss.xxxZ (Beispiel: 2025-09-15T21:45:00.000Z).
DataflowDateTimeZoneParameter

Ein Dataflow-Parameter vom Typ DateTimeZone. Zeichenfolge im Format yyyy-MM-ddTHH:mm:sszzz (Beispiel: 2025-09-15T21:45:00+02:00). Verwenden Sie den Typ "Automatisch", um diesen Parametertyp beim Ausführen des Datenflusses außer Kraft zu setzen.
DataflowDurationParameter

Ein Dataflow-Parameter vom Typ "Duration". Zeichenfolge im Format \Pd\DTH\Hm\Ms\S (Beispiel: P5DT14H35M30S 5 Tage, 14 Stunden, 35 Minuten und 30 Sekunden). Verwenden Sie den Typ "Automatisch", um diesen Parametertyp beim Ausführen des Datenflusses außer Kraft zu setzen.
DataflowIntegerParameter

Ein Dataflow-Parameter vom Typ Long.
DataflowNumberParameter

Ein Dataflow-Parameter vom Typ Double.
DataflowParameters

Eine Liste der Dataflow-Parameter.
DataflowStringParameter

Ein Dataflow-Parameter vom Typ String.
DataflowTimeParameter

Ein Dataflow-Parameter vom Typ "Time". Zeichenfolge im Format HH:mm:ss (Beispiel: 21:45:00 für 9:45 Pm). Verwenden Sie den Typ "Automatisch", um diesen Parametertyp beim Ausführen des Datenflusses außer Kraft zu setzen.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.

DataflowBooleanParameter

Objekt

Ein Dataflow-Parameter vom Typ Boolean.

Name Typ Beschreibung
defaultValue

boolean

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

Boolean

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

DataflowDateParameter

Objekt

Ein Dataflow-Parameter vom Typ Date. Zeichenfolge im Format yyyy-MM-dd (Beispiel: 2025-09-15 für das Datum 15. September 2025). Verwenden Sie den Typ "Automatisch", um diesen Parametertyp beim Ausführen des Datenflusses außer Kraft zu setzen.

Name Typ Beschreibung
defaultValue

string

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

Date

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

DataflowDateTimeParameter

Objekt

Ein Dataflow-Parameter vom Typ DateTime. Zeichenfolge im Format yyyy-MM-ddTHH:mm:ss.xxxZ (Beispiel: 2025-09-15T21:45:00.000Z).

Name Typ Beschreibung
defaultValue

string (date-time)

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

DateTime

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

DataflowDateTimeZoneParameter

Objekt

Ein Dataflow-Parameter vom Typ DateTimeZone. Zeichenfolge im Format yyyy-MM-ddTHH:mm:sszzz (Beispiel: 2025-09-15T21:45:00+02:00). Verwenden Sie den Typ "Automatisch", um diesen Parametertyp beim Ausführen des Datenflusses außer Kraft zu setzen.

Name Typ Beschreibung
defaultValue

string

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

DateTimeZone

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

DataflowDurationParameter

Objekt

Ein Dataflow-Parameter vom Typ "Duration". Zeichenfolge im Format \Pd\DTH\Hm\Ms\S (Beispiel: P5DT14H35M30S 5 Tage, 14 Stunden, 35 Minuten und 30 Sekunden). Verwenden Sie den Typ "Automatisch", um diesen Parametertyp beim Ausführen des Datenflusses außer Kraft zu setzen.

Name Typ Beschreibung
defaultValue

string

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

Duration

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

DataflowIntegerParameter

Objekt

Ein Dataflow-Parameter vom Typ Long.

Name Typ Beschreibung
defaultValue

integer (int64)

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

Integer

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

DataflowNumberParameter

Objekt

Ein Dataflow-Parameter vom Typ Double.

Name Typ Beschreibung
defaultValue

number (double)

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

Number

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

DataflowParameters

Objekt

Eine Liste der Dataflow-Parameter.

Name Typ Beschreibung
continuationToken

string

Das Token für den nächsten Resultsetbatch. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
continuationUri

string

Der URI des nächsten Resultsetbatches. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
value DataflowParameter[]:

Eine Liste von Parametern, die im Dataflow definiert sind.

DataflowStringParameter

Objekt

Ein Dataflow-Parameter vom Typ String.

Name Typ Beschreibung
defaultValue

string

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

String

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

DataflowTimeParameter

Objekt

Ein Dataflow-Parameter vom Typ "Time". Zeichenfolge im Format HH:mm:ss (Beispiel: 21:45:00 für 9:45 Pm). Verwenden Sie den Typ "Automatisch", um diesen Parametertyp beim Ausführen des Datenflusses außer Kraft zu setzen.

Name Typ Beschreibung
defaultValue

string

Der Wert, mit dem der Parameter aktualisiert wird, wenn beim Ausführen des Datenflusses keines angegeben wird.
description

string

Eine Beschreibung des Parameters.
isRequired

boolean

Gibt an, ob der Parameter erforderlich ist.
name

string

Der Name des Parameters.
type string:

Time

Der Typ des Parameters. Zusätzliche Typtypen können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.