Glossaries

Create or update a glossary term

Create a new glossary term, if it does not exist or update an existing glossary term.

put/v1/glossaryTerms

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/glossaryTerms
  • Auth: HTTP bearer

Request body

glossarystring required
parentstring
namestring required
displayNamestring
iristring uri
descriptionstring required
synonymsstring[]
relatedTermsstring[]
provider'system' | 'user' | 'automation'
mutuallyExclusiveboolean
extensionobject
domainsstring[]
dataProductsstring[]

Response

The glossary

idstring uuid required
namestring required
displayNamestring
descriptionstring required
fullyQualifiedNamestring
iristring uri
synonymsstring[]
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
usageCountinteger
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
deletedboolean
provider'system' | 'user' | 'automation'
disabledboolean
mutuallyExclusiveboolean
extensionobject
childrenCountinteger
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.