Type - Bulk Create

Service:

Purview

API Version:

2023-09-01

Buat semua definisi jenis atlas secara massal, hanya definisi baru yang akan dibuat. Setiap perubahan pada definisi yang ada akan dibuang.

POST {endpoint}/datamap/api/atlas/v2/types/typedefs

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string

Isi Permintaan

Nama	Jenis	Deskripsi
businessMetadataDefs	AtlasBusinessMetadataDef[]	businessMetadataDefs
classificationDefs	AtlasClassificationDef[]	Array definisi klasifikasi.
entityDefs	AtlasEntityDef[]	Array definisi entitas.
enumDefs	AtlasEnumDef[]	Array definisi enum.
relationshipDefs	AtlasRelationshipDef[]	Array definisi hubungan.
structDefs	AtlasStructDef[]	Array definisi struct.
termTemplateDefs	TermTemplateDef[]	Array definisi templat istilah.

Respons

Nama	Jenis	Deskripsi
200 OK	AtlasTypesDef	Permintaan telah berhasil.
Other Status Codes	AtlasErrorResponse	Respons kesalahan yang tidak terduga.

Keamanan

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
https://purview.azure.net/.default

Contoh

Type_BulkCreate

Type_BulkCreateBusinessMetadataDefs

Type_BulkCreate

Sample Request

HTTP

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": []
}

Sample Response

Status code:

200

{
  "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

Sample Request

HTTP

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\"]"
          }
        }
      ]
    }
  ]
}

Sample Response

Status code:

200

{
  "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"
          }
        }
      ]
    }
  ]
}

Definisi

Nama	Deskripsi
AtlasAttributeDef	kelas yang menangkap detail atribut struct.
AtlasBusinessMetadataDef	kelas yang menangkap detail jenis struct.
AtlasClassificationDef	kelas yang menangkap detail jenis klasifikasi.
AtlasConstraintDef	kelas yang menangkap detail batasan.
AtlasEntityDef	kelas yang menangkap detail jenis entitas.
AtlasEnumDef	kelas yang menangkap detail jenis enum.
AtlasEnumElementDef	kelas yang menangkap detail elemen enum.
AtlasErrorResponse	Respons kesalahan dari layanan
AtlasRelationshipAttributeDef	RelationshipEndDef mewakili akhir hubungan. Akhir hubungan didefinisikan oleh jenis, nama atribut, kardinalitas, dan apakah itu akhir kontainer dari hubungan.
AtlasRelationshipDef	AtlasRelationshipDef adalah TypeDef yang mendefinisikan hubungan. Seperti halnya typeDefs lain, AtlasRelationshipDef memiliki nama. Setelah dibuat, RelationshipDef memiliki panduan. Nama dan guid adalah 2 cara agar RelationshipDef diidentifikasi. RelationshipDefs memiliki 2 ujung, yang masing-masing menentukan kardinalitas, nama dan nama jenis EntityDef dan secara opsional apakah akhir adalah kontainer. RelationshipDefs dapat memiliki AttributeDefs - meskipun hanya jenis primitif yang diizinkan. RelationshipDefs memiliki relationshipCategory yang menentukan jenis hubungan UML yang diperlukan Cara EntityDefs dan RelationshipDefs digunakan adalah bahwa EntityDefs akan menentukan AttributeDefs attributeDefs ini tidak akan menentukan nama jenis EntityDef sebagai jenisnya. RelationshipDefs memperkenalkan atribut baru ke instans entitas. Misalnya EntityDef A mungkin memiliki atribut attr1,attr2,attr3 EntityDef B mungkin memiliki atribut attr4,attr5,attr6 RelationshipDef AtoB mungkin menentukan 2 ujung end1: ketik A, name attr7 end2: type B, name attr8 Ketika instans EntityDef A dibuat, itu akan memiliki atribut attr1,attr2,attr3,attr7 Ketika instans EntityDef B dibuat, itu akan memiliki atribut attr4,attr5,attr6,attr8 Dengan cara ini relationshipDefs dapat ditulis secara terpisah dari entityDefs dan dapat menyuntikkan atribut hubungan ke dalam instans entitas
AtlasRelationshipEndDef	RelationshipEndDef mewakili akhir hubungan. Akhir hubungan didefinisikan oleh jenis, nama atribut, kardinalitas, dan apakah itu akhir kontainer dari hubungan.
AtlasStructDef	kelas yang menangkap detail jenis struct.
AtlasTypesDef	Definisi jenis.
CardinalityValue	Kardinalitas
DateFormat	Format tanggal.
NumberFormat	Format angka.
RelationshipCategory	Kategori Hubungan
RoundingMode	Mode Pembulatan
TermTemplateDef	Definisi templat istilah untuk istilah glosarium.
TimeZone	Informasi zona waktu.
TypeCategory	Kategori Jenis

