Type - Bulk Create

サービス:: Purview

API バージョン:: 2023-09-01

すべての atlas 型定義を一括で作成します。既存の型は再作成しないでください。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)

要求本文

名前	型	説明
businessMetadataDefs	AtlasBusinessMetadataDef[]	businessMetadataDefs
classificationDefs	AtlasClassificationDef[]	分類定義の配列。
entityDefs	AtlasEntityDef[]	エンティティ定義の配列。
enumDefs	AtlasEnumDef[]	列挙型定義の配列。
relationshipDefs	AtlasRelationshipDef[]	リレーションシップ定義の配列。
structDefs	AtlasStructDef[]	構造体定義の配列。
termTemplateDefs	TermTemplateDef[]	用語テンプレート定義の配列。

応答

名前	型	説明
200 OK	AtlasTypesDef	要求は成功しました。
Other Status Codes	AtlasErrorResponse	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://purview.azure.net/.default

例

Type_BulkCreate

Type_BulkCreateBusinessMetadataDefs

Type_BulkCreate

要求のサンプル

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

応答のサンプル

状態コード:: 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

要求のサンプル

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

応答のサンプル

状態コード:: 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"
          }
        }
      ]
    }
  ]
}

定義

名前	説明
AtlasAttributeDef	struct-attribute の詳細をキャプチャするクラス。
AtlasBusinessMetadataDef	構造体型の詳細をキャプチャするクラス。
AtlasClassificationDef	分類型の詳細をキャプチャするクラス。
AtlasConstraintDef	制約の詳細をキャプチャするクラス。
AtlasEntityDef	エンティティ型の詳細をキャプチャするクラス。
AtlasEnumDef	列挙型の詳細をキャプチャするクラス。
AtlasEnumElementDef	列挙型要素の詳細をキャプチャするクラス。
AtlasErrorResponse	サービスからのエラー応答
AtlasRelationshipAttributeDef	relationshipEndDef は、リレーションシップの末尾を表します。リレーションシップの末尾は、型、属性名、カーディナリティ、およびリレーションシップのコンテナーの末尾であるかどうかによって定義されます。
AtlasRelationshipDef	AtlasRelationshipDef は、リレーションシップを定義する TypeDef です。他の typeDef と同様に、AtlasRelationshipDef には名前があります。作成されると、RelationshipDef には guid があります。名前と guid は、RelationshipDef を識別する 2 つの方法です。 RelationshipDef には 2 つの終了があり、それぞれカーディナリティ、EntityDef 型の名前と名前、および必要に応じて末尾がコンテナーであるかどうかを指定します。 RelationshipDef は AttributeDefs を持つことができますが、使用できるのはプリミティブ型のみです。 RelationshipDefs には、必要な UML 型のリレーションシップを指定する relationshipCategory があります。EntityDefs と RelationshipDefs の使用方法は、EntityDefs が AttributeDefs を定義する方法です。これらの AttributeDefs では、EntityDef 型名は型として指定されません。 RelationshipDefs では、エンティティインスタンスに新しい属性が導入されます。たとえば、EntityDef A には属性 attr1、attr2、attr3 が含まれます EntityDef B には属性 attr4、attr5、attr6 RelationshipDef AtoB が 2 つの終了を定義する場合があります end1: 型 A, name attr7 end2: type B, name attr8 EntityDef A のインスタンスが作成されると、属性 attr1、attr2、attr3、attr7 EntityDef B のインスタンスが作成されると、属性 attr4、attr5、attr6、attr8 が含まれますこのようにして、relationshipDefs は entityDefs とは別に作成でき、エンティティインスタンスにリレーションシップ属性を挿入できます。
AtlasRelationshipEndDef	relationshipEndDef は、リレーションシップの末尾を表します。リレーションシップの末尾は、型、属性名、カーディナリティ、およびリレーションシップのコンテナーの末尾であるかどうかによって定義されます。
AtlasStructDef	構造体型の詳細をキャプチャするクラス。
AtlasTypesDef	型の定義。
CardinalityValue	濃度
DateFormat	日付形式。
NumberFormat	数値の形式。
RelationshipCategory	リレーションシップカテゴリ
RoundingMode	丸めモード
TermTemplateDef	用語集の用語の用語テンプレート定義。
TimeZone	タイムゾーン情報。
TypeCategory	種類カテゴリ

