Share via

Dataflows - Cancel Dataflow Transaction

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

Attempts to cancel the specified transactions.

Required Scope

Dataflow.ReadWrite.All 

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/transactions/{transactionId}/cancel

URI Parameters

Name In Required Type Description
groupId
 path True

string (uuid)

The workspace ID
transactionId
 path True

string

The transaction ID

Responses

Name Type Description
200 OK

DataflowTransactionStatus

OK

Examples

Example

Sample request

POST https://api.powerbi.com/v1.0/myorg/groups/51e47fc5-48fd-4826-89f0-021111110abd/dataflows/transactions/2020-09-11T19:21:52.8778432Z@9cc7a369-6112-4dba-97b6-b07ff5699568$1374282/cancel

Sample response

Status code:
200 
{
  "transactionId": "2020-09-11T19:21:52.8778432Z@9cc7a369-6112-4dba-97b6-b07ff5699568$1374282",
  "status": "SuccessfullyMarked"
}

Definitions

DataflowTransactionStatus

Object

The status of a dataflow refresh transaction

Name Type Description
status enum:
  • alreadyConcluded
  • invalid
  • notFound
  • successfullyMarked

The transaction status
transactionId

string

The transaction ID