Glossary - Create Term

Service:

Purview

API Version:

2023-09-01

Create a glossary term.

POST {endpoint}/datamap/api/atlas/v2/glossary/term

With optional parameters:

POST {endpoint}/datamap/api/atlas/v2/glossary/term?includeTermHierarchy={includeTermHierarchy}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
includeTermHierarchy	query		boolean	Whether include term hierarchy

Request Body

Name	Type	Description
abbreviation	string	The abbreviation of the term.
anchor	AtlasGlossaryHeader	The glossary header with basic information.
antonyms	AtlasRelatedTermHeader[]	An array of related term headers as antonyms.
assignedEntities	AtlasRelatedObjectId[]	An array of related object IDs.
attributes	object	The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.
categories	AtlasTermCategorizationHeader[]	An array of term categorization headers.
classifications	AtlasClassification[]	An array of classifications.
classifies	AtlasRelatedTermHeader[]	An array of related term headers.
contacts	object	The dictionary of contacts for terms. Key could be Expert or Steward.
createTime	integer	The created time of the record.
createdBy	string	The user who created the record.
examples	string[]	An array of examples.
guid	string	The GUID of the object.
hierarchyInfo	PurviewObjectId[]	The hierarchy information of the term.
isA	AtlasRelatedTermHeader[]	An array of related term headers indicating the is-a relationship.
lastModifiedTS	string	ETag for concurrency control.
longDescription	string	The long version description.
name	string	The name of the glossary object.
nickName	string	The nick name of the term.
preferredTerms	AtlasRelatedTermHeader[]	An array of preferred related term headers.
preferredToTerms	AtlasRelatedTermHeader[]	An array of related term headers that are preferred to.
qualifiedName	string	The qualified name of the glossary object.
replacedBy	AtlasRelatedTermHeader[]	An array of related term headers that are replaced by.
replacementTerms	AtlasRelatedTermHeader[]	An array of related term headers for replacement.
resources	ResourceLink[]	An array of resource link for term
seeAlso	AtlasRelatedTermHeader[]	An array of related term headers for see also.
shortDescription	string	The short version of description.
status	TermStatus	Status of the AtlasGlossaryTerm
synonyms	AtlasRelatedTermHeader[]	An array of related term headers as synonyms.
templateName	TemplateName[]	The name of the template.
translatedTerms	AtlasRelatedTermHeader[]	An array of translated related term headers.
translationTerms	AtlasRelatedTermHeader[]	An array of related term headers for translation.
updateTime	integer	The update time of the record.
updatedBy	string	The user who updated the record.
usage	string	The usage of the term.
validValues	AtlasRelatedTermHeader[]	An array of related term headers as valid values.
validValuesFor	AtlasRelatedTermHeader[]	An array of related term headers as valid values for other records.

Responses

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

Glossary_CreateTerm

Glossary_CreateTermWithTemplate

Glossary_CreateTerm

Sample request

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/term

{
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "abbreviation": "T1",
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward info"
      }
    ]
  }
}

Sample response

Status code:

200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "abbreviation": "T1",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  }
}

Glossary_CreateTermWithTemplate

Sample request

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/term

{
  "name": "ExampleTerm",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
  },
  "attributes": {
    "ExampleTermTemplateAttribute": {
      "plain string": "Example String",
      "date": 1606233600000,
      "single choice": "Example Single Choice A",
      "multi choice": [
        "Example Multi Choice A",
        "Example Multi Choice B"
      ]
    }
  }
}

Sample response

Status code:

200

{
  "guid": "9390cc82-1077-403e-a4d2-b6a69834707b",
  "qualifiedName": "ExampleTerm@Glossary",
  "name": "ExampleTerm",
  "lastModifiedTS": "1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "attributes": {
    "ExampleTermTemplateAttribute": {
      "plain string": "Example String",
      "date": 1606233600000,
      "single choice": "Example Single Choice A",
      "multi choice": [
        "Example Multi Choice A",
        "Example Multi Choice B"
      ]
    }
  }
}

Definitions

Name	Description
AtlasClassification	An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
AtlasErrorResponse	An error response from the service
AtlasGlossaryHeader	The glossary header with basic information.
AtlasGlossaryTerm	The glossary term.
AtlasRelatedObjectId	Reference to an object-instance of AtlasEntity type used in relationship attribute values
AtlasRelatedTermHeader	The header of the related term.
AtlasStruct	Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader	The basic information for term categorization.
AtlasTermRelationshipStatus	Status for atlas term relationship
EntityStatus	Status - can be active or deleted
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	Status for atlas relationship
TermStatus	Status for term
TimeBoundary	Captures time-boundary details

AtlasClassification

An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.

Name	Type	Description
attributes		The attributes of the struct.
entityGuid	string	The GUID of the entity.
entityStatus	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
lastModifiedTS	string	ETag for concurrency control.
removePropagationsOnEntityDelete	boolean	Determines if propagations will be removed on entity deletion.
typeName	string	The name of the type.
validityPeriods	TimeBoundary[]	An array of time boundaries indicating validity periods.

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.

AtlasGlossaryHeader

The glossary header with basic information.