AtlasAttributeDef

Object

struct-attribute の詳細をキャプチャするクラス。

名前	型	説明
cardinality	CardinalityValue	単一値属性または複数値属性。
constraints	AtlasConstraintDef[]	制約の配列。
defaultValue	string	属性の既定値。
description	string	属性の説明。
includeInNotification	boolean	通知に含まれるかどうかを判断します。
isIndexable	boolean	インデックスが作成可能かどうかを判断します。
isOptional	boolean	省略可能かどうかを判断します。
isUnique	boolean	一意かどうかを判断します。
name	string	属性の名前。
options	object	属性のオプション。
typeName	string	型の名前。
valuesMaxCount	integer (int32)	値の最大数。
valuesMinCount	integer (int32)	値の最小数。

AtlasBusinessMetadataDef

Object

構造体型の詳細をキャプチャするクラス。

名前	型	説明
attributeDefs	AtlasAttributeDef[]	属性定義の配列。
category	TypeCategory	カテゴリ型の列挙型。
createTime	integer (int64)	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
dateFormatter	DateFormat	日付形式。
description	string	型定義の説明。
guid	string	型定義の GUID。
lastModifiedTS	string	コンカレンシー制御の ETag。
name	string	型定義の名前。
options	object	型定義のオプション。
serviceType	string	サービスの種類。
typeVersion	string	型のバージョン。
updateTime	integer (int64)	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer (int64)	レコードのバージョン。

AtlasClassificationDef

Object

分類型の詳細をキャプチャするクラス。

名前	型	説明
attributeDefs	AtlasAttributeDef[]	属性定義の配列。
category	TypeCategory	カテゴリ型の列挙型。
createTime	integer (int64)	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
dateFormatter	DateFormat	日付形式。
description	string	型定義の説明。
entityTypes	string[]	classificationDef で entityType 名のリストを指定すると、分類はそれらの entityTypes にのみ適用できます。エンティティ型のすべてのサブタイプは、制限を継承します。 classificationDef サブタイプは、親 entityTypes 制限を継承します。 classificationDef サブタイプは、entityTypes のサブセットを指定することで、親 entityTypes の制限をさらに制限できます。親の制限がない場合に空の entityTypes リストは、制限がないことを意味します。親の制限がある場合に空の entityTypes リストは、サブタイプが親の制限を取得することを意味します。 entityTypes のリストが指定され、あるリストが別のエンティティから継承された場合、これは拒否されます。これにより、よりクリーンな分類の定義が促進されます。
guid	string	型定義の GUID。
lastModifiedTS	string	コンカレンシー制御の ETag。
name	string	型定義の名前。
options	object	型定義のオプション。
serviceType	string	サービスの種類。
subTypes	string[]	サブタイプの配列。
superTypes	string[]	スーパー型の配列。
typeVersion	string	型のバージョン。
updateTime	integer (int64)	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer (int64)	レコードのバージョン。

AtlasConstraintDef

Object

制約の詳細をキャプチャするクラス。

名前	型	説明
params		制約定義のパラメーター。
type	string	制約の型。

AtlasEntityDef

Object

エンティティ型の詳細をキャプチャするクラス。

