Pipelines - Get Pipeline
Returns the specified deployment pipeline.
Required Scope
Pipeline.ReadWrite.All or Pipeline.Read.All
GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}
GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}?$expand={$expand}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
pipeline
|
path | True |
string uuid |
The deployment pipeline ID |
$expand
|
query |
string |
Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
Examples
Get a deployment pipeline with its 'stages' expanded example |
Get a deployment pipeline without its 'stages' expanded example |
Get a deployment pipeline with its 'stages' expanded example
Sample request
GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824?$expand=stages
Sample response
{
"id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
"displayName": "My Deployment Pipeline",
"description": "My deployment pipeline",
"stages": [
{
"order": 0,
"workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
"workspaceName": "Workspace-Development"
},
{
"order": 1,
"workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e"
},
{
"order": 2
}
]
}
Get a deployment pipeline without its 'stages' expanded example
Sample request
GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824
Sample response
{
"id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
"displayName": "Marketing Deployment Pipeline",
"description": "Power BI deployment pipeline to manage marketing reports"
}
Definitions
Name | Description |
---|---|
Pipeline |
A Power BI pipeline |
Pipeline |
A Power BI deployment pipeline stage |
Pipeline
A Power BI pipeline
Name | Type | Description |
---|---|---|
description |
string |
The deployment pipeline description |
displayName |
string |
The deployment pipeline display name |
id |
string |
The deployment pipeline ID |
stages |
The collection of deployment pipeline stages. Only returned when |
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. |