Name	Type	Description
displayText	string	The display text.
glossaryGuid	string	The GUID of the glossary.
relationGuid	string	The GUID of the relationship.

AtlasGlossaryTerm

The glossary term.

Name	Type	Description
abbreviation	string	The abbreviation of the term.
anchor	AtlasGlossaryHeader	The glossary header with basic information.
antonyms	AtlasRelatedTermHeader[]	An array of related term headers as antonyms.
assignedEntities	AtlasRelatedObjectId[]	An array of related object IDs.
attributes	object	The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.
categories	AtlasTermCategorizationHeader[]	An array of term categorization headers.
classifications	AtlasClassification[]	An array of classifications.
classifies	AtlasRelatedTermHeader[]	An array of related term headers.
contacts	object	The dictionary of contacts for terms. Key could be Expert or Steward.
createTime	integer	The created time of the record.
createdBy	string	The user who created the record.
examples	string[]	An array of examples.
guid	string	The GUID of the object.
hierarchyInfo	PurviewObjectId[]	The hierarchy information of the term.
isA	AtlasRelatedTermHeader[]	An array of related term headers indicating the is-a relationship.
lastModifiedTS	string	ETag for concurrency control.
longDescription	string	The long version description.
name	string	The name of the glossary object.
nickName	string	The nick name of the term.
preferredTerms	AtlasRelatedTermHeader[]	An array of preferred related term headers.
preferredToTerms	AtlasRelatedTermHeader[]	An array of related term headers that are preferred to.
qualifiedName	string	The qualified name of the glossary object.
replacedBy	AtlasRelatedTermHeader[]	An array of related term headers that are replaced by.
replacementTerms	AtlasRelatedTermHeader[]	An array of related term headers for replacement.
resources	ResourceLink[]	An array of resource link for term
seeAlso	AtlasRelatedTermHeader[]	An array of related term headers for see also.
shortDescription	string	The short version of description.
status	TermStatus	Status of the AtlasGlossaryTerm
synonyms	AtlasRelatedTermHeader[]	An array of related term headers as synonyms.
templateName	TemplateName[]	The name of the template.
translatedTerms	AtlasRelatedTermHeader[]	An array of translated related term headers.
translationTerms	AtlasRelatedTermHeader[]	An array of related term headers for translation.
updateTime	integer	The update time of the record.
updatedBy	string	The user who updated the record.
usage	string	The usage of the term.
validValues	AtlasRelatedTermHeader[]	An array of related term headers as valid values.
validValuesFor	AtlasRelatedTermHeader[]	An array of related term headers as valid values for other records.

AtlasRelatedObjectId

Reference to an object-instance of AtlasEntity type used in relationship attribute values

Name	Type	Description
displayText	string	The display text.
entityStatus	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
guid	string	The GUID of the object.
relationshipAttributes	AtlasStruct	Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
relationshipGuid	string	The GUID of the relationship.
relationshipStatus	StatusAtlasRelationship	The enum of relationship status.
relationshipType	string	Relationship type
typeName	string	The name of the type.
uniqueAttributes		The unique attributes of the object.

AtlasRelatedTermHeader

The header of the related term.

Name	Type	Description
description	string	The description of the related term.
displayText	string	The display text.
expression	string	The expression of the term.
relationGuid	string	The GUID of the relationship.
status	AtlasTermRelationshipStatus	The status of term relationship.
steward	string	The steward of the term.
termGuid	string	The GUID of the term.

AtlasStruct

Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.

Name	Type	Description
attributes		The attributes of the struct.
lastModifiedTS	string	ETag for concurrency control.
typeName	string	The name of the type.

AtlasTermCategorizationHeader

The basic information for term categorization.

Name	Type	Description
categoryGuid	string	The GUID of the category.
description	string	The description of the record.
displayText	string	The display text.
relationGuid	string	The GUID of the relationship.
status	AtlasTermRelationshipStatus	The status of term relationship.

AtlasTermRelationshipStatus

Status for atlas term relationship

Name	Type	Description
ACTIVE	string	active
DEPRECATED	string	deprecated
DRAFT	string	draft
OBSOLETE	string	obsolete
OTHER	string	other

EntityStatus

Status - can be active or deleted

Name	Type	Description
ACTIVE	string	The status is active.
DELETED	string	The status is deleted.

PurviewObjectId

PurviewObjectId

Name	Type	Description
displayText	string	Display text
guid	string	The GUID of the object.
itemPath	string	Item path
name	string	Name
properties		Dictionary of
resourceId	string	Resource Id
typeName	string	The name of the type.
uniqueAttributes		The unique attributes of the object.

ResourceLink

ResourceLink

Name	Type	Description
displayName	string	Display name for url.
url	string	web url. http or https

StatusAtlasRelationship

Status for atlas relationship

Name	Type	Description
ACTIVE	string	active
DELETED	string	deleted

TermStatus

Status for term

Name	Type	Description
Alert	string	alert
Approved	string	approved
Draft	string	draft
Expired	string	expired

TimeBoundary

Captures time-boundary details

Name	Type	Description
endTime	string	The end of the time boundary.
startTime	string	The start of the time boundary.
timeZone	string	The timezone of the time boundary.