Compartilhar via

Items - List Items

  • Referência
Serviço:
Core
Versão da API:
v1

Retorna uma lista de itens do workspace especificado.
Essa API dá suporte a de paginação.

Permissões

O chamador deve ter função de workspace do visualizador ou superior.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Sim

Interface

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}&continuationToken={continuationToken}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
workspaceId
 path True

string

uuid

A ID do workspace.
continuationToken
 query

string

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

string

O tipo do item.

Respostas

Nome Tipo Description
200 OK

Items

Solicitação concluída com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InvalidItemType – Tipo de item inválido.

Exemplos

List item in workspace with continuation example
List items in workspace by type query parameter example
List items in workspace example

List item in workspace with continuation example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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 in workspace by type query parameter example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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 items in workspace example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
    }
  ]
}

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
Item

Um objeto de item.
Items
ItemType

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

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

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

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

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

string

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

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

Item

Objeto

Um objeto de item.

Nome Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

A ID do item.
type

ItemType

O tipo de item.
workspaceId

string

uuid

A ID do workspace.

Items

Objeto
Nome Tipo Description
continuationToken

string

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

string

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

Item[]

Uma lista de itens.

ItemType

Enumeração

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

Valor Description
Dashboard

Painel do PowerBI.
DataPipeline

Um pipeline de dados.
Datamart

Datamart do PowerBI.
Environment

Um ambiente.
Eventhouse

Uma casa de eventos.
Eventstream

Um fluxo de eventos.
GraphQLApi

Um item de API para GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um bloco de anotações.
PaginatedReport

Relatório paginado do PowerBI.
Reflex

Um Reflexo.
Report

Relatório do PowerBI.
SQLDatabase

Um SQLDatabase.
SQLEndpoint

Um ponto de extremidade SQL.
SemanticModel

Modelo semântico do PowerBI.
SparkJobDefinition

Uma definição de trabalho do Spark.
Warehouse

Um armazém.