Type - Bulk Create

サービス:

Purview

API バージョン:

2023-09-01

すべての atlas 型定義を一括で作成します。新しい定義のみが作成されます。 既存の定義に対する変更はすべて破棄されます。

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

URI パラメーター

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

要求本文

名前	型	説明
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 です。 他の typeDefs と同様に、AtlasRelationshipDef には名前があります。 作成されると、RelationshipDef には guid があります。 名前と guid は、RelationshipDef を識別する 2 つの方法です。 RelationshipDefs には 2 つの end があり、それぞれがカーディナリティ、EntityDef 型の名前と名前、および必要に応じて末尾がコンテナーであるかどうかを指定します。 RelationshipDefs は 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、名前 attr7 end2: 型 B、名前 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

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	値の最大カウント。
valuesMinCount	integer	値の最小数。

AtlasBusinessMetadataDef

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

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

AtlasClassificationDef

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

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

AtlasConstraintDef

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

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

AtlasEntityDef

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

名前	型	説明
attributeDefs	AtlasAttributeDef[]	属性定義の配列。
category	TypeCategory	category 型の列挙型。
createTime	integer	レコードの作成時刻。
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	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer	レコードのバージョン。

AtlasEnumDef

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

名前	型	説明
category	TypeCategory	category 型の列挙型。
createTime	integer	レコードの作成時刻。
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	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer	レコードのバージョン。

AtlasEnumElementDef

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

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

AtlasErrorResponse

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

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

AtlasRelationshipAttributeDef

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	値の最大数。
valuesMinCount	integer	値の最小数。

AtlasRelationshipDef

AtlasRelationshipDef は、リレーションシップを定義する TypeDef です。 他の typeDefs と同様に、AtlasRelationshipDef には名前があります。 作成されると、RelationshipDef には guid があります。 名前と guid は、RelationshipDef を識別する 2 つの方法です。 RelationshipDefs には 2 つの end があり、それぞれがカーディナリティ、EntityDef 型の名前と名前、および必要に応じて末尾がコンテナーであるかどうかを指定します。 RelationshipDefs は 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、名前 attr7 end2: 型 B、名前 attr8

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

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

名前	型	説明
attributeDefs	AtlasAttributeDef[]	属性定義の配列。
category	TypeCategory	category 型の列挙型。
createTime	integer	レコードの作成時刻。
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	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer	レコードのバージョン。

AtlasRelationshipEndDef

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

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

AtlasStructDef

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

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

AtlasTypesDef

型の定義。

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

CardinalityValue

カーディナリティ

名前	型	説明
LIST	string	list
SET	string	set
SINGLE	string	single

DateFormat

日付の形式。

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

NumberFormat

数値の形式。

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

RelationshipCategory

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

名前	型	説明
AGGREGATION	string	aggregation
ASSOCIATION	string	関連付け
COMPOSITION	string	組成

RoundingMode

丸めモード

名前	型	説明
CEILING	string	ceiling
DOWN	string	ダウン
FLOOR	string	floor
HALF_DOWN	string	ハーフダウン
HALF_EVEN	string	ハーフ偶数
HALF_UP	string	ハーフアップ
UNNECESSARY	string	unnecessary (不要)
UP	string	up

TermTemplateDef

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

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

TimeZone

タイムゾーン情報。

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

TypeCategory

データ型

名前	型	説明
ARRAY	string	array
CLASSIFICATION	string	分類
ENTITY	string	エンティティ
ENUM	string	enum
MAP	string	マップ
OBJECT_ID_TYPE	string	オブジェクト ID の種類
PRIMITIVE	string	プリミティブ
RELATIONSHIP	string	リレーションシップ
STRUCT	string	struct
TERM_TEMPLATE	string	用語テンプレート