Dela via

Dataflows - Update Dataflow

Service:
Power BI REST APIs
API Version:
v1.0

Updates dataflow properties, capabilities and settings.

Required Scope

Dataflow.ReadWrite.All 

PATCH https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}

URI Parameters

Name In Required Type Description
dataflowId
 path True

string (uuid)

The dataflow ID
groupId
 path True

string (uuid)

The workspace ID

Request Body

Name Type Description
allowNativeQueries

boolean

Whether to allow native queries
computeEngineBehavior enum:
  • computeOptimized
  • computeOn
  • computeDisabled

The behavior of the compute engine
description

string

The new description for the dataflow
name

string

The new name for the dataflow

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample request

PATCH https://api.powerbi.com/v1.0/myorg/groups/51e47fc5-48fd-4826-89f0-021bd3a80abd/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce
Request Body
{
  "name": "newDataflowName",
  "description": "New dataflow description",
  "allowNativeQueries": "false",
  "computeEngineBehavior": "computeOptimized"
}

Sample response

Status code:
200

Definitions

DataflowUpdateRequestMessage

Object

A request to update dataflow information

Name Type Description
allowNativeQueries

boolean

Whether to allow native queries
computeEngineBehavior enum:
  • computeDisabled
  • computeOn
  • computeOptimized

The behavior of the compute engine
description

string

The new description for the dataflow
name

string

The new name for the dataflow