Sign in

v3

latestSwagger 2.02026-07-139789260.9 KB

Get the type definition by its name (unique).

get/atlas/v2/types/typedef/name/{name}

Path parameters

namestring required

The name of the type.

Response

The request has succeeded.

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

Type Category

createTimeinteger

The created time of the record.

createdBystring

The user who created the record.

descriptionstring

The description of the type definition.

guidstring

The GUID of the type definition.

namestring

The name of the type definition.

optionsobject

The options for the type definition.

serviceTypestring

The service type.

typeVersionstring

The version of the type.

updateTimeinteger

The update time of the record.

updatedBystring

The user who updated the record.

versioninteger

The version of the record.

lastModifiedTSstring

ETag for concurrency control.

entityTypesstring[]

Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes.

Any subtypes of the entity types inherit the restriction.

Any classificationDef subtypes inherit the parents entityTypes restrictions.

Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes.

An empty entityTypes list when there are no parent restrictions means there are no restrictions.

An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions.

If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs.

subTypesstring[]

An array of sub types.

superTypesstring[]

An array of super types.

defaultValuestring

The default value.

relationshipCategory'ASSOCIATION' | 'AGGREGATION' | 'COMPOSITION'

Relationship Category

relationshipLabelstring

The label of the relationship.