名前	型	説明
attributeDefs	AtlasAttributeDef[]	属性定義の配列。
category	TypeCategory	カテゴリ型の列挙型。
createTime	integer (int64)	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
dateFormatter	DateFormat	日付形式。
description	string	型定義の説明。
guid	string	型定義の GUID。
lastModifiedTS	string	コンカレンシー制御の ETag。
name	string	型定義の名前。
options	object	型定義のオプション。
relationshipAttributeDefs	AtlasRelationshipAttributeDef[]	リレーションシップ属性の配列。
serviceType	string	サービスの種類。
subTypes	string[]	サブタイプの配列。
superTypes	string[]	スーパー型の配列。
typeVersion	string	型のバージョン。
updateTime	integer (int64)	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer (int64)	レコードのバージョン。

AtlasEnumDef

Object

列挙型の詳細をキャプチャするクラス。

名前	型	説明
category	TypeCategory	カテゴリ型の列挙型。
createTime	integer (int64)	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
dateFormatter	DateFormat	日付形式。
defaultValue	string	既定値。
description	string	型定義の説明。
elementDefs	AtlasEnumElementDef[]	列挙型要素定義の配列。
guid	string	型定義の GUID。
lastModifiedTS	string	コンカレンシー制御の ETag。
name	string	型定義の名前。
options	object	型定義のオプション。
serviceType	string	サービスの種類。
typeVersion	string	型のバージョン。
updateTime	integer (int64)	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer (int64)	レコードのバージョン。

AtlasEnumElementDef

Object

列挙型要素の詳細をキャプチャするクラス。

名前	型	説明
description	string	列挙型要素定義の説明。
ordinal	integer (int32)	列挙型要素定義の序数。
value	string	列挙型要素定義の値。

AtlasErrorResponse

Object

サービスからのエラー応答

名前	型	説明
errorCode	string	エラーコード。
errorMessage	string	エラーメッセージ。
requestId	string (uuid)	要求 ID。

AtlasRelationshipAttributeDef

Object

relationshipEndDef は、リレーションシップの末尾を表します。リレーションシップの末尾は、型、属性名、カーディナリティ、およびリレーションシップのコンテナーの末尾であるかどうかによって定義されます。

名前	型	説明
cardinality	CardinalityValue	単一値属性または複数値属性。
constraints	AtlasConstraintDef[]	制約の配列。
defaultValue	string	属性の既定値。
description	string	属性の説明。
includeInNotification	boolean	通知に含まれるかどうかを判断します。
isIndexable	boolean	インデックスが作成可能かどうかを判断します。
isLegacyAttribute	boolean	レガシ属性かどうかを判断します。
isOptional	boolean	省略可能かどうかを判断します。
isUnique	boolean	一意かどうかを判断します。
name	string	属性の名前。
options	object	属性のオプション。
relationshipTypeName	string	リレーションシップの種類の名前。
typeName	string	型の名前。
valuesMaxCount	integer (int32)	値の最大数。
valuesMinCount	integer (int32)	値の最小数。

AtlasRelationshipDef

Object

AtlasRelationshipDef は、リレーションシップを定義する TypeDef です。他の typeDef と同様に、AtlasRelationshipDef には名前があります。作成されると、RelationshipDef には guid があります。名前と guid は、RelationshipDef を識別する 2 つの方法です。 RelationshipDef には 2 つの終了があり、それぞれカーディナリティ、EntityDef 型の名前と名前、および必要に応じて末尾がコンテナーであるかどうかを指定します。 RelationshipDef は AttributeDefs を持つことができますが、使用できるのはプリミティブ型のみです。 RelationshipDefs には、必要な UML 型のリレーションシップを指定する relationshipCategory があります。EntityDefs と RelationshipDefs の使用方法は、EntityDefs が AttributeDefs を定義する方法です。これらの AttributeDefs では、EntityDef 型名は型として指定されません。 RelationshipDefs では、エンティティインスタンスに新しい属性が導入されます。たとえば、EntityDef A には属性 attr1、attr2、attr3 が含まれます

EntityDef B には属性 attr4、attr5、attr6 RelationshipDef AtoB が 2 つの終了を定義する場合があります

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

