Pipelines - Get Pipeline Stage Artifacts

Returns the supported items from the workspace assigned to the specified stage of the specified deployment pipeline.

To learn about items that aren't supported in deployment pipelines, see Unsupported items.

Permissions

The user must at least be a contributor on the workspace assigned to the specified stage. For more information, see Permissions.

Required Scope

Pipeline.ReadWrite.All or Pipeline.Read.All

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

URI Parameters

Name In Required Type Description
pipelineId
path True

string

uuid

The deployment pipeline ID

stageOrder
path True

integer

int32

The deployment pipeline stage order. Development (0), Test (1), Production (2).

Responses

Name Type Description
200 OK

PipelineStageArtifacts

OK

Examples

Example of getting 'Test' stage Power BI items (such as reports or dashboards)

Sample request

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

Sample response

{
  "dataflows": [
    {
      "artifactId": "527700ab-3cdb-4637-8402-912a129b2a92",
      "artifactDisplayName": "Sales Dataflow",
      "sourceArtifactId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
      "lastDeploymentTime": "2021-06-06T11:55:59.057Z"
    }
  ],
  "datamarts": [
    {
      "artifactId": "a7654a17-c5d1-4539-b9ec-022075545e50",
      "artifactDisplayName": "Sales Datamart",
      "sourceArtifactId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "lastDeploymentTime": "2021-06-06T11:55:59.057Z"
    }
  ],
  "datasets": [
    {
      "artifactId": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
      "artifactName": "Sales Dataset",
      "sourceArtifactId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
      "targetArtifactId": "a5cf347e-7b49-4198-8a2b-0aa92c37d8f8",
      "lastDeploymentTime": "2020-12-13T09:26:41.153Z"
    }
  ],
  "reports": [
    {
      "artifactId": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
      "artifactName": "Sales Report",
      "sourceArtifactId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "lastDeploymentTime": "2020-12-13T09:26:41.153Z"
    }
  ],
  "dashboards": [
    {
      "artifactId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
      "artifactName": "Sales Dashboard"
    }
  ]
}

Definitions

Name Description
PipelineStageArtifacts

Supported items from a workspace that's assigned to a deployment pipeline stage

PipelineStageDashboard

The metadata for a deployment pipeline dashboard

PipelineStageDataflow

The metadata for a deployment pipeline dataflow

PipelineStageDatamart

The metadata for a deployment pipeline datamart

PipelineStageDataset

The metadata for a deployment pipeline dataset

PipelineStageReport

The metadata for a deployment pipeline report

PipelineStageArtifacts

Supported items from a workspace that's assigned to a deployment pipeline stage

Name Type Description
dashboards

PipelineStageDashboard[]

The dashboards collection

dataflows

PipelineStageDataflow[]

The dataflows collection

datamarts

PipelineStageDatamart[]

The datamarts collection

datasets

PipelineStageDataset[]

The datasets collection

reports

PipelineStageReport[]

The reports collection

PipelineStageDashboard

The metadata for a deployment pipeline dashboard

Name Type Description
artifactDisplayName

string

The Power BI item display name

artifactId

string

The Power BI item ID

lastDeploymentTime

string

The last deployment date and time of the Power BI item

sourceArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace assigned to the source stage, which will update the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the source stage workspace.

targetArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace of the target stage, which will be updated by the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the target stage workspace.

PipelineStageDataflow

The metadata for a deployment pipeline dataflow

Name Type Description
artifactDisplayName

string

The Power BI item display name

artifactId

string

The Power BI item ID

lastDeploymentTime

string

The last deployment date and time of the Power BI item

sourceArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace assigned to the source stage, which will update the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the source stage workspace.

targetArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace of the target stage, which will be updated by the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the target stage workspace.

PipelineStageDatamart

The metadata for a deployment pipeline datamart

Name Type Description
artifactDisplayName

string

The Power BI item display name

artifactId

string

The Power BI item ID

lastDeploymentTime

string

The last deployment date and time of the Power BI item

sourceArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace assigned to the source stage, which will update the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the source stage workspace.

targetArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace of the target stage, which will be updated by the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the target stage workspace.

PipelineStageDataset

The metadata for a deployment pipeline dataset

Name Type Description
artifactDisplayName

string

The Power BI item display name

artifactId

string

The Power BI item ID

lastDeploymentTime

string

The last deployment date and time of the Power BI item

sourceArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace assigned to the source stage, which will update the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the source stage workspace.

targetArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace of the target stage, which will be updated by the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the target stage workspace.

PipelineStageReport

The metadata for a deployment pipeline report

Name Type Description
artifactDisplayName

string

The Power BI item display name

artifactId

string

The Power BI item ID

lastDeploymentTime

string

The last deployment date and time of the Power BI item

sourceArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace assigned to the source stage, which will update the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the source stage workspace.

targetArtifactId

string

The ID of the Power BI item (such as a report or a dashboard) from the workspace of the target stage, which will be updated by the current Power BI item upon deployment. Applicable only when the user has at least contributor access to the target stage workspace.