Sign in

v1

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

Create Term

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

post/api/glossary/v2/terms

Request body

namestring required

Name of the term

type'Data Element' | 'Business Term' | 'Acronym' | 'Key Performance Indicator' | 'Metric' | 'Type of Individual' required

Type of the term

glossaryNamestring required

Valid glossary name

createAsApprovedboolean

Create a term as approved

shortDescriptionstring

Short description about term

examplestring

Example Value for the term

notesstring

Notes for the term

tagsstring[]

Example request

{
  "name": "Account Number",
  "type": "Data Element",
  "glossaryName": "Business glossary",
  "createAsApproved": true,
  "shortDescription": "This is the eight-digit account number which is used to uniquely identify the bank customer",
  "example": "123-423-45",
  "notes": "This is the term which is used for the Banking data",
  "technicalOwner": {
    "userEmails": [
      "mallory@ot.com"
    ],
    "groupNames": [
      "Audit group"
    ]
  },
  "businessOwner": {
    "userEmails": [
      "mallory@ot.com"
    ],
    "groupNames": [
      "Audit group"
    ]
  },
  "dataSteward": {
    "userEmails": [
      "mallory@ot.com"
    ],
    "groupNames": [
      "Audit group"
    ]
  },
  "tags": [
    "Financial"
  ],
  "customAttributes": [
    {
      "name": "Term other users",
      "value": "User of the term",
      "options": [
        "alice@ot.com"
      ]
    }
  ]
}

Response

Created

idstring uuid

Unique identifier

namestring

Name of the entity

nameKeystring

Key used for name localization

typestring

Type of the term

typeKeystring

Key used for type localization

shortDescriptionstring

Brief description of the term

numericIdinteger

Numeric identifier for the term

examplestring

Example usage of the term

businessOwnerstring[]
technicalOwnerstring[]
dataStewardstring[]
notesstring

Additional notes about the term

sourcestring

Source of the term

createdDatestring date-time

Creation timestamp

lastUpdatedDatestring date-time

Last update timestamp

createdBystring uuid

UUID of the user who created the term

lastUpdatedBystring uuid

UUID of the user who last updated the term

statusstring

Current status of the term

associatedTagsstring[]

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Sample Name",
  "nameKey": "SAMPLE_NAME_KEY",
  "type": "Business",
  "typeKey": "BUSINESS_TYPE",
  "shortDescription": "A short explanation of what this term means",
  "glossary": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "value": "Sample Value",
    "key": "SAMPLE_KEY"
  },
  "numericId": 12345,
  "example": "Example usage of this term in a sentence",
  "businessOwner": [
    "32d50775-17c3-44f0-88da-575b8a10c9fb"
  ],
  "technicalOwner": [
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "dataSteward": [
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "notes": "Additional information about term usage",
  "source": "Internal Documentation",
  "createdDate": "2023-01-01T00:00:00Z",
  "lastUpdatedDate": "2023-01-02T00:00:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174003",
  "lastUpdatedBy": "123e4567-e89b-12d3-a456-426614174004",
  "status": "ACTIVE",
  "associatedTags": [
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "tags": [
    {
      "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"
    }
  ]
}