Get Scoped Asset Meta Data For Asset DQ - Get Scoped Asset Meta Data For Asset DQ

Serviço:

Purview

Versão da API:

2026-01-12-preview

Recupera os metadados de ativos com escopo para um dado ativo dentro de um domínio de negócio. O produto de dados é especificado como parâmetro opcional de consulta.

GET {endpoint}/purviewdataquality/api/business-domains/{businessDomainId}/data-assets/{dataAssetId}/scoped-asset-metadata?api-version=2026-01-12-preview

Com parâmetros opcionais:

GET {endpoint}/purviewdataquality/api/business-domains/{businessDomainId}/data-assets/{dataAssetId}/scoped-asset-metadata?api-version=2026-01-12-preview&dataProductId={dataProductId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
businessDomainId	path	True	string	Identificador único para o domínio de negócio que contém o produto de dados
dataAssetId	path	True	string	Identificador único para o ativo de dados cujos metadados com escopo estão sendo recuperados
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
dataProductId	query		string	Para ativos não associados a nenhum Produto de Dados, use Guid.Empty para dataProductId. Opcional.

Respostas

Nome	Tipo	Description
200 OK	ScopedAssetMetadata	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://purview.azure.net/.default

Exemplos

ScopedAssetMetaData_Get_V2

Solicitação de exemplo

HTTP

GET {endpoint}/purviewdataquality/api/business-domains/abcdef12-3456-7890-abcd-ef1234567890/data-assets/123e4567-e89b-12d3-a456-426614174000/scoped-asset-metadata?api-version=2026-01-12-preview&dataProductId=00000000-0000-0000-0000-000000000000

Resposta de exemplo

Código de status:

200

{
  "description": "",
  "favouriteColumnPaths": [],
  "id": "642bc3b4-66aa-494a-b9d9-797085ce2cb0",
  "businessDomain": {
    "type": "BusinessDomainReference",
    "referenceId": "76be16f9-5cb3-4839-83d6-4e3829a8ab0c"
  },
  "dataProduct": {
    "type": "DataProductReference",
    "referenceId": "2a1d2087-09e2-4ecf-817d-1f5bfcbc31bf"
  },
  "dataAsset": {
    "type": "DataAssetReference",
    "referenceId": "fadb55b6-aa10-47d5-82c4-5e2723ba7869"
  },
  "runtime": {
    "isErrorRowRequired": false,
    "errorRowWriteFormat": ""
  },
  "createdAt": "2025-06-27T10:38:07.6920087Z",
  "lastModifiedAt": "2025-06-27T10:38:07.6920087Z",
  "createdBy": "92522642-6537-4785-9fcd-fe58afaa43c5",
  "lastModifiedBy": "92522642-6537-4785-9fcd-fe58afaa43c5",
  "ETag": "250026c0-0000-3200-0000-685e748f0000"
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST – https://aka.ms/AzureRestApiGuidelines#handling-errors.
Reference	Referência a entidades na hierarquia de governança de dados para estabelecimento de relacionamentos
ScopedAssetMetadata	Configuração de metadados de ativos com escopo vinculada a um ativo de dados específico.
ScopedAssetMetadataRuntime	Opções de configuração em tempo de execução para uma entidade de metadados de ativos com escopo.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação do erro em formato legível por humanos.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

Reference

Objeto

Referência a entidades na hierarquia de governança de dados para estabelecimento de relacionamentos

Nome	Tipo	Description
referenceId	string	Identificador único da entidade referenciada
type	string	Classificação de tipo da entidade referenciada

ScopedAssetMetadata

Objeto

Configuração de metadados de ativos com escopo vinculada a um ativo de dados específico.

Nome	Tipo	Description
ETag	string	Etiqueta de entidade usada para controle de concorrência e validação de versões.
businessDomain	Reference	Referência ao Domínio de Negócios associado.
createdAt	string (date-time)	Carimbo de data e hora em que esses metadados foram criados.
createdBy	string	Identificador do usuário que criou esses metadados.
dataAsset	Reference	Referência ao Ativo de Dados associado.
dataProduct	Reference	Referência ao Produto de Dados associado.
description	string	Texto descritivo fornecendo detalhes sobre os metadados do ativo com escopo.
favouriteColumnPaths	string[]	Lista de caminhos de colunas favoritos selecionados para acesso rápido ou monitoramento.
id	string	Identificador único para a entidade de metadados de ativos com escopo.
lastModifiedAt	string (date-time)	Carimbo de data e hora em que esses metadados foram modificados pela última vez.
lastModifiedBy	string	Identificador do usuário que modificou estes metadados pela última vez.
runtime	ScopedAssetMetadataRuntime	Parâmetros de configuração em tempo de execução que definem o comportamento da linha de erro e o formato da saída.

ScopedAssetMetadataRuntime

Objeto

Opções de configuração em tempo de execução para uma entidade de metadados de ativos com escopo.

Nome	Tipo	Description
errorRowWriteFormat	string	Especifica o formato em que as linhas de erro são escritas (por exemplo, CSV, Parquet).
isErrorRowRequired	boolean	Indica se os detalhes da linha de erro devem ser capturados.