Type - Bulk Create
Cree todas las definiciones de tipo atlas de forma masiva, solo se crearán nuevas definiciones. Los cambios en las definiciones existentes se descartarán.
POST {endpoint}/datamap/api/atlas/v2/types/typedefs
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
businessMetadataDefs |
businessMetadataDefs |
|
classificationDefs |
Matriz de definiciones de clasificación. |
|
entityDefs |
Matriz de definiciones de entidad. |
|
enumDefs |
Matriz de definiciones de enumeración. |
|
relationshipDefs |
Matriz de definiciones de relación. |
|
structDefs |
Matriz de definiciones de estructura. |
|
termTemplateDefs |
Matriz de definiciones de plantilla de términos. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La solicitud se ha realizado correctamente. |
|
Other Status Codes |
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_Bulk |
Type_Bulk |
Type_BulkCreate
Solicitud de ejemplo
POST {endpoint}/datamap/api/atlas/v2/types/typedefs
{
"enumDefs": [],
"structDefs": [],
"classificationDefs": [],
"entityDefs": [
{
"name": "azure_sql_server_example",
"superTypes": [
"azure_resource"
],
"typeVersion": "1.0",
"attributeDefs": [
{
"name": "databases",
"typeName": "array<azure_sql_db>",
"cardinality": "SET",
"isIndexable": false,
"isOptional": true,
"isUnique": false
}
]
}
],
"relationshipDefs": []
}
Respuesta de muestra
{
"enumDefs": [],
"structDefs": [],
"classificationDefs": [],
"entityDefs": [
{
"category": "ENTITY",
"guid": "a47fd902-a564-45f1-aa51-ce9224955881",
"createdBy": "ExampleCreator",
"updatedBy": "ExampleUpdator",
"createTime": 1553672211954,
"updateTime": 1553672211954,
"version": 1,
"name": "azure_sql_server_example",
"description": "azure_sql_server_example",
"typeVersion": "1.0",
"attributeDefs": [
{
"name": "databases",
"typeName": "array<azure_sql_db>",
"isOptional": true,
"cardinality": "SET",
"valuesMinCount": 0,
"valuesMaxCount": 2147483647,
"isUnique": false,
"isIndexable": false,
"includeInNotification": false
}
],
"superTypes": [
"azure_resource"
],
"subTypes": []
}
],
"relationshipDefs": []
}
Type_BulkCreateBusinessMetadataDefs
Solicitud de ejemplo
POST {endpoint}/datamap/api/atlas/v2/types/typedefs
{
"enumDefs": [],
"structDefs": [],
"classificationDefs": [],
"entityDefs": [],
"relationshipDefs": [],
"businessMetadataDefs": [
{
"name": "myBizMetadata1",
"description": "",
"attributeDefs": [
{
"name": "bizAttr1",
"typeName": "string",
"isOptional": true,
"cardinality": "SINGLE",
"isUnique": false,
"isIndexable": true,
"options": {
"maxStrLength": "50",
"applicableEntityTypes": "[\"Path\"]"
}
}
]
}
]
}
Respuesta de muestra
{
"enumDefs": [],
"structDefs": [],
"classificationDefs": [],
"entityDefs": [],
"relationshipDefs": [],
"businessMetadataDefs": [
{
"category": "BUSINESS_METADATA",
"guid": "f26dc6d1-be9c-a0ce-a274-b6388ff6e2eb",
"createdBy": "ServiceAdmin",
"updatedBy": "ServiceAdmin",
"createTime": 1646994112241,
"updateTime": 1646994112241,
"version": 1,
"name": "myBizMetadata1",
"description": "This is my businessMetadata1",
"typeVersion": "1.0",
"lastModifiedTS": "1",
"attributeDefs": [
{
"name": "bizAttr1",
"typeName": "string",
"isOptional": true,
"cardinality": "SINGLE",
"valuesMinCount": 0,
"valuesMaxCount": 1,
"isUnique": false,
"isIndexable": true,
"includeInNotification": false,
"options": {
"applicableEntityTypes": "[\"Path\"]",
"maxStrLength": "50"
}
}
]
}
]
}
Definiciones
Nombre | Description |
---|---|
Atlas |
clase que captura los detalles de un atributo struct. |
Atlas |
clase que captura los detalles de un tipo struct. |
Atlas |
clase que captura los detalles de un tipo de clasificación. |
Atlas |
clase que captura los detalles de una restricción. |
Atlas |
clase que captura los detalles de un tipo de entidad. |
Atlas |
clase que captura los detalles de un tipo de enumeración. |
Atlas |
clase que captura los detalles de un elemento enum-element. |
Atlas |
Una respuesta de error del servicio |
Atlas |
RelationshipEndDef representa un final de la relación. El final de la relación se define mediante un tipo, un nombre de atributo, una cardinalidad y si es el extremo contenedor de la relación. |
Atlas |
AtlasRelationshipDef es un TypeDef que define una relación. Al igual que con otros typeDefs, AtlasRelationshipDef tiene un nombre. Una vez creado RelationshipDef, tiene un guid. El nombre y el guid son las dos formas en que se identifica RelationshipDef. RelationshipDefs tiene 2 extremos, cada uno de los cuales especifica cardinalidad, un nombre y un nombre de tipo EntityDef y, opcionalmente, si el final es un contenedor. RelationshipDefs puede tener AttributeDefs, aunque solo se permiten tipos primitivos. RelationshipDefs tiene una relaciónCategory que especifica el tipo UML de relación necesaria La forma en que entityDefs y RelationshipDefs se van a usar es que EntityDefs definirá AttributeDefs estos AttributeDefs no especificarán un nombre de tipo EntityDef como sus tipos. RelationshipDefs introduce nuevos atributos en las instancias de entidad. Por ejemplo, EntityDef A podría tener atributos attr1,attr2,attr3 EntityDef B podría tener atributos attr4,attr5,attr6 RelationshipDef AtoB podría definir dos extremos end1: escriba A, name attr7 end2: type B, name attr8 Cuando se crea una instancia de EntityDef A, tendrá atributos attr1,attr2,attr3,attr7 Cuando se crea una instancia de EntityDef B, tendrá atributos attr4,attr5,attr6,attr8 De esta manera, relationshipDefs se puede crear independientemente de entityDefs y puede insertar atributos de relación en las instancias de entidad. |
Atlas |
RelationshipEndDef representa un final de la relación. El final de la relación se define mediante un tipo, un nombre de atributo, una cardinalidad y si es el extremo contenedor de la relación. |
Atlas |
clase que captura los detalles de un tipo struct. |
Atlas |
Definiciones de tipos. |
Cardinality |
Cardinalidad |
Date |
El formato de la fecha. |
Number |
Formato de número. |
Relationship |
Categoría de relación |
Rounding |
Modo de redondeo |
Term |
Definición de plantilla de término para el término del glosario. |
Time |
Información de zona horaria. |
Type |
Categoría de tipo |
AtlasAttributeDef
clase que captura los detalles de un atributo struct.
Nombre | Tipo | Description |
---|---|---|
cardinality |
Atributo con valor único o atributo multivalor. |
|
constraints |
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 indizable. |
isOptional |
boolean |
Determina si es opcional. |
isUnique |
boolean |
Determina si es único. |
name |
string |
El nombre del atributo. |
options |
object |
Opciones del atributo . |
typeName |
string |
Nombre del tipo. |
valuesMaxCount |
integer |
Recuento máximo de los valores. |
valuesMinCount |
integer |
Recuento mínimo de los valores. |
AtlasBusinessMetadataDef
clase que captura los detalles de un tipo struct.
Nombre | Tipo | Description |
---|---|---|
attributeDefs |
Matriz de definiciones de atributo. |
|
category |
Enumeración de tipo category. |
|
createTime |
integer |
Hora de creación del registro. |
createdBy |
string |
El usuario que creó el registro. |
dateFormatter |
El formato de la 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 |
El tipo de servicio. |
typeVersion |
string |
Versión del tipo. |
updateTime |
integer |
Hora de actualización del registro. |
updatedBy |
string |
El usuario que actualizó el registro. |
version |
integer |
Versión del registro. |
AtlasClassificationDef
clase que captura los detalles de un tipo de clasificación.
Nombre | Tipo | Description |
---|---|---|
attributeDefs |
Matriz de definiciones de atributo. |
|
category |
Enumeración de tipo category. |
|
createTime |
integer |
Hora de creación del registro. |
createdBy |
string |
El usuario que creó el registro. |
dateFormatter |
El formato de la fecha. |
|
description |
string |
Descripción de la definición de tipo. |
entityTypes |
string[] |
Especificar una lista de nombres entityType en classificationDef garantiza que las clasificaciones solo se pueden aplicar a esos entityTypes. Los subtipos de los tipos de entidad heredan la restricción. Los subtipos classificationDef heredan las restricciones entityTypes de los elementos primarios. Cualquier subtipo classificationDef puede restringir aún más las restricciones entityTypes de los elementos primarios especificando un subconjunto de entityTypes. Una lista entityTypes vacía cuando no hay restricciones primarias significa que no hay restricciones. Una lista entityTypes vacía cuando hay restricciones primarias significa que el subtipo recoge las restricciones primarias. Si se proporciona una lista de entityTypes, donde se hereda de otra, se rechazará. Esto debería fomentar clasificaciones más limpiasDefs. |
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 |
El tipo de servicio. |
subTypes |
string[] |
Matriz de subtipos. |
superTypes |
string[] |
Matriz de super tipos. |
typeVersion |
string |
Versión del tipo. |
updateTime |
integer |
Hora de actualización del registro. |
updatedBy |
string |
El usuario que actualizó el registro. |
version |
integer |
Versión del registro. |
AtlasConstraintDef
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. |
AtlasEntityDef
clase que captura los detalles de un tipo de entidad.
Nombre | Tipo | Description |
---|---|---|
attributeDefs |
Matriz de definiciones de atributo. |
|
category |
Enumeración de tipo category. |
|
createTime |
integer |
Hora de creación del registro. |
createdBy |
string |
El usuario que creó el registro. |
dateFormatter |
El formato de la 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. |
relationshipAttributeDefs |
Matriz de atributos de relación. |
|
serviceType |
string |
El tipo de servicio. |
subTypes |
string[] |
Matriz de subtipos. |
superTypes |
string[] |
Matriz de super tipos. |
typeVersion |
string |
Versión del tipo. |
updateTime |
integer |
Hora de actualización del registro. |
updatedBy |
string |
El usuario que actualizó el registro. |
version |
integer |
Versión del registro. |
AtlasEnumDef
clase que captura los detalles de un tipo de enumeración.
Nombre | Tipo | Description |
---|---|---|
category |
Enumeración de tipo category. |
|
createTime |
integer |
Hora de creación del registro. |
createdBy |
string |
El usuario que creó el registro. |
dateFormatter |
El formato de la fecha. |
|
defaultValue |
string |
Valor predeterminado. |
description |
string |
Descripción de la definición de tipo. |
elementDefs |
Matriz de definiciones de elementos de enumeración. |
|
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 |
El tipo de servicio. |
typeVersion |
string |
Versión del tipo. |
updateTime |
integer |
Hora de actualización del registro. |
updatedBy |
string |
El usuario que actualizó el registro. |
version |
integer |
Versión del registro. |
AtlasEnumElementDef
clase que captura los detalles de un elemento enum-element.
Nombre | Tipo | Description |
---|---|---|
description |
string |
Descripción de la definición del elemento de enumeración. |
ordinal |
integer |
Ordinal de la definición del elemento de enumeración. |
value |
string |
Valor de la definición del elemento de enumeración. |
AtlasErrorResponse
Una respuesta de error del servicio
Nombre | Tipo | Description |
---|---|---|
errorCode |
string |
Código de error. |
errorMessage |
string |
El mensaje de error. |
requestId |
string |
El identificador de solicitud. |
AtlasRelationshipAttributeDef
RelationshipEndDef representa un final de la relación. El final de la relación se define mediante un tipo, un nombre de atributo, una cardinalidad y si es el extremo contenedor de la relación.
Nombre | Tipo | Description |
---|---|---|
cardinality |
Atributo de valor único o atributo multivalor. |
|
constraints |
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 indizable. |
isLegacyAttribute |
boolean |
Determina si es un atributo heredado. |
isOptional |
boolean |
Determina si es opcional. |
isUnique |
boolean |
Determina si es único. |
name |
string |
El nombre del atributo. |
options |
object |
Las opciones del atributo . |
relationshipTypeName |
string |
Nombre del tipo de relación. |
typeName |
string |
Nombre del tipo. |
valuesMaxCount |
integer |
Recuento máximo de los valores. |
valuesMinCount |
integer |
Recuento mínimo de los valores. |
AtlasRelationshipDef
AtlasRelationshipDef es un TypeDef que define una relación. Al igual que con otros typeDefs, AtlasRelationshipDef tiene un nombre. Una vez creado RelationshipDef, tiene un guid. El nombre y el guid son las dos formas en que se identifica RelationshipDef. RelationshipDefs tiene 2 extremos, cada uno de los cuales especifica cardinalidad, un nombre y un nombre de tipo EntityDef y, opcionalmente, si el final es un contenedor. RelationshipDefs puede tener AttributeDefs, aunque solo se permiten tipos primitivos. RelationshipDefs tiene una relaciónCategory que especifica el tipo UML de relación necesaria La forma en que entityDefs y RelationshipDefs se van a usar es que EntityDefs definirá AttributeDefs estos AttributeDefs no especificarán un nombre de tipo EntityDef como sus tipos. RelationshipDefs introduce nuevos atributos en las instancias de entidad. Por ejemplo, EntityDef A podría tener atributos attr1,attr2,attr3
EntityDef B podría tener atributos attr4,attr5,attr6 RelationshipDef AtoB podría definir dos extremos
end1: escriba A, name attr7 end2: type B, name attr8
Cuando se crea una instancia de EntityDef A, tendrá atributos attr1,attr2,attr3,attr7 Cuando se crea una instancia de EntityDef B, tendrá atributos attr4,attr5,attr6,attr8
De esta manera, relationshipDefs se puede crear independientemente de entityDefs y puede insertar atributos de relación en las instancias de entidad.
Nombre | Tipo | Description |
---|---|---|
attributeDefs |
Matriz de definiciones de atributo. |
|
category |
Enumeración de tipo category. |
|
createTime |
integer |
Hora de creación del registro. |
createdBy |
string |
El usuario que creó el registro. |
dateFormatter |
El formato de la fecha. |
|
description |
string |
Descripción de la definición de tipo. |
endDef1 |
RelationshipEndDef representa un final de la relación. El final de la relación se define mediante un tipo, un nombre de atributo, cardinalidad y si es el extremo contenedor de la relación. |
|
endDef2 |
RelationshipEndDef representa un final de la relación. El final de la relación se define mediante un tipo, un nombre de atributo, cardinalidad y si es el extremo contenedor de la relación. |
|
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. |
relationshipCategory |
La categoría Relación determina el estilo de relación en torno a la contención y el ciclo de vida. La terminología de UML se usa para los valores. ASSOCIATION es una relación sin contención. COMPOSITION y AGGREGATION son relaciones de contención. La diferencia es que se encuentra en los ciclos de vida del contenedor y sus elementos secundarios. En el caso COMPOSITION, los elementos secundarios no pueden existir sin el contenedor. Para AGGREGATION, los ciclos de vida del contenedor y los elementos secundarios son totalmente independientes. |
|
relationshipLabel |
string |
Etiqueta de la relación. |
serviceType |
string |
El tipo de servicio. |
typeVersion |
string |
Versión del tipo. |
updateTime |
integer |
Hora de actualización del registro. |
updatedBy |
string |
Usuario que actualizó el registro. |
version |
integer |
Versión del registro. |
AtlasRelationshipEndDef
RelationshipEndDef representa un final de la relación. El final de la relación se define mediante un tipo, un nombre de atributo, una cardinalidad y si es el extremo contenedor de la relación.
Nombre | Tipo | Description |
---|---|---|
cardinality |
Atributo de valor único o atributo multivalor. |
|
description |
string |
Descripción de la definición final de la relación. |
isContainer |
boolean |
Determina si es contenedor. |
isLegacyAttribute |
boolean |
Determina si es un atributo heredado. |
name |
string |
Nombre de la definición final de la relación. |
type |
string |
Tipo del final de la relación. |
AtlasStructDef
clase que captura los detalles de un tipo struct.
Nombre | Tipo | Description |
---|---|---|
attributeDefs |
Matriz de definiciones de atributo. |
|
category |
Enumeración de tipo categoría. |
|
createTime |
integer |
Hora de creación del registro. |
createdBy |
string |
Usuario que creó el registro. |
dateFormatter |
El formato de la 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 |
El tipo de servicio. |
typeVersion |
string |
Versión del tipo. |
updateTime |
integer |
Hora de actualización del registro. |
updatedBy |
string |
Usuario que actualizó el registro. |
version |
integer |
Versión del registro. |
AtlasTypesDef
Definiciones de tipos.
Nombre | Tipo | Description |
---|---|---|
businessMetadataDefs |
businessMetadataDefs |
|
classificationDefs |
Matriz de definiciones de clasificación. |
|
entityDefs |
Matriz de definiciones de entidad. |
|
enumDefs |
Matriz de definiciones de enumeración. |
|
relationshipDefs |
Matriz de definiciones de relación. |
|
structDefs |
Matriz de definiciones de estructura. |
|
termTemplateDefs |
Matriz de definiciones de plantilla de términos. |
CardinalityValue
Cardinalidad
Nombre | Tipo | Description |
---|---|---|
LIST |
string |
list |
SET |
string |
set |
SINGLE |
string |
sola |
DateFormat
El formato de la fecha.
Nombre | Tipo | Description |
---|---|---|
availableLocales |
string[] |
Matriz de configuraciones regionales disponibles. |
calendar |
number |
Calendario |
dateInstance |
El formato de la fecha. |
|
dateTimeInstance |
El formato de la fecha. |
|
instance |
El formato de la fecha. |
|
lenient |
boolean |
Determina la lenidad del formato de fecha. |
numberFormat |
Formato de número. |
|
timeInstance |
El formato de la fecha. |
|
timeZone |
Información de zona horaria. |
NumberFormat
Formato de número.
Nombre | Tipo | Description |
---|---|---|
availableLocales |
string[] |
Formato de número. |
currency |
string |
Moneda. |
currencyInstance |
Formato de número. |
|
groupingUsed |
boolean |
Determina si se usa la agrupación. |
instance |
Formato de número. |
|
integerInstance |
Formato de número. |
|
maximumFractionDigits |
integer |
El máximo de dígitos de fracción. |
maximumIntegerDigits |
integer |
El máximo de dígitos enteros. |
minimumFractionDigits |
integer |
El mínimo de dígitos de fracción. |
minimumIntegerDigits |
integer |
El mínimo de dígitos enteros. |
numberInstance |
Formato de número. |
|
parseIntegerOnly |
boolean |
Determina si solo se analiza el entero. |
percentInstance |
Formato de número. |
|
roundingMode |
Enumeración del modo de redondeo. |
RelationshipCategory
Categoría de relación
Nombre | Tipo | Description |
---|---|---|
AGGREGATION |
string |
aggregation |
ASSOCIATION |
string |
correlación |
COMPOSITION |
string |
composición |
RoundingMode
Modo de redondeo
Nombre | Tipo | Description |
---|---|---|
CEILING |
string |
ceiling |
DOWN |
string |
Abajo |
FLOOR |
string |
floor |
HALF_DOWN |
string |
mitad abajo |
HALF_EVEN |
string |
mitad par |
HALF_UP |
string |
media arriba |
UNNECESSARY |
string |
unnecessary |
UP |
string |
up |
TermTemplateDef
Definición de plantilla de término para el término del glosario.
Nombre | Tipo | Description |
---|---|---|
attributeDefs |
Matriz de definiciones de atributo. |
|
category |
Enumeración de tipo categoría. |
|
createTime |
integer |
Hora de creación del registro. |
createdBy |
string |
Usuario que creó el registro. |
dateFormatter |
El formato de la 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 |
El tipo de servicio. |
typeVersion |
string |
Versión del tipo. |
updateTime |
integer |
Hora de actualización del registro. |
updatedBy |
string |
Usuario que actualizó el registro. |
version |
integer |
Versión del registro. |
TimeZone
Información de zona horaria.
Nombre | Tipo | Description |
---|---|---|
availableIds |
string[] |
Matriz de identificadores disponibles. |
default |
Información de zona horaria. |
|
displayName |
string |
Nombre para mostrar de la zona horaria. |
dstSavings |
integer |
Valor del horario de verano. |
id |
string |
Identificador de la zona horaria. |
rawOffset |
integer |
Desplazamiento sin formato de la zona horaria. |
TypeCategory
Categoría de tipo
Nombre | Tipo | Description |
---|---|---|
ARRAY |
string |
array |
CLASSIFICATION |
string |
clasificación |
ENTITY |
string |
Entidad |
ENUM |
string |
enum |
MAP |
string |
mapa |
OBJECT_ID_TYPE |
string |
tipo de identificador de objeto |
PRIMITIVE |
string |
primitivos |
RELATIONSHIP |
string |
relación |
STRUCT |
string |
struct |
TERM_TEMPLATE |
string |
plantilla de términos |