Type - Get Business Metadata Def By Name

Servicio:

Purview

Versión de la API:

2023-09-01

Obtenga la definición businessMetadata por su nombre (único).

GET {endpoint}/datamap/api/atlas/v2/types/businessmetadatadef/name/{name}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)
name	path	True	string	nombre businessMetadata

Respuestas

Nombre	Tipo	Description
200 OK	AtlasBusinessMetadataDef	La solicitud se ha realizado correctamente.
Other Status Codes	AtlasErrorResponse	Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Type_GetBusinessMetadataDefByName

Solicitud de ejemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/types/businessmetadatadef/name/Business_Metadata_Type_Name

Respuesta de muestra

status code:

200

{
  "category": "BUSINESS_METADATA",
  "guid": "d8757510-c866-61ba-486f-1afca09f43b8",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1671545620780,
  "updateTime": 1671545620780,
  "version": 1,
  "name": "Business_Metadata_Type_Name",
  "description": "Business_Metadata_Type_Name",
  "typeVersion": "1.0",
  "lastModifiedTS": "1",
  "attributeDefs": [
    {
      "name": "customAttribute",
      "typeName": "string",
      "isOptional": true,
      "cardinality": "SINGLE",
      "valuesMinCount": 0,
      "valuesMaxCount": 1,
      "isUnique": false,
      "isIndexable": false,
      "includeInNotification": false,
      "options": {
        "maxStrLength": "5000",
        "isDisabled": "false",
        "applicableEntityTypes": "[\"DataSet\"]"
      }
    }
  ]
}

Definiciones

Nombre	Description
AtlasAttributeDef	clase que captura los detalles de un atributo de estructura.
AtlasBusinessMetadataDef	clase que captura los detalles de un tipo de estructura.
AtlasConstraintDef	clase que captura los detalles de una restricción.
AtlasErrorResponse	Respuesta de error del servicio
CardinalityValue	Cardinalidad
DateFormat	Formato de fecha.
NumberFormat	Formato de número.
RoundingMode	Modo de redondeo
TimeZone	Información de zona horaria.
TypeCategory	Categoría de tipo

AtlasAttributeDef

Object

clase que captura los detalles de un atributo de estructura.

Nombre	Tipo	Description
cardinality	CardinalityValue	Atributo de valor único o atributo multivalor.
constraints	AtlasConstraintDef[]	Matriz de restricciones.
defaultValue	string	Valor predeterminado del atributo.
description	string	Descripción del atributo.
includeInNotification	boolean	Determina si se incluye en la notificación.
isIndexable	boolean	Determina si es indexable.
isOptional	boolean	Determina si es opcional.
isUnique	boolean	Determina si es único.
name	string	Nombre del atributo.
options	object	Las opciones del atributo .
typeName	string	Nombre del tipo.
valuesMaxCount	integer (int32)	Recuento máximo de los valores.
valuesMinCount	integer (int32)	Recuento mínimo de los valores.

AtlasBusinessMetadataDef

Object

clase que captura los detalles de un tipo de estructura.

Nombre	Tipo	Description
attributeDefs	AtlasAttributeDef[]	Matriz de definiciones de atributo.
category	TypeCategory	Enumeración de tipo category.
createTime	integer (int64)	Hora de creación del registro.
createdBy	string	Usuario que creó el registro.
dateFormatter	DateFormat	Formato de fecha.
description	string	Descripción de la definición de tipo.
guid	string	GUID de la definición de tipo.
lastModifiedTS	string	ETag para el control de simultaneidad.
name	string	Nombre de la definición de tipo.
options	object	Las opciones de la definición de tipo.
serviceType	string	Tipo de servicio.
typeVersion	string	Versión del tipo.
updateTime	integer (int64)	Hora de actualización del registro.
updatedBy	string	Usuario que actualizó el registro.
version	integer (int64)	Versión del registro.

AtlasConstraintDef

Object

clase que captura los detalles de una restricción.

Nombre	Tipo	Description
params		Parámetros de la definición de restricción.
type	string	Tipo de la restricción.

AtlasErrorResponse

Object

Respuesta de error del servicio

Nombre	Tipo	Description
errorCode	string	Código de error.
errorMessage	string	Mensaje de error.
requestId	string (uuid)	Identificador de solicitud.

CardinalityValue

Enumeración

Cardinalidad

Valor	Description
LIST	lista
SET	poner
SINGLE	soltero

DateFormat

Object

Formato de fecha.

Nombre	Tipo	Description
availableLocales	string[]	Matriz de configuraciones regionales disponibles.
calendar	number (float)	Calendario
dateInstance	DateFormat	Formato de fecha.
dateTimeInstance	DateFormat	Formato de fecha.
instance	DateFormat	Formato de fecha.
lenient	boolean	Determina la lenidad del formato de fecha.
numberFormat	NumberFormat	Formato de número.
timeInstance	DateFormat	Formato de fecha.
timeZone	TimeZone	Información de zona horaria.

NumberFormat

Object

Formato de número.

Nombre	Tipo	Description
availableLocales	string[]	Formato de número.
currency	string	Moneda.
currencyInstance	NumberFormat	Formato de número.
groupingUsed	boolean	Determina si se usa la agrupación.
instance	NumberFormat	Formato de número.
integerInstance	NumberFormat	Formato de número.
maximumFractionDigits	integer (int32)	El máximo de dígitos de fracción.
maximumIntegerDigits	integer (int32)	El máximo de dígitos enteros.
minimumFractionDigits	integer (int32)	Mínimo de dígitos de fracción.
minimumIntegerDigits	integer (int32)	Mínimo de dígitos enteros.
numberInstance	NumberFormat	Formato de número.
parseIntegerOnly	boolean	Determina si solo se analiza un entero.
percentInstance	NumberFormat	Formato de número.
roundingMode	RoundingMode	Enumeración del modo de redondeo.

RoundingMode

Enumeración

Modo de redondeo

Valor	Description
CEILING	techo
DOWN	abajo
FLOOR	piso
HALF_DOWN	mitad abajo
HALF_EVEN	mitad incluso
HALF_UP	medio arriba
UNNECESSARY	innecesario
UP	hacia arriba

TimeZone

Object

Información de zona horaria.

Nombre	Tipo	Description
availableIds	string[]	Matriz de identificadores disponibles.
default	TimeZone	Información de zona horaria.
displayName	string	Nombre para mostrar de la zona horaria.
dstSavings	integer (int32)	Valor del horario de verano.
id	string	Identificador de la zona horaria.
rawOffset	integer (int32)	Desplazamiento sin procesar de la zona horaria.

TypeCategory

Enumeración

Categoría de tipo

Valor	Description
ARRAY	arreglo
CLASSIFICATION	clasificación
ENTITY	entidad
ENUM	enumeración
MAP	mapa
OBJECT_ID_TYPE	tipo de identificador de objeto
PRIMITIVE	primitivo
RELATIONSHIP	relación
STRUCT	Estructura
TERM_TEMPLATE	plantilla de términos