AtlasAttributeDef

kelas yang menangkap detail atribut struct.

Nama	Jenis	Deskripsi
cardinality	CardinalityValue	atribut bernilai tunggal atau atribut multinilai.
constraints	AtlasConstraintDef[]	Array batasan.
defaultValue	string	Nilai default atribut .
description	string	Deskripsi atribut .
includeInNotification	boolean	Menentukan apakah itu disertakan dalam pemberitahuan.
isIndexable	boolean	Menentukan apakah dapat diindeks.
isOptional	boolean	Menentukan apakah itu opsional.
isUnique	boolean	Menentukan apakah unik.
name	string	Nama atribut .
options	object	Opsi untuk atribut .
typeName	string	Nama jenis.
valuesMaxCount	integer	Jumlah maksimum nilai.
valuesMinCount	integer	Jumlah minimum nilai.

AtlasBusinessMetadataDef

kelas yang menangkap detail jenis struct.

Nama	Jenis	Deskripsi
attributeDefs	AtlasAttributeDef[]	Array definisi atribut.
category	TypeCategory	Enum kategori jenis.
createTime	integer	Waktu rekaman yang dibuat.
createdBy	string	Pengguna yang membuat rekaman.
dateFormatter	DateFormat	Format tanggal.
description	string	Deskripsi definisi jenis.
guid	string	GUID dari definisi jenis.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
name	string	Nama definisi jenis.
options	object	Opsi untuk definisi jenis.
serviceType	string	Jenis layanan.
typeVersion	string	Versi jenis .
updateTime	integer	Waktu pembaruan rekaman.
updatedBy	string	Pengguna yang memperbarui rekaman.
version	integer	Versi rekaman.

AtlasClassificationDef

kelas yang menangkap detail jenis klasifikasi.

Nama	Jenis	Deskripsi
attributeDefs	AtlasAttributeDef[]	Array definisi atribut.
category	TypeCategory	Enum kategori jenis.
createTime	integer	Waktu rekaman yang dibuat.
createdBy	string	Pengguna yang membuat rekaman.
dateFormatter	DateFormat	Format tanggal.
description	string	Deskripsi definisi jenis.
entityTypes	string[]	Menentukan daftar nama entityType dalam classificationDef, memastikan bahwa klasifikasi hanya dapat diterapkan ke entityTypes tersebut. Subjenis apa pun dari jenis entitas mewarisi pembatasan. Setiap subjenis classificationDef mewarisi pembatasan entityTypes induk. Setiap subjenis classificationDef dapat membatasi pembatasan entityTypes induk lebih lanjut dengan menentukan subset entityTypes. Daftar entityTypes kosong ketika tidak ada batasan induk berarti tidak ada batasan. Daftar entityTypes kosong ketika ada batasan induk berarti subjenis mengambil pembatasan induk. Jika daftar entityTypes disediakan, di mana satu mewarisi dari yang lain, ini akan ditolak. Ini harus mendorong klasifikasi yang lebih bersihDefs.
guid	string	GUID dari definisi jenis.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
name	string	Nama definisi jenis.
options	object	Opsi untuk definisi jenis.
serviceType	string	Jenis layanan.
subTypes	string[]	Array sub jenis.
superTypes	string[]	Array jenis super.
typeVersion	string	Versi jenis .
updateTime	integer	Waktu pembaruan rekaman.
updatedBy	string	Pengguna yang memperbarui rekaman.
version	integer	Versi rekaman.

AtlasConstraintDef

kelas yang menangkap detail batasan.

Nama	Jenis	Deskripsi
params		Parameter definisi batasan.
type	string	Jenis batasan.

AtlasEntityDef

kelas yang menangkap detail jenis entitas.