EntityDef A のインスタンスが作成されると、属性 attr1、attr2、attr3、attr7 EntityDef B のインスタンスが作成されると、属性 attr4、attr5、attr6、attr8 が含まれます

このようにして、relationshipDefs は entityDefs とは別に作成でき、エンティティインスタンスにリレーションシップ属性を挿入できます。

名前	型	説明
attributeDefs	AtlasAttributeDef[]	属性定義の配列。
category	TypeCategory	カテゴリ型の列挙型。
createTime	integer (int64)	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
dateFormatter	DateFormat	日付形式。
description	string	型定義の説明。
endDef1	AtlasRelationshipEndDef	relationshipEndDef は、リレーションシップの末尾を表します。リレーションシップの末尾は、型、属性名、カーディナリティ、およびリレーションシップのコンテナーの末尾であるかどうかによって定義されます。
endDef2	AtlasRelationshipEndDef	relationshipEndDef は、リレーションシップの末尾を表します。リレーションシップの末尾は、型、属性名、カーディナリティ、およびリレーションシップのコンテナーの末尾であるかどうかによって定義されます。
guid	string	型定義の GUID。
lastModifiedTS	string	コンカレンシー制御の ETag。
name	string	型定義の名前。
options	object	型定義のオプション。
relationshipCategory	RelationshipCategory	リレーションシップカテゴリは、包含とライフサイクルに関するリレーションシップのスタイルを決定します。値には UML 用語が使用されます。 ASSOCIATION は、包含のないリレーションシップです。 COMPOSITION と AGGREGATION は包含関係です。コンテナーとその子のライフサイクルにおける違い。 COMPOSITION の場合、子はコンテナーなしでは存在できません。 AGGREGATION の場合、コンテナーと子のライフサイクルは完全に独立しています。
relationshipLabel	string	リレーションシップのラベル。
serviceType	string	サービスの種類。
typeVersion	string	型のバージョン。
updateTime	integer (int64)	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer (int64)	レコードのバージョン。

AtlasRelationshipEndDef

Object

名前	型	説明
cardinality	CardinalityValue	単一値属性または複数値属性。
description	string	リレーションシップの終了定義の説明。
isContainer	boolean	コンテナーかどうかを判断します。
isLegacyAttribute	boolean	レガシ属性かどうかを判断します。
name	string	リレーションシップの終了定義の名前。
type	string	リレーションシップの終了の型。

AtlasStructDef

Object

構造体型の詳細をキャプチャするクラス。

名前	型	説明
attributeDefs	AtlasAttributeDef[]	属性定義の配列。
category	TypeCategory	カテゴリ型の列挙型。
createTime	integer (int64)	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
dateFormatter	DateFormat	日付形式。
description	string	型定義の説明。
guid	string	型定義の GUID。
lastModifiedTS	string	コンカレンシー制御の ETag。
name	string	型定義の名前。
options	object	型定義のオプション。
serviceType	string	サービスの種類。
typeVersion	string	型のバージョン。
updateTime	integer (int64)	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer (int64)	レコードのバージョン。

AtlasTypesDef

Object

型の定義。

名前	型	説明
businessMetadataDefs	AtlasBusinessMetadataDef[]	businessMetadataDefs
classificationDefs	AtlasClassificationDef[]	分類定義の配列。
entityDefs	AtlasEntityDef[]	エンティティ定義の配列。
enumDefs	AtlasEnumDef[]	列挙型定義の配列。
relationshipDefs	AtlasRelationshipDef[]	リレーションシップ定義の配列。
structDefs	AtlasStructDef[]	構造体定義の配列。
termTemplateDefs	TermTemplateDef[]	用語テンプレート定義の配列。

CardinalityValue

列挙

濃度

値	説明
SINGLE	シングル
LIST	リスト
SET	set

DateFormat

Object

日付形式。

