Classifications

Get a classification by name

Get a classification identified by name. The response includes classification information along with the entire hierarchy of all the children tags.

get/v1/classifications/name/{name}

Request

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

Path parameters

namestring required

Name of the classification

Query parameters

fieldsstring
Example:owners,reviewers,usageCount,termCount,autoClassificationConfig

Fields requested in the returned resource

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

Include all, deleted, or non-deleted entities.

Response

The user

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

Changes

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