Nama	Jenis	Deskripsi
attributeDefs	AtlasAttributeDef[]	Array definisi atribut.
category	TypeCategory	Enum kategori jenis.
createTime	integer	Waktu rekaman yang dibuat.
createdBy	string	Pengguna yang membuat rekaman.
dateFormatter	DateFormat	Format tanggal.
description	string	Deskripsi definisi jenis.
guid	string	GUID dari definisi jenis.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
name	string	Nama definisi jenis.
options	object	Opsi untuk definisi jenis.
relationshipAttributeDefs	AtlasRelationshipAttributeDef[]	Array atribut hubungan.
serviceType	string	Jenis layanan.
subTypes	string[]	Array sub jenis.
superTypes	string[]	Array jenis super.
typeVersion	string	Versi jenis .
updateTime	integer	Waktu pembaruan rekaman.
updatedBy	string	Pengguna yang memperbarui rekaman.
version	integer	Versi rekaman.

AtlasEnumDef

kelas yang menangkap detail jenis enum.

Nama	Jenis	Deskripsi
category	TypeCategory	Enum kategori jenis.
createTime	integer	Waktu rekaman yang dibuat.
createdBy	string	Pengguna yang membuat rekaman.
dateFormatter	DateFormat	Format tanggal.
defaultValue	string	Nilai default.
description	string	Deskripsi definisi jenis.
elementDefs	AtlasEnumElementDef[]	Array definisi elemen enum.
guid	string	GUID dari definisi jenis.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
name	string	Nama definisi jenis.
options	object	Opsi untuk definisi jenis.
serviceType	string	Jenis layanan.
typeVersion	string	Versi jenis .
updateTime	integer	Waktu pembaruan rekaman.
updatedBy	string	Pengguna yang memperbarui rekaman.
version	integer	Versi rekaman.

AtlasEnumElementDef

kelas yang menangkap detail elemen enum.

Nama	Jenis	Deskripsi
description	string	Deskripsi definisi elemen enum.
ordinal	integer	Ordinal definisi elemen enum.
value	string	Nilai definisi elemen enum.

AtlasErrorResponse

Respons kesalahan dari layanan

Nama	Jenis	Deskripsi
errorCode	string	Kode kesalahan.
errorMessage	string	Pesan kesalahan.
requestId	string	ID permintaan.

AtlasRelationshipAttributeDef

RelationshipEndDef mewakili akhir hubungan. Akhir hubungan didefinisikan oleh jenis, nama atribut, kardinalitas, dan apakah itu akhir kontainer dari hubungan.

Nama	Jenis	Deskripsi
cardinality	CardinalityValue	atribut bernilai tunggal atau atribut multinilai.
constraints	AtlasConstraintDef[]	Array batasan.
defaultValue	string	Nilai default atribut .
description	string	Deskripsi atribut .
includeInNotification	boolean	Menentukan apakah itu disertakan dalam pemberitahuan.
isIndexable	boolean	Menentukan apakah dapat diindeks.
isLegacyAttribute	boolean	Menentukan apakah itu adalah atribut warisan.
isOptional	boolean	Menentukan apakah itu opsional.
isUnique	boolean	Menentukan apakah unik.
name	string	Nama atribut .
options	object	Opsi untuk atribut .
relationshipTypeName	string	Nama jenis hubungan.
typeName	string	Nama jenis.
valuesMaxCount	integer	Jumlah maksimum nilai.
valuesMinCount	integer	Jumlah minimum nilai.

AtlasRelationshipDef

AtlasRelationshipDef adalah TypeDef yang mendefinisikan hubungan. Seperti halnya typeDefs lain, AtlasRelationshipDef memiliki nama. Setelah dibuat, RelationshipDef memiliki panduan. Nama dan guid adalah 2 cara agar RelationshipDef diidentifikasi. RelationshipDefs memiliki 2 ujung, yang masing-masing menentukan kardinalitas, nama dan nama jenis EntityDef dan secara opsional apakah akhir adalah kontainer. RelationshipDefs dapat memiliki AttributeDefs - meskipun hanya jenis primitif yang diizinkan. RelationshipDefs memiliki relationshipCategory yang menentukan jenis hubungan UML yang diperlukan Cara EntityDefs dan RelationshipDefs digunakan adalah bahwa EntityDefs akan menentukan AttributeDefs attributeDefs ini tidak akan menentukan nama jenis EntityDef sebagai jenisnya. RelationshipDefs memperkenalkan atribut baru ke instans entitas. Misalnya EntityDef A mungkin memiliki atribut attr1,attr2,attr3

