Partilhar via

Items - List Items

Serviço:
Core
Versão da API:
v1

Retorna uma lista de itens do espaço de trabalho especificado.
Esta API suporta paginação.

Permissões

O chamador deve ter uma função de espaço de trabalho de visualizador .

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades suportadas pela Microsoft Entra

Esta API suporta as Microsoft c0 listadas nesta secção.

Identidade Suporte
Utilizador Sim
Entidade de serviço e identidades geridas Sim

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items
Com parâmetros opcionais: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items?type={type}&recursive={recursive}&rootFolderId={rootFolderId}&continuationToken={continuationToken}&include=DefaultIdentity

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.
continuationToken
 query

string

Um token para recuperar a próxima página de resultados.
include
 query

ItemIncludeOption[]

Especifica quais as propriedades do item a incluir na resposta como uma lista separada por vírgulas. Podem ser adicionados valores adicionais ao longo do tempo.
recursive
 query

boolean

Lista itens em uma pasta e suas pastas aninhadas, ou apenas uma pasta. True - Todos os itens na pasta e suas pastas aninhadas são listados, Falso - Somente os itens na pasta são listados. O valor padrão é true.
rootFolderId
 query

string (uuid)

Este parâmetro permite que os usuários filtrem itens com base em uma pasta raiz específica. Se não for fornecido, o espaço de trabalho será usado como a pasta raiz.
type
 query

string

O tipo do item.

Respostas

Name Tipo Description
200 OK

Items

Pedido concluído com sucesso.
429 Too Many Requests

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais.

Cabeçalhos

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InvalidItemType - Tipo de item inválido.

  • FolderNotFound - Não foi possível localizar a pasta solicitada.

Exemplos

List all items in a specific folder example
List all items in workspace by type query parameter example
List all items in workspace example
List direct items in a specific folder example
List direct items in workspace example
List items in workspace with continuation example
List items with include option example

List all items in a specific folder example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items?rootFolderId=bbbbbbbb-1111-2222-3333-cccccccccccc&include=DefaultIdentity

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "cccccccc-2222-3333-4444-dddddddddddd",
      "displayName": "Lakehouse",
      "description": "A lakehouse used by the sales team.",
      "type": "Lakehouse",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    },
    {
      "id": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
      "displayName": "Notebook",
      "description": "A notebook for refining Q1 of year 2024 sales data analysis through machine learning algorithms.",
      "type": "Notebook",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "cccccccc-8888-9999-0000-dddddddddddd"
    }
  ]
}

List all items in workspace by type query parameter example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items?type=Lakehouse&include=DefaultIdentity

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Lakehouse Name 1",
      "description": "A lakehouse used by the analytics team.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

List all items in workspace example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items?include=DefaultIdentity

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Lakehouse",
      "description": "A lakehouse used by the analytics team.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    },
    {
      "id": "58fa1eac-9694-4a6b-ba25-3520288e8fea",
      "displayName": "Notebook",
      "description": "A notebook for refining medical data analysis through machine learning algorithms.",
      "type": "KustoDashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

List direct items in a specific folder example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items?recursive=False&rootFolderId=bbbbbbbb-1111-2222-3333-cccccccccccc&include=DefaultIdentity

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
      "displayName": "Notebook",
      "description": "A notebook for refining year 2024 sales data analysis through machine learning algorithms.",
      "type": "Notebook",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
    }
  ]
}

List direct items in workspace example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items?recursive=False&include=DefaultIdentity

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "cccccccc-2222-3333-4444-dddddddddddd",
      "displayName": "Lakehouse",
      "description": "A lakehouse shared by the all teams.",
      "type": "Lakehouse",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    }
  ]
}

List items in workspace with continuation example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items?include=DefaultIdentity

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Lakehouse",
      "description": "A lakehouse used by the analytics team.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    },
    {
      "id": "58fa1eac-9694-4a6b-ba25-3520288e8fea",
      "displayName": "Notebook",
      "description": "A notebook for refining medical data analysis through machine learning algorithms.",
      "type": "KustoDashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List items with include option example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items?rootFolderId=bbbbbbbb-1111-2222-3333-cccccccccccc&include=DefaultIdentity

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "cccccccc-2222-3333-4444-dddddddddddd",
      "displayName": "Lakehouse",
      "description": "A lakehouse used by the sales team.",
      "type": "Lakehouse",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
      "defaultIdentity": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      }
    },
    {
      "id": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
      "displayName": "Notebook",
      "description": "A notebook for refining Q1 of year 2024 sales data analysis through machine learning algorithms.",
      "type": "Notebook",
      "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "folderId": "cccccccc-8888-9999-0000-dddddddddddd",
      "defaultIdentity": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      }
    }
  ]
}

Definições

Name Description
EntireTenantPrincipal

Representa um principal inquilino
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
GroupDetails

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.
GroupPrincipal

Representa um grupo de segurança.
GroupType

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.
Item

Um objeto de item.
ItemIncludeOption

Especifica quais as propriedades do item a incluir na resposta como uma lista separada por vírgulas. Podem ser adicionados valores adicionais ao longo do tempo.
Items
ItemTag

Representa uma tag aplicada em um item.
ItemType

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
PrincipalType

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
SensitivityLabel

Representa uma etiqueta de sensibilidade aplicada a um item.
ServicePrincipalDetails

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.
ServicePrincipalPrincipal

Representa um principal de serviço Microsoft Entra.
ServicePrincipalProfileDetails

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Representa um perfil de principal de serviço.
UserDetails

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.
UserPrincipal

Representa um principal utilizador Microsoft Entra.

EntireTenantPrincipal

Object

Representa um principal inquilino

Name Tipo Description
displayName

string

