Delen via

Items - Discover Dataflow Parameters

Service:
Dataflow
API-versie:
v1

Hiermee worden alle parameters opgehaald die zijn gedefinieerd in de opgegeven gegevensstroom.

Permissions

De beller moet leesmachtigingen hebben voor de gegevensstroom.

Vereiste gedelegeerde bereiken

Dataflow.Read.All of Dataflow.ReadWrite.All of Item.Read.All of Item.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit Support
User Yes
serviceprincipal en beheerde identiteiten Yes

gebruikersinterface

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

URI-parameters

Name In Vereist Type Description
dataflowId
 path True

string (uuid)

De gegevensstroom-id.
workspaceId
 path True

string (uuid)

De werkruimte-ID.
continuationToken
 query

string

Een token voor het ophalen van de volgende pagina met resultaten.

Antwoorden

Name Type Description
200 OK

DataflowParameters

De aanvraag is voltooid.
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • ItemNotFound - Het aangevraagde item is niet gevonden

  • DataflowNotParametricError - De aangevraagde gegevensstroom is niet parametrisch

Voorbeelden

Get Dataflow Parameters example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
DataflowBooleanParameter

Een gegevensstroomparameter van het type Booleaanse waarde.
DataflowDateParameter

Een gegevensstroomparameter van het type Datum. Tekenreeks in de notatie yyyy-MM-dd (bijvoorbeeld: 2025-09-15 voor de datum 15 september 2025). Gebruik het type Automatisch om dit type parameter te overschrijven bij het uitvoeren van de gegevensstroom.
DataflowDateTimeParameter

Een gegevensstroomparameter van het type DateTime. Tekenreeks in de notatie yyyy-MM-ddTHH:mm:ss.xxxZ (voorbeeld: 2025-09-15T21:45:00.000Z).
DataflowDateTimeZoneParameter

Een gegevensstroomparameter van het type DateTimeZone. Tekenreeks in de notatie yyyy-MM-ddTHH:mm:sszzz (voorbeeld: 2025-09-15T21:45:00+02:00). Gebruik het type Automatisch om dit type parameter te overschrijven bij het uitvoeren van de gegevensstroom.
DataflowDurationParameter

Een gegevensstroomparameter van het type Duur. Tekenreeks in de notatie \Pd\DTH\Hm\Ms\S (bijvoorbeeld: P5DT14H35M30S 5 dagen, 14 uur, 35 minuten en 30 seconden). Gebruik het type Automatisch om dit type parameter te overschrijven bij het uitvoeren van de gegevensstroom.
DataflowIntegerParameter

Een gegevensstroomparameter van het type Long.
DataflowNumberParameter

Een gegevensstroomparameter van het type double.
DataflowParameters

Een lijst met gegevensstroomparameters.
DataflowStringParameter

Een gegevensstroomparameter van het type String.
DataflowTimeParameter

Een gegevensstroomparameter van het type Tijd. Tekenreeks in de notatie HH:mm:ss (bijvoorbeeld: 21:45:00 voor 19:45 uur). Gebruik het type Automatisch om dit type parameter te overschrijven bij het uitvoeren van de gegevensstroom.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.

DataflowBooleanParameter

Object

Een gegevensstroomparameter van het type Booleaanse waarde.

Name Type Description
defaultValue

boolean

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

Boolean

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DataflowDateParameter

Object

Een gegevensstroomparameter van het type Datum. Tekenreeks in de notatie yyyy-MM-dd (bijvoorbeeld: 2025-09-15 voor de datum 15 september 2025). Gebruik het type Automatisch om dit type parameter te overschrijven bij het uitvoeren van de gegevensstroom.

Name Type Description
defaultValue

string

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

Date

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DataflowDateTimeParameter

Object

Een gegevensstroomparameter van het type DateTime. Tekenreeks in de notatie yyyy-MM-ddTHH:mm:ss.xxxZ (voorbeeld: 2025-09-15T21:45:00.000Z).

Name Type Description
defaultValue

string (date-time)

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

DateTime

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DataflowDateTimeZoneParameter

Object

Een gegevensstroomparameter van het type DateTimeZone. Tekenreeks in de notatie yyyy-MM-ddTHH:mm:sszzz (voorbeeld: 2025-09-15T21:45:00+02:00). Gebruik het type Automatisch om dit type parameter te overschrijven bij het uitvoeren van de gegevensstroom.

Name Type Description
defaultValue

string

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

DateTimeZone

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DataflowDurationParameter

Object

Een gegevensstroomparameter van het type Duur. Tekenreeks in de notatie \Pd\DTH\Hm\Ms\S (bijvoorbeeld: P5DT14H35M30S 5 dagen, 14 uur, 35 minuten en 30 seconden). Gebruik het type Automatisch om dit type parameter te overschrijven bij het uitvoeren van de gegevensstroom.

Name Type Description
defaultValue

string

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

Duration

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DataflowIntegerParameter

Object

Een gegevensstroomparameter van het type Long.

Name Type Description
defaultValue

integer (int64)

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

Integer

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DataflowNumberParameter

Object

Een gegevensstroomparameter van het type double.

Name Type Description
defaultValue

number (double)

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

Number

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DataflowParameters

Object

Een lijst met gegevensstroomparameters.

Name Type Description
continuationToken

string

Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri

string

De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value DataflowParameter[]:

Een lijst met parameters die zijn gedefinieerd in de gegevensstroom.

DataflowStringParameter

Object

Een gegevensstroomparameter van het type String.

Name Type Description
defaultValue

string

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

String

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

DataflowTimeParameter

Object

Een gegevensstroomparameter van het type Tijd. Tekenreeks in de notatie HH:mm:ss (bijvoorbeeld: 21:45:00 voor 19:45 uur). Gebruik het type Automatisch om dit type parameter te overschrijven bij het uitvoeren van de gegevensstroom.

Name Type Description
defaultValue

string

De waarde waarmee de parameter wordt vernieuwd als er geen wordt opgegeven bij het uitvoeren van de gegevensstroom.
description

string

Een beschrijving van de parameter.
isRequired

boolean

Geeft aan of de parameter is vereist.
name

string

De naam van de parameter.
type string:

Time

Het type van de parameter. Er kunnen in de loop van de tijd extra typen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.