次の方法で共有


Type - List Headers

最小限の情報ヘッダーの一覧として返されるすべての型定義を一覧表示します。

GET {endpoint}/datamap/api/atlas/v2/types/typedefs/headers
GET {endpoint}/datamap/api/atlas/v2/types/typedefs/headers?api-version=2023-09-01&includeTermTemplate={includeTermTemplate}&type={type}

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

api-version
query

string

この操作に使用する API バージョン。

includeTermTemplate
query

boolean

すべての typedef を返すときに termtemplatedef を含めるかどうか。 これは、検索フィルターの種類=term_templateの場合に常に当てはまります

type
query

TypeCategory

typedef を取得するときの検索フィルターとしての Typedef 名。

応答

名前 説明
200 OK

AtlasTypeDefHeader[]

要求は成功しました。

Other Status Codes

AtlasErrorResponse

予期しないエラー応答。

セキュリティ

OAuth2Auth

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

スコープ

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

Type_ListHeaders

要求のサンプル

GET {endpoint}/datamap/api/atlas/v2/types/typedefs/headers?api-version=2023-09-01&includeTermTemplate=True

応答のサンプル

[
  {
    "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0",
    "name": "hive_principal_type",
    "category": "ENUM"
  },
  {
    "guid": "e5030e81-da05-4571-84f1-265ce20fa6d9",
    "name": "AtlasGlossaryTermRelationshipStatus",
    "category": "ENUM"
  },
  {
    "guid": "d776af9c-985c-4168-abb2-477523dbfc70",
    "name": "MS KPI",
    "category": "TERM_TEMPLATE"
  }
]

定義

名前 説明
AtlasErrorResponse

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

AtlasTypeDefHeader

型定義の基本情報。

TypeCategory

データ型

AtlasErrorResponse

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

名前 説明
errorCode

string

エラー コード。

errorMessage

string

エラー メッセージ。

requestId

string

要求 ID です。

AtlasTypeDefHeader

型定義の基本情報。

名前 説明
category

TypeCategory

category 型の列挙型。

guid

string

型定義の GUID。

name

string

型定義の名前。

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

用語テンプレート