Items - Get Downstream Relations (beta)

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

Obtém relações downstream para um item.

Note

Essa API faz parte de uma versão Beta e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção. Ao chamar essa API, os chamadores devem especificar true como o valor do parâmetro betade consulta.

Retorna todos os itens que estão downstream do item especificado, incluindo as bordas de relação e os workspaces referenciados.

Permissões

O chamador deve ter permissões de leitura para o item.

Escopos delegados necessários

Item.Read.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

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

Identity Support
User Sim
Entidade de serviço e identidades gerenciadas Sim

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/relations/downstream?beta={beta}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
itemId
 path True

string (uuid)

A ID do item.
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.
beta
 query True

boolean

Esse parâmetro necessário deve ser definido para true acessar essa API, que está atualmente em beta.

Respostas

Nome Tipo Description
200 OK

RelationsResponse

Solicitação concluída com êxito.
429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais.

Cabeçalhos

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - O item solicitado não foi encontrado.

  • InsufficientPrivileges – o chamador não tem permissões suficientes para acessar o item.

Exemplos

Get downstream relations example

Solicitação de exemplo

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/9b218778-e7a5-4d73-8187-f10824047715/relations/downstream?beta=True

Resposta de exemplo

Código de status:
200 
{
  "items": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "type": "Report",
      "displayName": "Q4 Sales Dashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    },
    {
      "id": "9b218778-e7a5-4d73-8187-f10824047715",
      "type": "SemanticModel",
      "displayName": "Sales Semantic Model",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ],
  "relations": [
    {
      "itemId": "3546052c-ae64-4526-b1a8-52af7761426f",
      "dependentOnItemId": "9b218778-e7a5-4d73-8187-f10824047715",
      "relationType": "PushData"
    }
  ],
  "workspaces": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "displayName": "Finance Analytics Workspace"
    }
  ]
}

Definições

Nome Description
ErrorRelatedResource

O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemType

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

Uma borda de relação entre dois itens.
RelationsRelatedItem

Um item relacionado ao item especificado. Esse é um subconjunto do objeto de item completo, contendo apenas as propriedades retornadas pelas APIs de relações.
RelationsResponse

Uma resposta que contém itens relacionados, bordas de relação e workspaces referenciados.
RelationsWorkspace

Um workspace referenciado na resposta de relações.
RelationType

O tipo de relação entre os dois itens. Tipos de relação adicionais podem ser adicionados ao longo do tempo.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome Tipo Description
resourceId

string

O identificador do recurso envolvido 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.
isRetriable

boolean

Quando true, a solicitação pode ser repetida. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
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 (uuid)

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.

ItemType

Enumeração

O tipo do item. Tipos de item 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 notebook.
SparkJobDefinition

Uma definição de trabalho do Spark.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
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

Um item de API para GraphQL.
MountedDataFactory

Um MountedDataFactory.
SQLDatabase

Um SQLDatabase.
CopyJob

Um trabalho de cópia.
VariableLibrary

Um VariableLibrary.
Dataflow

Um fluxo de dados.
ApacheAirflowJob

Um ApacheAirflowJob.
WarehouseSnapshot

Um instantâneo do Warehouse.
DigitalTwinBuilder

Um DigitalTwinBuilder.
DigitalTwinBuilderFlow

Um fluxo do Construtor de Gêmeos Digitais.
MirroredAzureDatabricksCatalog

Um catálogo espelhado do Azure Databricks.
Map

Um mapa.
AnomalyDetector

Um Detector de Anomalias.
UserDataFunction

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

Um GraphModel.
GraphQuerySet

Um Graph QuerySet.
SnowflakeDatabase

Um Banco de Dados Snowflake para armazenar tabelas iceberg criadas a partir da conta snowflake.
OperationsAgent

Um OperationsAgent.
CosmosDBDatabase

Um banco de dados do Cosmos DB.
Ontology

Uma ontologia.
EventSchemaSet

Um EventSchemaSet.
DataAgent

Um DataAgent.
MirroredCatalog

Um MirroredCatalog.
AppBackend

Um AppBackend.
OrgApp

Um aplicativo de organização.
OrgAppAudience

Uma audiência de aplicativo da organização.
DataBuildToolJob

Um DataBuildToolJob.
AzureDatabricksStorage

Um item de armazenamento com backup do OneLake para Azure Databricks.

RelationsEdge

Objeto

Uma borda de relação entre dois itens.

Nome Tipo Description
dependentOnItemId

string (uuid)

O identificador do item do qual o item de origem depende.
itemId

string (uuid)

O identificador do item de origem.
relationType

RelationType

O tipo de relação entre os dois itens. Tipos de relação adicionais podem ser adicionados ao longo do tempo.

RelationsRelatedItem

Objeto

Um item relacionado ao item especificado. Esse é um subconjunto do objeto de item completo, contendo apenas as propriedades retornadas pelas APIs de relações.

Nome Tipo Description
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 que contém o item. Use essa ID para localizar o workspace na workspaces lista.

RelationsResponse

Objeto

Uma resposta que contém itens relacionados, bordas de relação e workspaces referenciados.

Nome Tipo Description
items

RelationsRelatedItem[]

Uma lista de itens relacionados.
relations

RelationsEdge[]

Uma lista de bordas de relação entre itens.
workspaces

RelationsWorkspace[]

Uma lista de workspaces referenciados pelos itens relacionados.

RelationsWorkspace

Objeto

Um workspace referenciado na resposta de relações.

Nome Tipo Description
displayName

string

O nome de exibição do workspace.
id

string (uuid)

O identificador do workspace.

RelationType

Enumeração

O tipo de relação entre os dois itens. Tipos de relação adicionais podem ser adicionados ao longo do tempo.

Valor Description
CascadeDelete

Uma relação CascadeDelete indica que o item é o pai do dependentOnItemId e excluir o item fará com que o item Dependente também seja excluído.
WeakAssociation

Uma relação WeakAssociation indica que há uma dependência flexível no item identificado pelo dependentOnItemId. Se o item Dependente for excluído, a relação será removida.
Datasource

Uma relação de fonte de dados indica que há uma dependência flexível no item identificado por uma Fonte de Dados comum. Se o item Dependente for excluído, a relação será removida.
PushData

Uma relação PushData indica que um item dependente grava/envia dados por push para o item dependecy (o item identificado pelo dependentOnItemId). Se o item Dependente for excluído, a relação será removida.
Orchestration

Uma relação de orquestração indica que um item executa processos de gerenciamento ou orquestração do item de dependência (o item identificado pelo dependentOnItemId). Se o item Dependente for excluído, a relação será removida.
Shortcut

Uma relação de atalho indica que um item tem um atalho ou um link para dados ou área de dados do item identificado pelo dependentOnItemId. Se o item Dependente for excluído, a relação será removida.
HiddenInWorkspace

HiddenInWorkspace indica que o item que possui essa relação ficará oculto no workspace.