O nome de exibição da entidade de segurança.
id

string (uuid)

O ID da entidade de segurança.
type string:

EntireTenant

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

GroupDetails

Object

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

Name Tipo Description
groupType

GroupType

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

GroupPrincipal

Object

Representa um grupo de segurança.

Name Tipo Description
displayName

string

O nome de exibição da entidade de segurança.
groupDetails

GroupDetails

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.
id

string (uuid)

O ID da entidade de segurança.
type string:

Group

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

GroupType

Enumeração

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

Valor Description
Unknown

O tipo de grupo principal é desconhecido.
SecurityGroup

Principal é um grupo de segurança.
DistributionList

Principal é uma lista de distribuição.

Item

Object

Um objeto de item.

Name Tipo Description
defaultIdentity Principal:

A identidade padrão do item.
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
folderId

string (uuid)

O ID da pasta.
id

string (uuid)

O ID do item.
sensitivityLabel

SensitivityLabel

A etiqueta de sensibilidade do item.
tags

ItemTag[]

Lista de tags aplicadas.
type

ItemType

O tipo de item.
workspaceId

string (uuid)

O ID do espaço de trabalho.

ItemIncludeOption

Enumeração

Especifica quais as propriedades do item a incluir na resposta como uma lista separada por vírgulas. Podem ser adicionados valores adicionais ao longo do tempo.

Valor Description
DefaultIdentity

Inclui a identidade padrão

Items

Object
Name Tipo Description
continuationToken

string

O token para o próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri

string

O URI do próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value

Item[]

Uma lista de itens.

ItemTag

Object

Representa uma tag aplicada em um item.

Name Tipo Description
displayName

string

O nome da tag.
id

string (uuid)

O ID da tag.

ItemType

Enumeração

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor Description
Dashboard

Painel do PowerBI.
Report

Relatório do PowerBI.
SemanticModel

Modelo semântico do PowerBI.
PaginatedReport

Relatório paginado do PowerBI.
Datamart

Datamart do PowerBI.
Lakehouse

Uma casa no lago.
Eventhouse

Uma casa de eventos.
Environment

Um ambiente.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
KQLDashboard

Um painel KQL.
DataPipeline

Um pipeline de dados.
Notebook

Um caderno.
SparkJobDefinition

Uma definição de trabalho de faísca.
MLExperiment

Uma experiência de aprendizagem automática.
MLModel

Um modelo de aprendizagem automática.
Warehouse

Um armazém.
Eventstream

Um fluxo de eventos.
SQLEndpoint

Um ponto de extremidade SQL.
MirroredWarehouse

Um armazém espelhado.
MirroredDatabase

Um banco de dados espelhado.
Reflex

Um reflexo.
GraphQLApi

Uma API para o item GraphQL.
MountedDataFactory

Um MountedDataFactory.
SQLDatabase

Um SQLDatabase.
CopyJob

Um trabalho de cópia.
VariableLibrary

Uma VariableLibrary.
Dataflow

Um fluxo de dados.
ApacheAirflowJob

Um ApacheAirflowJob.
WarehouseSnapshot

Um instantâneo do Warehouse.
DigitalTwinBuilder

Um DigitalTwinBuilder.
DigitalTwinBuilderFlow

Um fluxo de construtor de gêmeos digitais.
MirroredAzureDatabricksCatalog

Um catálogo de databricks azure espelhado.
Map

Um mapa.
AnomalyDetector

Um detetor de anomalias.
UserDataFunction

Uma função de dados do usuário.
GraphModel

Um GraphModel.
GraphQuerySet

Um Graph QuerySet.
SnowflakeDatabase

Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.
OperationsAgent

Um Agente de Operações.
CosmosDBDatabase

Uma base de dados Cosmos DB.
Ontology

Uma ontologia.
EventSchemaSet

Um EventoSchemaSet.
DataAgent

Um DataAgent.

PrincipalType

Enumeração

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

Valor Description
User

O principal é um utilizador principal da Microsoft Entra.
ServicePrincipal

O principal é um principal do serviço Microsoft Entra.
Group

Principal é um grupo de segurança.
ServicePrincipalProfile

Principal é um perfil de entidade de serviço.
EntireTenant

Principal representa todos os usuários locatários.

SensitivityLabel

Object

Representa uma etiqueta de sensibilidade aplicada a um item.

Name Tipo Description
id

string (uuid)

O ID da etiqueta de sensibilidade.

ServicePrincipalDetails

Object

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

Name Tipo Description
aadAppId

string (uuid)

O Microsoft Entra AppId, do principal do serviço.

ServicePrincipalPrincipal

Object

Representa um principal de serviço Microsoft Entra.

Name Tipo Description
displayName

string

O nome de exibição da entidade de segurança.
id

string (uuid)

O ID da entidade de segurança.
servicePrincipalDetails

ServicePrincipalDetails

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.
type string:

ServicePrincipal

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

ServicePrincipalProfileDetails

Object

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

Name Tipo Description
parentPrincipal Principal:

A entidade principal do perfil da entidade de serviço.

ServicePrincipalProfilePrincipal

Object

Representa um perfil de principal de serviço.

Name Tipo Description
displayName

string

O nome de exibição da entidade de segurança.
id

string (uuid)

O ID da entidade de segurança.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.
type string:

ServicePrincipalProfile

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

UserDetails

Object

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

Name Tipo Description
userPrincipalName

string

O nome principal do usuário.

UserPrincipal

Object

Representa um principal utilizador Microsoft Entra.

Name Tipo Description
displayName

string

O nome de exibição da entidade de segurança.
id

string (uuid)

O ID da entidade de segurança.
type string:

User

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
userDetails

UserDetails

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.