Glossary - Create Category
Create a glossary category.
POST {endpoint}/datamap/api/atlas/v2/glossary/category
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Request Body
Name | Type | Description |
---|---|---|
anchor |
The glossary header with basic information. |
|
childrenCategories |
An array of children categories. |
|
classifications |
An array of classifications. |
|
createTime |
integer |
The created time of the record. |
createdBy |
string |
The user who created the record. |
guid |
string |
The GUID of the object. |
lastModifiedTS |
string |
ETag for concurrency control. |
longDescription |
string |
The long version description. |
name |
string |
The name of the glossary object. |
parentCategory |
The header of the related category. |
|
qualifiedName |
string |
The qualified name of the glossary object. |
shortDescription |
string |
The short version of description. |
terms |
An array of related term headers. |
|
updateTime |
integer |
The update time of the record. |
updatedBy |
string |
The user who updated the record. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
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_CreateCategory
Sample request
POST {endpoint}/datamap/api/atlas/v2/glossary/category
{
"anchor": {
"glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
},
"name": "ExampleCategory1",
"terms": [
{
"termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea"
}
]
}
Sample response
{
"guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
"qualifiedName": "ExampleCategory1@Glossary",
"name": "ExampleCategory1",
"lastModifiedTS": "1",
"anchor": {
"glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
"relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
},
"terms": [
{
"termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
"relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
"displayText": "ExampleTerm1"
}
]
}
Definitions
Name | Description |
---|---|
Atlas |
An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. |
Atlas |
An error response from the service |
Atlas |
The glossary category. |
Atlas |
The glossary header with basic information. |
Atlas |
The header of the related category. |
Atlas |
The header of the related term. |
Atlas |
Status for atlas term relationship |
Entity |
Status - can be active or deleted |
Time |
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 |
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 |
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. |
AtlasGlossaryCategory
The glossary category.
Name | Type | Description |
---|---|---|
anchor |
The glossary header with basic information. |
|
childrenCategories |
An array of children categories. |
|
classifications |
An array of classifications. |
|
createTime |
integer |
The created time of the record. |
createdBy |
string |
The user who created the record. |
guid |
string |
The GUID of the object. |
lastModifiedTS |
string |
ETag for concurrency control. |
longDescription |
string |
The long version description. |
name |
string |
The name of the glossary object. |
parentCategory |
The header of the related category. |
|
qualifiedName |
string |
The qualified name of the glossary object. |
shortDescription |
string |
The short version of description. |
terms |
An array of related term headers. |
|
updateTime |
integer |
The update time of the record. |
updatedBy |
string |
The user who updated the record. |
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. |
AtlasRelatedCategoryHeader
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
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 |
The status of term relationship. |
|
steward |
string |
The steward of the term. |
termGuid |
string |
The GUID of the term. |
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. |
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. |