名前	型	説明
availableLocales	string[]	使用可能なロケールの配列。
calendar	number (float)	暦
dateInstance	DateFormat	日付形式。
dateTimeInstance	DateFormat	日付形式。
instance	DateFormat	日付形式。
lenient	boolean	日付形式の表示形式を決定します。
numberFormat	NumberFormat	数値の形式。
timeInstance	DateFormat	日付形式。
timeZone	TimeZone	タイムゾーン情報。

NumberFormat

Object

数値の形式。

名前	型	説明
availableLocales	string[]	数値の形式。
currency	string	通貨。
currencyInstance	NumberFormat	数値の形式。
groupingUsed	boolean	グループ化を使用するかどうかを決定します。
instance	NumberFormat	数値の形式。
integerInstance	NumberFormat	数値の形式。
maximumFractionDigits	integer (int32)	小数部の最大桁数。
maximumIntegerDigits	integer (int32)	整数の最大桁数。
minimumFractionDigits	integer (int32)	小数部の最小桁数。
minimumIntegerDigits	integer (int32)	整数の最小桁数。
numberInstance	NumberFormat	数値の形式。
parseIntegerOnly	boolean	整数のみが解析されるかどうかを判断します。
percentInstance	NumberFormat	数値の形式。
roundingMode	RoundingMode	丸めモードの列挙型。

RelationshipCategory

列挙

リレーションシップカテゴリ

値	説明
ASSOCIATION	関連付け
AGGREGATION	集計
COMPOSITION	組成

RoundingMode

列挙

丸めモード

値	説明
UP	上
DOWN	ダウン
CEILING	天井
FLOOR	floor
HALF_UP	ハーフアップ
HALF_DOWN	半減
HALF_EVEN	半分の偶数
UNNECESSARY	不必要

TermTemplateDef

Object

用語集の用語の用語テンプレート定義。

名前	型	説明
attributeDefs	AtlasAttributeDef[]	属性定義の配列。
category	TypeCategory	カテゴリ型の列挙型。
createTime	integer (int64)	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
dateFormatter	DateFormat	日付形式。
description	string	型定義の説明。
guid	string	型定義の GUID。
lastModifiedTS	string	コンカレンシー制御の ETag。
name	string	型定義の名前。
options	object	型定義のオプション。
serviceType	string	サービスの種類。
typeVersion	string	型のバージョン。
updateTime	integer (int64)	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer (int64)	レコードのバージョン。

TimeZone

Object

タイムゾーン情報。

名前	型	説明
availableIds	string[]	使用可能な ID の配列。
default	TimeZone	タイムゾーン情報。
displayName	string	タイムゾーンの表示名。
dstSavings	integer (int32)	夏時間の値。
id	string	タイムゾーンの ID。
rawOffset	integer (int32)	タイムゾーンの生オフセット。

TypeCategory

列挙

種類カテゴリ

値	説明
PRIMITIVE	原始的
OBJECT_ID_TYPE	オブジェクト ID の種類
ENUM	列挙型
STRUCT	構造体
CLASSIFICATION	分類
ENTITY	エンティティ
ARRAY	アレイ
MAP	マップ
RELATIONSHIP	リレーションシップ
TERM_TEMPLATE	用語テンプレート

次の方法で共有

Type - Bulk Create

URI パラメーター

要求本文

応答

セキュリティ

OAuth2Auth

スコープ

例

Type_BulkCreate

要求のサンプル

応答のサンプル

Type_BulkCreateBusinessMetadataDefs

要求のサンプル

応答のサンプル

定義

AtlasAttributeDef

AtlasBusinessMetadataDef

AtlasClassificationDef

AtlasConstraintDef

AtlasEntityDef

AtlasEnumDef

AtlasEnumElementDef

AtlasErrorResponse

AtlasRelationshipAttributeDef

AtlasRelationshipDef

AtlasRelationshipEndDef

AtlasStructDef

AtlasTypesDef

CardinalityValue

DateFormat

NumberFormat

RelationshipCategory

RoundingMode

TermTemplateDef

TimeZone

TypeCategory