Type - Get By Name

Service:

Purview

API Version:

2023-09-01

Get the type definition by its name (unique).

GET {endpoint}/datamap/api/atlas/v2/types/typedef/name/{name}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
name	path	True	string	The name of the type.

Responses

Name	Type	Description
200 OK	AtlasTypeDef	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_GetByName

Sample Request

HTTP

GET {endpoint}/datamap/api/atlas/v2/types/typedef/name/glossary_term_status_value

Sample Response

Status code:

200

{
  "category": "ENUM",
  "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1604728877305,
  "updateTime": 1604728877305,
  "version": 1,
  "name": "glossary_term_status_value",
  "description": "glossary_term_status_value",
  "typeVersion": "1.0",
  "lastModifiedTS": "1",
  "elementDefs": [
    {
      "value": "Approved",
      "ordinal": 0
    },
    {
      "value": "Alert",
      "ordinal": 1
    },
    {
      "value": "Expired",
      "ordinal": 2
    },
    {
      "value": "Draft",
      "ordinal": 3
    }
  ]
}

Definitions

Name	Description
AtlasAttributeDef	class that captures details of a struct-attribute.
AtlasConstraintDef	class that captures details of a constraint.
AtlasEnumElementDef	class that captures details of an enum-element.
AtlasErrorResponse	An error response from the service
AtlasRelationshipAttributeDef	The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.
AtlasRelationshipEndDef	The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.
AtlasTypeDef	The definitions of type.
CardinalityValue	Cardinality
DateFormat	The date format.
NumberFormat	The number format.
RelationshipCategory	Relationship Category
RoundingMode	Rounding Mode
TimeZone	The timezone information.
TypeCategory	Type Category

AtlasAttributeDef

class that captures details of a struct-attribute.

Name	Type	Description
cardinality	CardinalityValue	single-valued attribute or multi-valued attribute.
constraints	AtlasConstraintDef[]	An array of constraints.
defaultValue	string	The default value of the attribute.
description	string	The description of the attribute.
includeInNotification	boolean	Determines if it is included in notification.
isIndexable	boolean	Determines if it is indexable.
isOptional	boolean	Determines if it is optional.
isUnique	boolean	Determines if it unique.
name	string	The name of the attribute.
options	object	The options for the attribute.
typeName	string	The name of the type.
valuesMaxCount	integer	The maximum count of the values.
valuesMinCount	integer	The minimum count of the values.

AtlasConstraintDef

class that captures details of a constraint.

Name	Type	Description
params		The parameters of the constraint definition.
type	string	The type of the constraint.

AtlasEnumElementDef

class that captures details of an enum-element.

Name	Type	Description
description	string	The description of the enum element definition.
ordinal	integer	The ordinal of the enum element definition.
value	string	The value of the enum element definition.

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.

AtlasRelationshipAttributeDef

The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.

Name	Type	Description
cardinality	CardinalityValue	single-valued attribute or multi-valued attribute.
constraints	AtlasConstraintDef[]	An array of constraints.
defaultValue	string	The default value of the attribute.
description	string	The description of the attribute.
includeInNotification	boolean	Determines if it is included in notification.
isIndexable	boolean	Determines if it is indexable.
isLegacyAttribute	boolean	Determines if it is a legacy attribute.
isOptional	boolean	Determines if it is optional.
isUnique	boolean	Determines if it unique.
name	string	The name of the attribute.
options	object	The options for the attribute.
relationshipTypeName	string	The name of the relationship type.
typeName	string	The name of the type.
valuesMaxCount	integer	The maximum count of the values.
valuesMinCount	integer	The minimum count of the values.

AtlasRelationshipEndDef

The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.

Name	Type	Description
cardinality	CardinalityValue	single-valued attribute or multi-valued attribute.
description	string	The description of the relationship end definition.
isContainer	boolean	Determines if it is container.
isLegacyAttribute	boolean	Determines if it is a legacy attribute.
name	string	The name of the relationship end definition.
type	string	The type of the relationship end.

AtlasTypeDef

The definitions of type.

Name	Type	Description
attributeDefs	AtlasAttributeDef[]	An array of attribute definitions.
category	TypeCategory	The enum of type category.
createTime	integer	The created time of the record.
createdBy	string	The user who created the record.
dateFormatter	DateFormat	The date format.
defaultValue	string	The default value.
description	string	The description of the type definition.
elementDefs	AtlasEnumElementDef[]	An array of enum element definitions.
endDef1	AtlasRelationshipEndDef	The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.
endDef2	AtlasRelationshipEndDef	The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.
entityTypes	string[]	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.
guid	string	The GUID of the type definition.
lastModifiedTS	string	ETag for concurrency control.
name	string	The name of the type definition.
options	object	The options for the type definition.
relationshipAttributeDefs	AtlasRelationshipAttributeDef[]	An array of relationship attributes.
relationshipCategory	RelationshipCategory	The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent.
relationshipLabel	string	The label of the relationship.
serviceType	string	The service type.
subTypes	string[]	An array of sub types.
superTypes	string[]	An array of super types.
typeVersion	string	The version of the type.
updateTime	integer	The update time of the record.
updatedBy	string	The user who updated the record.
version	integer	The version of the record.

CardinalityValue

Cardinality

Name	Type	Description
LIST	string	list
SET	string	set
SINGLE	string	single

DateFormat

The date format.

Name	Type	Description
availableLocales	string[]	An array of available locales.
calendar	number	Calendar
dateInstance	DateFormat	The date format.
dateTimeInstance	DateFormat	The date format.
instance	DateFormat	The date format.
lenient	boolean	Determines the leniency of the date format.
numberFormat	NumberFormat	The number format.
timeInstance	DateFormat	The date format.
timeZone	TimeZone	The timezone information.

NumberFormat

The number format.

Name	Type	Description
availableLocales	string[]	The number format.
currency	string	The currency.
currencyInstance	NumberFormat	The number format.
groupingUsed	boolean	Determines if grouping is used.
instance	NumberFormat	The number format.
integerInstance	NumberFormat	The number format.
maximumFractionDigits	integer	The maximum of fraction digits.
maximumIntegerDigits	integer	The maximum of integer digits.
minimumFractionDigits	integer	The minimum of fraction digits.
minimumIntegerDigits	integer	The minimum of integer digits.
numberInstance	NumberFormat	The number format.
parseIntegerOnly	boolean	Determines if only integer is parsed.
percentInstance	NumberFormat	The number format.
roundingMode	RoundingMode	The enum of rounding mode.

RelationshipCategory

Relationship Category

Name	Type	Description
AGGREGATION	string	aggregation
ASSOCIATION	string	association
COMPOSITION	string	composition

RoundingMode

Rounding Mode

Name	Type	Description
CEILING	string	ceiling
DOWN	string	down
FLOOR	string	floor
HALF_DOWN	string	half down
HALF_EVEN	string	half even
HALF_UP	string	half up
UNNECESSARY	string	unnecessary
UP	string	up

TimeZone

The timezone information.

Name	Type	Description
availableIds	string[]	An array of available IDs.
default	TimeZone	The timezone information.
displayName	string	The display name of the timezone.
dstSavings	integer	The value of the daylight saving time.
id	string	The ID of the timezone.
rawOffset	integer	The raw offset of the timezone.

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