v1

latestOpenAPI 3.1.02026-07-24188215268.7 KB

legacy catalog - glossary

suggest for an existing glossary.

Please refer to the updated IRI-based resource endpoints.

patch/metadata/glossary/suggest/{owner}/{id}

Path parameters

ownerstring required

idstring required

Request body

collectionsToAddstring[]

Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.

collectionsToRemovestring[]

Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.

descriptionstring

A short, but descriptive statement about the metadata resource.

messagestring

Message for the suggestion

propertiesobject

Custom properties for the metadata resource mapped to API BindingsCan be simple name-value string pairs or nested values for a string name. See examples for details.

summarystring

tagsToAddstring[]

A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard

tagsToRemovestring[]

A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard

titlestring

Title of the metadata resource. Required for POST and PUT.

typeLabelstring

Indicates the type of metadata resource. Some examples of valid values are Report, Tableau dashboard, Glossary, Table, Database view etc. Default values will be assumed if not provided. Defaults to Report for analysis resources, Glossary for Glossary resources, Table for Table resources and Column for Column resources. Once specified during creation, this cannot be changed via PATCH. Only a PUT can change the type

Example request

{
  "collectionsToAdd": [
    "Aid Option"
  ],
  "collectionsToRemove": [
    "Aid Option"
  ],
  "description": "Aid given to charity is an option that can be exercised by individuals and corporations",
  "message": "I strongly suggest",
  "tagsToAdd": [
    "HumanitarianAid"
  ],
  "tagsToRemove": [
    "HumanitarianAid"
  ],
  "title": "crypto.snowflake",
  "typeLabel": "Tableau dashboard"
}

Response

default response

messagestring