EntityDef B mungkin memiliki atribut attr4,attr5,attr6 RelationshipDef AtoB mungkin menentukan 2 ujung

end1: ketik A, name attr7 end2: type B, name attr8

Ketika instans EntityDef A dibuat, itu akan memiliki atribut attr1,attr2,attr3,attr7 Ketika instans EntityDef B dibuat, itu akan memiliki atribut attr4,attr5,attr6,attr8

Dengan cara ini relationshipDefs dapat ditulis secara terpisah dari entityDefs dan dapat menyuntikkan atribut hubungan ke dalam instans entitas

Nama	Jenis	Deskripsi
attributeDefs	AtlasAttributeDef[]	Array definisi atribut.
category	TypeCategory	Enum kategori jenis.
createTime	integer	Waktu rekaman yang dibuat.
createdBy	string	Pengguna yang membuat rekaman.
dateFormatter	DateFormat	Format tanggal.
description	string	Deskripsi definisi jenis.
endDef1	AtlasRelationshipEndDef	RelationshipEndDef mewakili akhir hubungan. Akhir hubungan didefinisikan oleh jenis, nama atribut, kardinalitas, dan apakah itu akhir kontainer dari hubungan.
endDef2	AtlasRelationshipEndDef	RelationshipEndDef mewakili akhir hubungan. Akhir hubungan didefinisikan oleh jenis, nama atribut, kardinalitas, dan apakah itu akhir kontainer dari hubungan.
guid	string	GUID dari definisi jenis.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
name	string	Nama definisi jenis.
options	object	Opsi untuk definisi jenis.
relationshipCategory	RelationshipCategory	Kategori Hubungan menentukan gaya hubungan sekeliling penahanan dan siklus hidup. Terminologi UML digunakan untuk nilai. ASSOCIATION adalah hubungan tanpa penahanan. KOMPOSISI dan AGREGASI adalah hubungan penahanan. Perbedaan berada dalam siklus hidup kontainer dan anak-anaknya. Dalam kasus KOMPOSISI, turunan tidak dapat ada tanpa kontainer. Untuk AGREGASI, siklus hidup kontainer dan anak-anak benar-benar independen.
relationshipLabel	string	Label hubungan.
serviceType	string	Jenis layanan.
typeVersion	string	Versi jenis .
updateTime	integer	Waktu pembaruan rekaman.
updatedBy	string	Pengguna yang memperbarui rekaman.
version	integer	Versi rekaman.

AtlasRelationshipEndDef

RelationshipEndDef mewakili akhir hubungan. Akhir hubungan didefinisikan oleh jenis, nama atribut, kardinalitas, dan apakah itu akhir kontainer dari hubungan.

Nama	Jenis	Deskripsi
cardinality	CardinalityValue	atribut bernilai tunggal atau atribut multinilai.
description	string	Deskripsi definisi akhir hubungan.
isContainer	boolean	Menentukan apakah itu kontainer.
isLegacyAttribute	boolean	Menentukan apakah itu adalah atribut warisan.
name	string	Nama definisi akhir hubungan.
type	string	Jenis hubungan berakhir.

AtlasStructDef

kelas yang menangkap detail jenis struct.

Nama	Jenis	Deskripsi
attributeDefs	AtlasAttributeDef[]	Array definisi atribut.
category	TypeCategory	Enum kategori jenis.
createTime	integer	Waktu rekaman yang dibuat.
createdBy	string	Pengguna yang membuat rekaman.
dateFormatter	DateFormat	Format tanggal.
description	string	Deskripsi definisi jenis.
guid	string	GUID dari definisi jenis.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
name	string	Nama definisi jenis.
options	object	Opsi untuk definisi jenis.
serviceType	string	Jenis layanan.
typeVersion	string	Versi jenis .
updateTime	integer	Waktu pembaruan rekaman.
updatedBy	string	Pengguna yang memperbarui rekaman.
version	integer	Versi rekaman.

AtlasTypesDef

Definisi jenis.

