Pipelines - Get Pipeline Stages

Service:

Power BI REST APIs

API Version:

v1.0

Returns the stages of the specified deployment pipeline.

Required Scope

Pipeline.ReadWrite.All or Pipeline.Read.All

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/stages

URI Parameters

Name	In	Required	Type	Description
pipelineId	path	True	string uuid	The deployment pipeline ID

Responses

Name	Type	Description
200 OK	PipelineStages	OK

Examples

Get the stages of a deployment pipeline example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/stages

Sample Response

Status code:

200

{
  "value": [
    {
      "order": 0,
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workspace-Development"
    },
    {
      "order": 1,
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e"
    },
    {
      "order": 2
    }
  ]
}

Definitions

Name	Description
PipelineStage	A Power BI deployment pipeline stage
PipelineStages	OData response wrapper for a collection of Power BI deployment pipeline stages.

PipelineStage

A Power BI deployment pipeline stage

Name	Type	Description
order	integer	The stage order, starting from zero.
workspaceId	string	The assigned workspace ID. Only applicable when there's an assigned workspace.
workspaceName	string	The assigned workspace name. Only applicable when there's an assigned workspace and the user has access to the workspace.

PipelineStages

OData response wrapper for a collection of Power BI deployment pipeline stages.

Name	Type	Description
odata.context	string	OData context
value	PipelineStage[]	The collection of deployment pipeline stages