Type - Bulk Create
Crie todas as definições de tipo atlas em massa. Evite recriar tipos existentes.
POST {endpoint}/datamap/api/atlas/v2/types/typedefs
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string (uri) |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
businessMetadataDefs |
businessMetadataDefs |
|
classificationDefs |
Uma matriz de definições de classificação. |
|
entityDefs |
Uma matriz de definições de entidade. |
|
enumDefs |
Uma matriz de definições de enumeração. |
|
relationshipDefs |
Uma matriz de definições de relação. |
|
structDefs |
Uma matriz de definições de struct. |
|
termTemplateDefs |
Uma matriz de definições de modelo de termo. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A solicitação foi bem-sucedida. |
|
Other Status Codes |
Uma resposta de erro inesperada. |
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
Type_Bulk |
Type_Bulk |
Type_BulkCreate
Solicitação de exemplo
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": []
}
Resposta de exemplo
{
"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
Solicitação de exemplo
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\"]"
}
}
]
}
]
}
Resposta de exemplo
{
"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"
}
}
]
}
]
}
Definições
Nome | Description |
---|---|
Atlas |
classe que captura detalhes de um atributo struct. |
Atlas |
classe que captura detalhes de um tipo de struct. |
Atlas |
classe que captura detalhes de um tipo de classificação. |
Atlas |
classe que captura detalhes de uma restrição. |
Atlas |
classe que captura detalhes de um tipo de entidade. |
Atlas |
classe que captura detalhes de um tipo de enumeração. |
Atlas |
classe que captura detalhes de um elemento enumeração. |
Atlas |
Uma resposta de erro do serviço |
Atlas |
O relationshipEndDef representa o fim da relação. O final da relação é definido por um tipo, um nome de atributo, cardinalidade e se é o final do contêiner da relação. |
Atlas |
AtlasRelationshipDef é um TypeDef que define uma relação. Assim como acontece com outros typeDefs, o AtlasRelationshipDef tem um nome. Depois de criado, o RelationshipDef tem um guid. O nome e o guid são as duas maneiras pelas quais o RelationshipDef é identificado. RelationshipDefs tem 2 extremidades, cada uma das quais especifica cardinalidade, nome e nome do tipo EntityDef e, opcionalmente, se o final é um contêiner. RelationshipDefs pode ter AttributeDefs , embora apenas tipos primitivos sejam permitidos. RelationshipDefs tem um relationshipCategory especificando o tipo uml de relação necessário A maneira como EntityDefs e RelationshipDefs devem ser usados é que EntityDefs definirá AttributeDefs esses AttributeDefs não especificarão um nome de tipo EntityDef como seus tipos. RelationshipDefs introduz novos atributos às instâncias de entidade. Por exemplo, EntityDef A pode ter atributos attr1,attr2,attr3 EntityDef B pode ter atributos attr4,attr5,attr6 RelationshipDef AtoB pode definir 2 extremidades end1: tipo A, nome attr7 end2: tipo B, nome attr8 Quando uma instância do EntityDef A for criada, ela terá atributos attr1,attr2,attr3,attr7 Quando uma instância do EntityDef B for criada, ela terá atributos attr4,attr5,attr6,attr8 Dessa forma, relationshipDefs pode ser criado separadamente de entityDefs e pode injetar atributos de relação nas instâncias de entidade |
Atlas |
O relationshipEndDef representa o fim da relação. O final da relação é definido por um tipo, um nome de atributo, cardinalidade e se é o final do contêiner da relação. |
Atlas |
classe que captura detalhes de um tipo de struct. |
Atlas |
As definições de tipos. |
Cardinality |
Cardinalidade |
Date |
O formato da data. |
Number |
O formato de número. |
Relationship |
Categoria de relação |
Rounding |
Modo de arredondamento |
Term |
Definição de modelo de termo para o termo glossário. |
Time |
As informações de fuso horário. |
Type |
Categoria de Tipo |
AtlasAttributeDef
classe que captura detalhes de um atributo struct.
Nome | Tipo | Description |
---|---|---|
cardinality |
atributo de valor único ou atributo de vários valores. |
|
constraints |
Uma matriz de restrições. |
|
defaultValue |
string |
O valor padrão do atributo. |
description |
string |
A descrição do atributo. |
includeInNotification |
boolean |
Determina se ele está incluído na notificação. |
isIndexable |
boolean |
Determina se ele é indexável. |
isOptional |
boolean |
Determina se ele é opcional. |
isUnique |
boolean |
Determina se ele é exclusivo. |
name |
string |
O nome do atributo. |
options |
object |
As opções para o atributo. |
typeName |
string |
O nome do tipo. |
valuesMaxCount |
integer (int32) |
A contagem máxima dos valores. |
valuesMinCount |
integer (int32) |
A contagem mínima dos valores. |
AtlasBusinessMetadataDef
classe que captura detalhes de um tipo de struct.
Nome | Tipo | Description |
---|---|---|
attributeDefs |
Uma matriz de definições de atributo. |
|
category |
A enumeração de categoria de tipo. |
|
createTime |
integer (int64) |
A hora criada do registro. |
createdBy |
string |
O usuário que criou o registro. |
dateFormatter |
O formato da data. |
|
description |
string |
A descrição da definição de tipo. |
guid |
string |
O GUID da definição de tipo. |
lastModifiedTS |
string |
ETag para controle de simultaneidade. |
name |
string |
O nome da definição de tipo. |
options |
object |
As opções para a definição de tipo. |
serviceType |
string |
O tipo de serviço. |
typeVersion |
string |
A versão do tipo. |
updateTime |
integer (int64) |
A hora de atualização do registro. |
updatedBy |
string |
O usuário que atualizou o registro. |
version |
integer (int64) |
A versão do registro. |
AtlasClassificationDef
classe que captura detalhes de um tipo de classificação.
Nome | Tipo | Description |
---|---|---|
attributeDefs |
Uma matriz de definições de atributo. |
|
category |
A enumeração de categoria de tipo. |
|
createTime |
integer (int64) |
A hora criada do registro. |
createdBy |
string |
O usuário que criou o registro. |
dateFormatter |
O formato da data. |
|
description |
string |
A descrição da definição de tipo. |
entityTypes |
string[] |
Especificar uma lista de nomes entityType no classificationDef garante que as classificações só possam ser aplicadas a esses entityTypes. Todos os subtipos dos tipos de entidade herdam a restrição. Quaisquer subtipos classificationDef herdam as restrições de entityTypes dos pais. Quaisquer subtipos classificationDef podem restringir ainda mais as restrições de entityTypes dos pais especificando um subconjunto dos entityTypes. Uma lista de entityTypes vazia quando não há restrições pai significa que não há restrições. Uma lista de entityTypes vazia quando há restrições pai significa que o subtipo pega as restrições dos pais. Se uma lista de entityTypes for fornecida, em que uma herda de outra, ela será rejeitada. Isso deve incentivar classificações mais limpasDefs. |
guid |
string |
O GUID da definição de tipo. |
lastModifiedTS |
string |
ETag para controle de simultaneidade. |
name |
string |
O nome da definição de tipo. |
options |
object |
As opções para a definição de tipo. |
serviceType |
string |
O tipo de serviço. |
subTypes |
string[] |
Uma matriz de subtipos. |
superTypes |
string[] |
Uma matriz de super tipos. |
typeVersion |
string |
A versão do tipo. |
updateTime |
integer (int64) |
A hora de atualização do registro. |
updatedBy |
string |
O usuário que atualizou o registro. |
version |
integer (int64) |
A versão do registro. |
AtlasConstraintDef
classe que captura detalhes de uma restrição.
Nome | Tipo | Description |
---|---|---|
params |
Os parâmetros da definição de restrição. |
|
type |
string |
O tipo da restrição. |
AtlasEntityDef
classe que captura detalhes de um tipo de entidade.
Nome | Tipo | Description |
---|---|---|
attributeDefs |
Uma matriz de definições de atributo. |
|
category |
A enumeração de categoria de tipo. |
|
createTime |
integer (int64) |
A hora criada do registro. |
createdBy |
string |
O usuário que criou o registro. |
dateFormatter |
O formato da data. |
|
description |
string |
A descrição da definição de tipo. |
guid |
string |
O GUID da definição de tipo. |
lastModifiedTS |
string |
ETag para controle de simultaneidade. |
name |
string |
O nome da definição de tipo. |
options |
object |
As opções para a definição de tipo. |
relationshipAttributeDefs |
Uma matriz de atributos de relação. |
|
serviceType |
string |
O tipo de serviço. |
subTypes |
string[] |
Uma matriz de subtipos. |
superTypes |
string[] |
Uma matriz de super tipos. |
typeVersion |
string |
A versão do tipo. |
updateTime |
integer (int64) |
A hora de atualização do registro. |
updatedBy |
string |
O usuário que atualizou o registro. |
version |
integer (int64) |
A versão do registro. |
AtlasEnumDef
classe que captura detalhes de um tipo de enumeração.
Nome | Tipo | Description |
---|---|---|
category |
A enumeração de categoria de tipo. |
|
createTime |
integer (int64) |
A hora criada do registro. |
createdBy |
string |
O usuário que criou o registro. |
dateFormatter |
O formato da data. |
|
defaultValue |
string |
O valor padrão. |
description |
string |
A descrição da definição de tipo. |
elementDefs |
Uma matriz de definições de elemento enumeração. |
|
guid |
string |
O GUID da definição de tipo. |
lastModifiedTS |
string |
ETag para controle de simultaneidade. |
name |
string |
O nome da definição de tipo. |
options |
object |
As opções para a definição de tipo. |
serviceType |
string |
O tipo de serviço. |
typeVersion |
string |
A versão do tipo. |
updateTime |
integer (int64) |
A hora de atualização do registro. |
updatedBy |
string |
O usuário que atualizou o registro. |
version |
integer (int64) |
A versão do registro. |
AtlasEnumElementDef
classe que captura detalhes de um elemento enumeração.
Nome | Tipo | Description |
---|---|---|
description |
string |
A descrição da definição do elemento enumeração. |
ordinal |
integer (int32) |
O ordinal da definição de elemento de enumeração. |
value |
string |
O valor da definição do elemento de enumeração. |
AtlasErrorResponse
Uma resposta de erro do serviço
Nome | Tipo | Description |
---|---|---|
errorCode |
string |
O código de erro. |
errorMessage |
string |
A mensagem de erro. |
requestId |
string (uuid) |
A ID da solicitação. |
AtlasRelationshipAttributeDef
O relationshipEndDef representa o fim da relação. O final da relação é definido por um tipo, um nome de atributo, cardinalidade e se é o final do contêiner da relação.
Nome | Tipo | Description |
---|---|---|
cardinality |
atributo de valor único ou atributo de vários valores. |
|
constraints |
Uma matriz de restrições. |
|
defaultValue |
string |
O valor padrão do atributo. |
description |
string |
A descrição do atributo. |
includeInNotification |
boolean |
Determina se ele está incluído na notificação. |
isIndexable |
boolean |
Determina se ele é indexável. |
isLegacyAttribute |
boolean |
Determina se é um atributo herdado. |
isOptional |
boolean |
Determina se ele é opcional. |
isUnique |
boolean |
Determina se ele é exclusivo. |
name |
string |
O nome do atributo. |
options |
object |
As opções para o atributo. |
relationshipTypeName |
string |
O nome do tipo de relação. |
typeName |
string |
O nome do tipo. |
valuesMaxCount |
integer (int32) |
A contagem máxima dos valores. |
valuesMinCount |
integer (int32) |
A contagem mínima dos valores. |
AtlasRelationshipDef
AtlasRelationshipDef é um TypeDef que define uma relação. Assim como acontece com outros typeDefs, o AtlasRelationshipDef tem um nome. Depois de criado, o RelationshipDef tem um guid. O nome e o guid são as duas maneiras pelas quais o RelationshipDef é identificado. RelationshipDefs tem 2 extremidades, cada uma das quais especifica cardinalidade, nome e nome do tipo EntityDef e, opcionalmente, se o final é um contêiner. RelationshipDefs pode ter AttributeDefs , embora apenas tipos primitivos sejam permitidos. RelationshipDefs tem um relationshipCategory especificando o tipo uml de relação necessário A maneira como EntityDefs e RelationshipDefs devem ser usados é que EntityDefs definirá AttributeDefs esses AttributeDefs não especificarão um nome de tipo EntityDef como seus tipos. RelationshipDefs introduz novos atributos às instâncias de entidade. Por exemplo, EntityDef A pode ter atributos attr1,attr2,attr3
EntityDef B pode ter atributos attr4,attr5,attr6 RelationshipDef AtoB pode definir 2 extremidades
end1: tipo A, nome attr7 end2: tipo B, nome attr8
Quando uma instância do EntityDef A for criada, ela terá atributos attr1,attr2,attr3,attr7 Quando uma instância do EntityDef B for criada, ela terá atributos attr4,attr5,attr6,attr8
Dessa forma, relationshipDefs pode ser criado separadamente de entityDefs e pode injetar atributos de relação nas instâncias de entidade
Nome | Tipo | Description |
---|---|---|
attributeDefs |
Uma matriz de definições de atributo. |
|
category |
A enumeração de categoria de tipo. |
|
createTime |
integer (int64) |
A hora criada do registro. |
createdBy |
string |
O usuário que criou o registro. |
dateFormatter |
O formato da data. |
|
description |
string |
A descrição da definição de tipo. |
endDef1 |
O relationshipEndDef representa o fim da relação. O final da relação é definido por um tipo, um nome de atributo, cardinalidade e se é o final do contêiner da relação. |
|
endDef2 |
O relationshipEndDef representa o fim da relação. O final da relação é definido por um tipo, um nome de atributo, cardinalidade e se é o final do contêiner da relação. |
|
guid |
string |
O GUID da definição de tipo. |
lastModifiedTS |
string |
ETag para controle de simultaneidade. |
name |
string |
O nome da definição de tipo. |
options |
object |
As opções para a definição de tipo. |
relationshipCategory |
A categoria Relação determina o estilo de relação em torno da contenção e do ciclo de vida. A terminologia UML é usada para os valores. ASSOCIATION é uma relação sem contenção. COMPOSITION e AGGREGATION são relações de contenção. A diferença está nos ciclos de vida do contêiner e de seus filhos. No caso COMPOSITION, os filhos não podem existir sem o contêiner. Para AGREGAÇÃO, os ciclos de vida do contêiner e das crianças são totalmente independentes. |
|
relationshipLabel |
string |
O rótulo da relação. |
serviceType |
string |
O tipo de serviço. |
typeVersion |
string |
A versão do tipo. |
updateTime |
integer (int64) |
A hora de atualização do registro. |
updatedBy |
string |
O usuário que atualizou o registro. |
version |
integer (int64) |
A versão do registro. |
AtlasRelationshipEndDef
O relationshipEndDef representa o fim da relação. O final da relação é definido por um tipo, um nome de atributo, cardinalidade e se é o final do contêiner da relação.
Nome | Tipo | Description |
---|---|---|
cardinality |
atributo de valor único ou atributo de vários valores. |
|
description |
string |
A descrição da definição de término da relação. |
isContainer |
boolean |
Determina se é contêiner. |
isLegacyAttribute |
boolean |
Determina se é um atributo herdado. |
name |
string |
O nome da definição de término da relação. |
type |
string |
O tipo do fim da relação. |
AtlasStructDef
classe que captura detalhes de um tipo de struct.
Nome | Tipo | Description |
---|---|---|
attributeDefs |
Uma matriz de definições de atributo. |
|
category |
A enumeração de categoria de tipo. |
|
createTime |
integer (int64) |
A hora criada do registro. |
createdBy |
string |
O usuário que criou o registro. |
dateFormatter |
O formato da data. |
|
description |
string |
A descrição da definição de tipo. |
guid |
string |
O GUID da definição de tipo. |
lastModifiedTS |
string |
ETag para controle de simultaneidade. |
name |
string |
O nome da definição de tipo. |
options |
object |
As opções para a definição de tipo. |
serviceType |
string |
O tipo de serviço. |
typeVersion |
string |
A versão do tipo. |
updateTime |
integer (int64) |
A hora de atualização do registro. |
updatedBy |
string |
O usuário que atualizou o registro. |
version |
integer (int64) |
A versão do registro. |
AtlasTypesDef
As definições de tipos.
Nome | Tipo | Description |
---|---|---|
businessMetadataDefs |
businessMetadataDefs |
|
classificationDefs |
Uma matriz de definições de classificação. |
|
entityDefs |
Uma matriz de definições de entidade. |
|
enumDefs |
Uma matriz de definições de enumeração. |
|
relationshipDefs |
Uma matriz de definições de relação. |
|
structDefs |
Uma matriz de definições de struct. |
|
termTemplateDefs |
Uma matriz de definições de modelo de termo. |
CardinalityValue
Cardinalidade
Valor | Description |
---|---|
LIST |
lista |
SET |
set |
SINGLE |
solteiro |
DateFormat
O formato da data.
Nome | Tipo | Description |
---|---|---|
availableLocales |
string[] |
Uma matriz de localidades disponíveis. |
calendar |
number (float) |
Calendário |
dateInstance |
O formato da data. |
|
dateTimeInstance |
O formato da data. |
|
instance |
O formato da data. |
|
lenient |
boolean |
Determina a leniência do formato de data. |
numberFormat |
O formato de número. |
|
timeInstance |
O formato da data. |
|
timeZone |
As informações de fuso horário. |
NumberFormat
O formato de número.
Nome | Tipo | Description |
---|---|---|
availableLocales |
string[] |
O formato de número. |
currency |
string |
A moeda. |
currencyInstance |
O formato de número. |
|
groupingUsed |
boolean |
Determina se o agrupamento é usado. |
instance |
O formato de número. |
|
integerInstance |
O formato de número. |
|
maximumFractionDigits |
integer (int32) |
O máximo de dígitos de fração. |
maximumIntegerDigits |
integer (int32) |
O máximo de dígitos inteiros. |
minimumFractionDigits |
integer (int32) |
O mínimo de dígitos de fração. |
minimumIntegerDigits |
integer (int32) |
O mínimo de dígitos inteiros. |
numberInstance |
O formato de número. |
|
parseIntegerOnly |
boolean |
Determina se apenas o inteiro é analisado. |
percentInstance |
O formato de número. |
|
roundingMode |
A enumeração do modo de arredondamento. |
RelationshipCategory
Categoria de relação
Valor | Description |
---|---|
AGGREGATION |
agregação |
ASSOCIATION |
associação |
COMPOSITION |
composição |
RoundingMode
Modo de arredondamento
Valor | Description |
---|---|
CEILING |
teto |
DOWN |
ligar |
FLOOR |
baixo |
HALF_DOWN |
metade para baixo |
HALF_EVEN |
metade par |
HALF_UP |
metade para cima |
UNNECESSARY |
desnecessário |
UP |
em cima |
TermTemplateDef
Definição de modelo de termo para o termo glossário.
Nome | Tipo | Description |
---|---|---|
attributeDefs |
Uma matriz de definições de atributo. |
|
category |
A enumeração de categoria de tipo. |
|
createTime |
integer (int64) |
A hora criada do registro. |
createdBy |
string |
O usuário que criou o registro. |
dateFormatter |
O formato da data. |
|
description |
string |
A descrição da definição de tipo. |
guid |
string |
O GUID da definição de tipo. |
lastModifiedTS |
string |
ETag para controle de simultaneidade. |
name |
string |
O nome da definição de tipo. |
options |
object |
As opções para a definição de tipo. |
serviceType |
string |
O tipo de serviço. |
typeVersion |
string |
A versão do tipo. |
updateTime |
integer (int64) |
A hora de atualização do registro. |
updatedBy |
string |
O usuário que atualizou o registro. |
version |
integer (int64) |
A versão do registro. |
TimeZone
As informações de fuso horário.
Nome | Tipo | Description |
---|---|---|
availableIds |
string[] |
Uma matriz de IDs disponíveis. |
default |
As informações de fuso horário. |
|
displayName |
string |
O nome de exibição do fuso horário. |
dstSavings |
integer (int32) |
O valor do horário de verão. |
id |
string |
A ID do fuso horário. |
rawOffset |
integer (int32) |
O deslocamento bruto do fuso horário. |
TypeCategory
Categoria de Tipo
Valor | Description |
---|---|
ARRAY |
array |
CLASSIFICATION |
classificação |
ENTITY |
entity |
ENUM |
enum |
MAP |
mapa |
OBJECT_ID_TYPE |
tipo de id de objeto |
PRIMITIVE |
primitivo |
RELATIONSHIP |
relacionamento |
STRUCT |
struct |
TERM_TEMPLATE |
modelo de termo |