Type - List Headers

Reference

Service:: Purview

API Version:: 2023-09-01

List all type definitions returned as a list of minimal information header.

GET {endpoint}/datamap/api/atlas/v2/types/typedefs/headers

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
api-version	query		string	The API version to use for this operation.
includeTermTemplate	query		boolean	Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template
type	query		TypeCategory	Typedef name as search filter when get typedefs.

Responses

Name	Type	Description
200 OK	AtlasTypeDefHeader[]	The request has succeeded.
Other Status Codes	AtlasErrorResponse	An unexpected error response.

Security

OAuth2Auth

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

Scopes

Name	Description
https://purview.azure.net/.default

Examples

Type_ListHeaders

Sample request

HTTP

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

Sample response

Status code:: 200

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

Definitions

Name	Description
AtlasErrorResponse	An error response from the service
AtlasTypeDefHeader	The basic information of the type definition.
TypeCategory	Type Category

AtlasErrorResponse

An error response from the service

Name	Type	Description
errorCode	string	The error code.
errorMessage	string	The error message.
requestId	string	The request ID.

AtlasTypeDefHeader

The basic information of the type definition.

Name	Type	Description
category	TypeCategory	The enum of type category.
guid	string	The GUID of the type definition.
name	string	The name of the type definition.

TypeCategory

Type Category

Name	Type	Description
ARRAY	string	array
CLASSIFICATION	string	classification
ENTITY	string	entity
ENUM	string	enum
MAP	string	map
OBJECT_ID_TYPE	string	object id type
PRIMITIVE	string	primitive
RELATIONSHIP	string	relationship
STRUCT	string	struct
TERM_TEMPLATE	string	term template

Share via