Package org.odpi.openmetadata.viewservices.glossarybrowser.rest
package org.odpi.openmetadata.viewservices.glossarybrowser.rest
This package defines the beans used to build the REST request and response payloads.
REST APIs can pass parameters in their URLs (called path variables) as well has having a RequestBody bean for additional, more complex, or optional parameters. Responses are returned in response beans.
The response beans encode the return type of the method as well as any exceptions and associated messages.
-
ClassesClassDescriptionEffectiveTimeQueryRequestBody carries the date/time for a query.FindByPropertiesRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve an element by name.GlossaryNameRequestBody is the request body structure used on Glossary REST API calls that passes a name that is used to retrieve an element by name.ResultsRequestBody carries the date/time for a query along with other common search parameters.GlossarySearchStringRequestBody is the request body structure used on GlossaryCategory/Term REST API calls that passes a regular expression to use as a search string and the scope of the results can be optionally restricted by glossary.GlossaryTermActivityTypeListResponse is a response object for passing back a list of enum values or an exception if the request failed.GlossaryTermRelationshipStatusListResponse is a response object for passing back a list of enum values or an exception if the request failed.GlossaryTermStatusListResponse is a response object for passing back a list of enum values or an exception if the request failed.HistoryRequestBody describes the start and stop time of the historical query.InformalTagProperties stores information about a tag connected to an asset.ReferenceableRequestBody describes the request body used to create/update properties in referenceables.ReferenceableUpdateRequestBody carries the correlation properties, readVersionIdentifier and effective time for a create (with parent), update or delete requests.RelationshipRequestBody describes the request body used when linking elements together.