Nama	Jenis	Deskripsi
businessMetadataDefs	AtlasBusinessMetadataDef[]	businessMetadataDefs
classificationDefs	AtlasClassificationDef[]	Array definisi klasifikasi.
entityDefs	AtlasEntityDef[]	Array definisi entitas.
enumDefs	AtlasEnumDef[]	Array definisi enum.
relationshipDefs	AtlasRelationshipDef[]	Array definisi hubungan.
structDefs	AtlasStructDef[]	Array definisi struct.
termTemplateDefs	TermTemplateDef[]	Array definisi templat istilah.

CardinalityValue

Kardinalitas

Nama	Jenis	Deskripsi
LIST	string	list
SET	string	set
SINGLE	string	Satu

DateFormat

Format tanggal.

Nama	Jenis	Deskripsi
availableLocales	string[]	Array lokal yang tersedia.
calendar	number	Kalender
dateInstance	DateFormat	Format tanggal.
dateTimeInstance	DateFormat	Format tanggal.
instance	DateFormat	Format tanggal.
lenient	boolean	Menentukan keringanan dari format tanggal.
numberFormat	NumberFormat	Format angka.
timeInstance	DateFormat	Format tanggal.
timeZone	TimeZone	Informasi zona waktu.

NumberFormat

Format angka.

Nama	Jenis	Deskripsi
availableLocales	string[]	Format angka.
currency	string	Mata uang.
currencyInstance	NumberFormat	Format angka.
groupingUsed	boolean	Menentukan apakah pengelompokan digunakan.
instance	NumberFormat	Format angka.
integerInstance	NumberFormat	Format angka.
maximumFractionDigits	integer	Maksimum digit pecahan.
maximumIntegerDigits	integer	Maksimum digit bilangan bulat.
minimumFractionDigits	integer	Minimum digit pecahan.
minimumIntegerDigits	integer	Minimum digit bilangan bulat.
numberInstance	NumberFormat	Format angka.
parseIntegerOnly	boolean	Menentukan apakah hanya bilangan bulat yang diurai.
percentInstance	NumberFormat	Format angka.
roundingMode	RoundingMode	Enum mode pembulatan.

RelationshipCategory

Kategori Hubungan

Nama	Jenis	Deskripsi
AGGREGATION	string	Agregasi
ASSOCIATION	string	asosiasi
COMPOSITION	string	Komposisi

RoundingMode

Mode Pembulatan

Nama	Jenis	Deskripsi
CEILING	string	ceiling
DOWN	string	ke bawah
FLOOR	string	floor
HALF_DOWN	string	setengah ke bawah
HALF_EVEN	string	setengah bahkan
HALF_UP	string	setengah ke atas
UNNECESSARY	string	tidak perlu
UP	string	ke atas

TermTemplateDef

Definisi templat istilah untuk istilah glosarium.

Nama	Jenis	Deskripsi
attributeDefs	AtlasAttributeDef[]	Array definisi atribut.
category	TypeCategory	Enum kategori jenis.
createTime	integer	Waktu rekaman yang dibuat.
createdBy	string	Pengguna yang membuat rekaman.
dateFormatter	DateFormat	Format tanggal.
description	string	Deskripsi definisi jenis.
guid	string	GUID dari definisi jenis.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
name	string	Nama definisi jenis.
options	object	Opsi untuk definisi jenis.
serviceType	string	Jenis layanan.
typeVersion	string	Versi jenis .
updateTime	integer	Waktu pembaruan rekaman.
updatedBy	string	Pengguna yang memperbarui rekaman.
version	integer	Versi rekaman.

TimeZone

Informasi zona waktu.

Nama	Jenis	Deskripsi
availableIds	string[]	Array ID yang tersedia.
default	TimeZone	Informasi zona waktu.
displayName	string	Nama tampilan zona waktu.
dstSavings	integer	Nilai waktu musim panas.
id	string	ID zona waktu.
rawOffset	integer	Offset mentah zona waktu.

TypeCategory

Kategori Jenis

Nama	Jenis	Deskripsi
ARRAY	string	array
CLASSIFICATION	string	classification
ENTITY	string	entitas
ENUM	string	enum
MAP	string	peta
OBJECT_ID_TYPE	string	jenis id objek
PRIMITIVE	string	Primitif
RELATIONSHIP	string	hubungan
STRUCT	string	Struktur
TERM_TEMPLATE	string	templat istilah