Pipelines - Get Pipeline Stage Artifacts

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したデプロイパイプラインの指定したステージに割り当てられたワークスペースから、サポートされている項目を返します。

デプロイパイプラインでサポートされていない項目については、「サポートされていない項目」を参照してください。

アクセス許可

ユーザーは、指定したステージに割り当てられているワークスペースの共同作成者である必要があります。詳細については、「アクセス許可」を参照してください。

必要なスコープ

Pipeline.ReadWrite.All または Pipeline.Read.All

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

URI パラメーター

名前	/	必須	型	説明
pipelineId	path	True	string uuid	デプロイパイプライン ID
stageOrder	path	True	integer int32	デプロイパイプラインステージの順序。開発 (0)、テスト (1)、運用 (2)。

応答

名前	型	説明
200 OK	PipelineStageArtifacts	OK

例

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

Status code:: 200

{
  "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"
    }
  ]
}

定義

名前	説明
PipelineStageArtifacts	デプロイパイプラインステージに割り当てられているワークスペースからサポートされている項目
PipelineStageDashboard	デプロイパイプラインダッシュボードのメタデータ
PipelineStageDataflow	デプロイパイプラインのデータフローのメタデータ
PipelineStageDatamart	デプロイパイプラインデータマートのメタデータ
PipelineStageDataset	デプロイパイプラインデータセットのメタデータ
PipelineStageReport	デプロイパイプラインレポートのメタデータ

PipelineStageArtifacts

デプロイパイプラインステージに割り当てられているワークスペースからサポートされている項目

名前	型	説明
dashboards	PipelineStageDashboard[]	ダッシュボードコレクション
dataflows	PipelineStageDataflow[]	データフローコレクション
datamarts	PipelineStageDatamart[]	datamarts コレクション
datasets	PipelineStageDataset[]	データセットコレクション
reports	PipelineStageReport[]	レポートコレクション

PipelineStageDashboard

デプロイパイプラインダッシュボードのメタデータ

名前	型	説明
artifactDisplayName	string	Power BI 項目の表示名
artifactId	string	Power BI 項目 ID
lastDeploymentTime	string	Power BI 項目の最後のデプロイ日時
sourceArtifactId	string	ソースステージに割り当てられたワークスペースの Power BI アイテム (レポートやダッシュボードなど) の ID。これにより、デプロイ時に現在の Power BI 項目が更新されます。ユーザーがソースステージワークスペースへの少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。
targetArtifactId	string	ターゲットステージのワークスペースからの Power BI アイテム (レポートやダッシュボードなど) の ID。デプロイ時に現在の Power BI 項目によって更新されます。ユーザーがターゲットステージワークスペースに少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。

PipelineStageDataflow

デプロイパイプラインのデータフローのメタデータ

名前	型	説明
artifactDisplayName	string	Power BI 項目の表示名
artifactId	string	Power BI 項目 ID
lastDeploymentTime	string	Power BI 項目の最後のデプロイ日時
sourceArtifactId	string	ソースステージに割り当てられたワークスペースの Power BI アイテム (レポートやダッシュボードなど) の ID。これにより、デプロイ時に現在の Power BI 項目が更新されます。ユーザーがソースステージワークスペースへの少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。
targetArtifactId	string	ターゲットステージのワークスペースからの Power BI アイテム (レポートやダッシュボードなど) の ID。デプロイ時に現在の Power BI 項目によって更新されます。ユーザーがターゲットステージワークスペースに少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。

PipelineStageDatamart

デプロイパイプラインデータマートのメタデータ

名前	型	説明
artifactDisplayName	string	Power BI 項目の表示名
artifactId	string	Power BI 項目 ID
lastDeploymentTime	string	Power BI 項目の最後のデプロイ日時
sourceArtifactId	string	ソースステージに割り当てられたワークスペースの Power BI アイテム (レポートやダッシュボードなど) の ID。これにより、デプロイ時に現在の Power BI 項目が更新されます。ユーザーがソースステージワークスペースへの少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。
targetArtifactId	string	ターゲットステージのワークスペースからの Power BI アイテム (レポートやダッシュボードなど) の ID。デプロイ時に現在の Power BI 項目によって更新されます。ユーザーがターゲットステージワークスペースに少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。

PipelineStageDataset

デプロイパイプラインデータセットのメタデータ

名前	型	説明
artifactDisplayName	string	Power BI 項目の表示名
artifactId	string	Power BI 項目 ID
lastDeploymentTime	string	Power BI 項目の最後のデプロイ日時
sourceArtifactId	string	ソースステージに割り当てられたワークスペースの Power BI アイテム (レポートやダッシュボードなど) の ID。これにより、デプロイ時に現在の Power BI 項目が更新されます。ユーザーがソースステージワークスペースへの少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。
targetArtifactId	string	ターゲットステージのワークスペースからの Power BI アイテム (レポートやダッシュボードなど) の ID。デプロイ時に現在の Power BI 項目によって更新されます。ユーザーがターゲットステージワークスペースに少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。

PipelineStageReport

デプロイパイプラインレポートのメタデータ

名前	型	説明
artifactDisplayName	string	Power BI 項目の表示名
artifactId	string	Power BI 項目 ID
lastDeploymentTime	string	Power BI 項目の最後のデプロイ日時
sourceArtifactId	string	ソースステージに割り当てられたワークスペースの Power BI アイテム (レポートやダッシュボードなど) の ID。これにより、デプロイ時に現在の Power BI 項目が更新されます。ユーザーがソースステージワークスペースへの少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。
targetArtifactId	string	ターゲットステージのワークスペースからの Power BI アイテム (レポートやダッシュボードなど) の ID。デプロイ時に現在の Power BI 項目によって更新されます。ユーザーがターゲットステージワークスペースに少なくとも共同作成者アクセス権を持っている場合にのみ適用されます。

次の方法で共有