Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Tags

Create Tag

Use this API to create a new tag in the Glossary.

🗒 Things to Know

  • The type parameter is case-sensitive. For example, use CATEGORY instead of Category.
post/api/glossary/v2/tags

Request body

namestring

Name of the tag

type'CATEGORY' | 'CLASSIFICATION' | 'BUSINESS_DOMAIN' | 'RETENTION' | 'ROT'

Type of the tag

descriptionstring

Short description about tag

Example request

{
  "name": "Financial",
  "type": "CATEGORY",
  "description": "This is the Financial information of customer"
}

Response

Created

Example response

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "tagId": 45,
    "name": "Resume",
    "description": "This tag is used for any information related to Resume",
    "type": "CLASSIFICATION",
    "createdBy": "897e4567-e89b-12d3-2345-426614174789",
    "createdDate": "2023-01-01T00:00:00Z",
    "updatedBy": "897e4567-e89b-12d3-2345-426614174789",
    "updatedDate": "2023-01-02T00:00:00Z",
    "athenaId": "754e4567-de34-12d3-a456-ddf414174777"
  }
}