Glossary

The Glossary API allows users to associate business terms with technology assets such as data sets and columns, documents, and business rules.

Root

Contains root level resources.

Get top-level resource links

Internal-Use OnlyReturns a list of top-level resource links provided by the Glossary API.

Term Types

Contains life cycle management resources for term types.

Get term types

Internal-Use OnlyReturns a list of term types. The items are sorted by name by default. The properties that can be used as filter and sort criteria are:

Create a term type

Internal-Use OnlyCreates a term type with the given content.

Get the headers for a term type by its ID

Internal-Use OnlyReturns the headers for a term type by referencing its ID.

/termTypes/{termTypeId}

Get a term type by its ID

Internal-Use OnlyReturns a term type by referencing its ID.

/termTypes/{termTypeId}

Update a term type by its ID

Internal-Use OnlyUpdates a term type by referencing its ID.

/termTypes/{termTypeId}

Delete a term type by its ID

Internal-Use OnlyDeletes a term type by referencing its ID.

/termTypes/{termTypeId}

Terms

Contains life cycle management resources for terms.

Get terms

Internal-Use OnlyReturns a list of terms. The items are sorted by name by default. The properties that can be used as filter and sort criteria are:

Create a term

Internal-Use OnlyCreates a term with the given content.

Get the headers for a term by its ID

Internal-Use OnlyReturns the headers for a term by referencing its ID.

/terms/{termId}

Get a term by its ID

Internal-Use OnlyReturns a term by referencing its ID.

/terms/{termId}

Update a term by its ID

Internal-Use OnlyUpdates a term by referencing its ID.

/terms/{termId}

Manipulate individual properties on a term using JSON Patch requests

Internal-Use OnlyPatch updates properties on a term. Only the following field can be manipulated:

/terms/{termId}

Delete a term by its ID

Internal-Use OnlyDeletes a term by referencing its ID.

/terms/{termId}

Get the headers for a draft term by its ID

Internal-Use OnlyReturns the headers for a draft term by referencing its ID.

/terms/{termId}/draft

Create a draft from a published term

Internal-Use OnlyCreates a draft term from a published term with the specified ID and the given content.

/terms/{termId}/draft

Get a draft term by its ID

Internal-Use OnlyReturns a draft term by referencing its ID.

/terms/{termId}/draft

Update a draft term by its ID

Internal-Use OnlyUpdates a draft term by referencing its ID.

/terms/{termId}/draft

Manipulate individual properties on a draft term using JSON Patch requests

Internal-Use OnlyPatch updates properties on a draft term. Only the parentId field can be manipulated. It can be changed only on drafts that have not been created from a published term.

/terms/{termId}/draft

Delete a draft term by its ID

Internal-Use OnlyDeletes a draft term by referencing its ID.

/terms/{termId}/draft

Publish a draft term by its ID

Internal-Use OnlyPublishes a draft term by its ID.

/terms/{termId}/draft/state

Import terms via CSV

Internal-Use OnlyImports terms from a CSV File. The CSV should be uploaded as a multipart value under the key "termCSV". Additionally, the multipart key "updateExisting" can be set to true if the import should overwrite existing terms. This request will return a job that can be polled for status and results.