Deployment Pipelines - List Deployment Pipeline Stage Items

Service:

Core

API Version:

v1

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

To learn about items that are supported in deployment pipelines, see: Supported items.

Permissions

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

Required Delegated Scopes

Pipeline.Read.All or Pipeline.ReadWrite.All

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/stages/{stageId}/items

With optional parameters:

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/stages/{stageId}/items?continuationToken={continuationToken}

URI Parameters

Name	In	Required	Type	Description
deploymentPipelineId	path	True	string uuid	The deployment pipeline ID.
stageId	path	True	string uuid	The deployment pipeline stage ID.
continuationToken	query		string	A token for retrieving the next page of results.

Responses

Name	Type	Description
200 OK	DeploymentPipelineStageItems	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Examples

Example of listing a deployment pipeline stage Fabric items

Example of listing a deployment pipeline stage Fabric items with a continuation token

Example of listing a deployment pipeline stage Fabric items

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/stages/48d2f500-6375-4f17-9199-2e1d73c18486/items

Sample response

Status code:

200

{
  "value": [
    {
      "itemId": "a7654a17-c5d1-4539-b9ec-022075545e50",
      "itemDisplayName": "Sales datamart",
      "itemType": "Datamart",
      "sourceItemId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "lastDeploymentTime": "2021-06-06T11:55:59.057Z"
    },
    {
      "itemId": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
      "itemDisplayName": "Sales semantic model",
      "itemType": "SemanticModel",
      "sourceItemId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
      "targetItemId": "a5cf347e-7b49-4198-8a2b-0aa92c37d8f8",
      "lastDeploymentTime": "2020-12-13T09:26:41.153Z"
    },
    {
      "itemId": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
      "itemDisplayName": "Sales report",
      "itemType": "Report",
      "sourceItemId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "lastDeploymentTime": "2020-12-13T09:26:41.153Z"
    },
    {
      "itemId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
      "itemDisplayName": "Sales dashboard",
      "itemType": "Dashboard"
    }
  ]
}

Example of listing a deployment pipeline stage Fabric items with a continuation token

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/stages/48d2f500-6375-4f17-9199-2e1d73c18486/items

Sample response

Status code:

200

{
  "value": [
    {
      "itemId": "a7654a17-c5d1-4539-b9ec-022075545e50",
      "itemDisplayName": "Sales datamart",
      "itemType": "Datamart",
      "sourceItemId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "lastDeploymentTime": "2021-06-06T11:55:59.057Z"
    },
    {
      "itemId": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
      "itemDisplayName": "Sales semantic model",
      "itemType": "SemanticModel",
      "sourceItemId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
      "targetItemId": "a5cf347e-7b49-4198-8a2b-0aa92c37d8f8",
      "lastDeploymentTime": "2020-12-13T09:26:41.153Z"
    },
    {
      "itemId": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
      "itemDisplayName": "Sales report",
      "itemType": "Report",
      "sourceItemId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "lastDeploymentTime": "2020-12-13T09:26:41.153Z"
    },
    {
      "itemId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
      "itemDisplayName": "Sales dashboard",
      "itemType": "Dashboard"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/stages/48d2f500-6375-4f17-9199-2e1d73c18486/items?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitions

Name	Description
DeploymentPipelineStageItem	Fabric item metadata for a deployment pipeline stage.
DeploymentPipelineStageItems	Supported items from a workspace that's assigned to a deployment pipeline stage.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemType	The type of the item. Additional item types may be added over time.

DeploymentPipelineStageItem

Fabric item metadata for a deployment pipeline stage.

Name	Type	Description
itemDisplayName	string	The Fabric item display name.
itemId	string	The Fabric item ID.
itemType	ItemType	The Fabric item type.
lastDeploymentTime	string	The last deployment date and time of the Fabric item.
sourceItemId	string	The ID of the Fabric item from the workspace assigned to the source stage, which will update the current Fabric item upon deployment. Applicable only when the user has at least contributor access to the source stage workspace.
targetItemId	string	The ID of the Fabric item from the workspace of the target stage, which will be updated by the current Fabric item upon deployment. Applicable only when the user has at least contributor access to the target stage workspace.

DeploymentPipelineStageItems

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

Name	Type	Description
continuationToken	string	The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri	string	The URI of the next result set batch. If there are no more records, it's removed from the response.
value	DeploymentPipelineStageItem[]	The items collection.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ItemType

The type of the item. Additional item types may be added over time.

Name	Type	Description
Dashboard	string	PowerBI dashboard.
DataPipeline	string	A data pipeline.
Datamart	string	PowerBI datamart.
Environment	string	An environment.
Eventhouse	string	An eventhouse.
Eventstream	string	An eventstream.
KQLDatabase	string	A KQL database.
KQLQueryset	string	A KQL queryset.
Lakehouse	string	A lakehouse.
MLExperiment	string	A machine learning experiment.
MLModel	string	A machine learning model.
MirroredWarehouse	string	A mirrored warehouse.
Notebook	string	A notebook.
PaginatedReport	string	PowerBI paginated report.
Report	string	PowerBI report.
SQLEndpoint	string	An SQL endpoint.
SemanticModel	string	PowerBI semantic model.
SparkJobDefinition	string	A spark job definition.
Warehouse	string	A warehouse.