Glossaries

Get multiple glossary terms by Ids

Get multiple glossary terms in a single request by passing a comma-separated list of UUIDs. Exists to eliminate the per-Id round-trip pattern when hydrating related-term graphs in the UI. Ids that are missing, deleted, or not visible to the caller are silently omitted from the response, so callers should compare the response size against the input.

get/v1/glossaryTerms/byIds

Request

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

Query parameters

idsstring

Comma-separated list of glossary term Ids (UUIDs). Max 100 per call. Omit or pass blank to receive an empty list.

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

List of glossary terms (may be shorter than the input ids list)

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.