Sign in

v3

latestSwagger 2.02026-07-139789260.9 KB

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

get/atlas/v2/types/typedefs/headers

Query parameters

api-versionstring

The API version to use for this operation.

includeTermTemplateboolean

Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template

type'PRIMITIVE' | 'OBJECT_ID_TYPE' | 'ENUM' | 'STRUCT' | 'CLASSIFICATION' | 'ENTITY' | 'ARRAY' | 'MAP' | 'RELATIONSHIP' | 'TERM_TEMPLATE'

Typedef name as search filter when get typedefs.

Response

The request has succeeded.

category'PRIMITIVE' | 'OBJECT_ID_TYPE' | 'ENUM' | 'STRUCT' | 'CLASSIFICATION' | 'ENTITY' | 'ARRAY' | 'MAP' | 'RELATIONSHIP' | 'TERM_TEMPLATE'

Type Category

guidstring

The GUID of the type definition.

namestring

The name of the type definition.