Share via

Glossary - Create

Service:
Purview
API Version:
2023-09-01

Create a glossary.

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

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

Request Body

Name Type Description
categories

AtlasRelatedCategoryHeader[]

An array of categories.
classifications

AtlasClassification[]

An array of classifications.
createTime

integer (int64)

The created time of the record.
createdBy

string

The user who created the record.
guid

string

The GUID of the object.
language

string

The language of the glossary.
lastModifiedTS

string

ETag for concurrency control.
longDescription

string

The long version description.
name

string

The name of the glossary object.
qualifiedName

string

The qualified name of the glossary object.
shortDescription

string

The short version of description.
terms

AtlasRelatedTermHeader[]

An array of related term headers.
updateTime

integer (int64)

The update time of the record.
updatedBy

string

The user who updated the record.
usage

string

The usage of the glossary.

Responses

Name Type Description
200 OK

AtlasGlossary

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_Create

Sample request

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

{
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "language": "en",
  "usage": "Example Glossary"
}

Sample response

Status code:
200 
{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "lastModifiedTS": "1",
  "language": "en",
  "usage": "Example Glossary",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1672892675688,
  "updateTime": 1672892675688
}

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
AtlasGlossary

The glossary object.
AtlasRelatedCategoryHeader

The header of the related category.
AtlasRelatedTermHeader

The header of the related term.
AtlasTermRelationshipStatus

Status for atlas term relationship
EntityStatus

Status - can be active or deleted
TimeBoundary

Captures time-boundary details

AtlasClassification

Object

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

Object

An error response from the service

Name Type Description
errorCode

string

The error code.
errorMessage

string

The error message.
requestId

string (uuid)

The request ID.

AtlasGlossary

Object

The glossary object.

Name Type Description
categories

AtlasRelatedCategoryHeader[]

An array of categories.
classifications

AtlasClassification[]

An array of classifications.
createTime

integer (int64)

The created time of the record.
createdBy

string

The user who created the record.
guid

string

The GUID of the object.
language

string

The language of the glossary.
lastModifiedTS

string

ETag for concurrency control.
longDescription

string

The long version description.
name

string

The name of the glossary object.
qualifiedName

string

The qualified name of the glossary object.
shortDescription

string

The short version of description.
terms

AtlasRelatedTermHeader[]

An array of related term headers.
updateTime

integer (int64)

The update time of the record.
updatedBy

string

The user who updated the record.
usage

string

The usage of the glossary.

AtlasRelatedCategoryHeader

Object

The header of the related category.

Name Type Description
categoryGuid

string

The GUID of the category.
description

string

The description of the category header.
displayText

string

The display text.
parentCategoryGuid

string

The GUID of the parent category.
relationGuid

string

The GUID of the relationship.

AtlasRelatedTermHeader

Object

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.

AtlasTermRelationshipStatus

Enumeration

Status for atlas term relationship

Value Description
DRAFT

draft
ACTIVE

active
DEPRECATED

deprecated
OBSOLETE

obsolete
OTHER

other

EntityStatus

Enumeration

Status - can be active or deleted

Value Description
ACTIVE

The status is active.
DELETED

The status is deleted.

TimeBoundary

Object

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.