Sign in

v3

latestSwagger 2.02026-07-139789260.9 KB

Get the struct definition for the given GUID.

get/atlas/v2/types/structdef/guid/{guid}

Path parameters

guidstring required

The globally unique identifier of the struct.

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.