Glossaries

Add a typed relation to another glossary term

Add a typed semantic relation (e.g., broader, narrower, synonym) from this glossary term to another.

post/v1/glossaryTerms/{id}/relations

Request

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

Path parameters

idstring uuid required

Id of the glossary term

Request body

relationTypestring

Response

The updated glossary term

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.