Glossaries

Get a glossary term by Id

Get a glossary term by Id.

get/v1/glossaryTerms/{id}

Request

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

Path parameters

idstring uuid required

Id of the glossary term

Query parameters

fieldsstring
Example:children,relatedTerms,reviewers,owners,tags,usageCount,domains,extension,childrenCount

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

Response

The 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.