Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest

package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.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.

Classes

Class	Description
APIOperationResponse	CommentResponse is the response structure used on the OMAS REST API calls that returns a Comment object as a response.
APIOperationsResponse	APIOperationsResponse is the response structure used on the OMAS REST API calls that return a list of SchemaType objects as a response.
AssetResponse	AssetResponse is the response structure used on the OMAS REST API calls that return a asset bean object as a response.
AssetsResponse	AssetsResponse returns a list of assets from the server.
CertificationsResponse	CertificationsResponse is the response structure used on the OMAS REST API calls that return a list of Certification objects as a response.
CommentRequestBody	CommentRequestBody provides a structure for passing a comment as a request body over a REST API.
CommentResponse	CommentResponse is the response structure used on the OMAS REST API calls that returns a Comment object as a response.
CommentsResponse	CommentsResponse is the response structure used on the OMAS REST API calls that return a list of Comment objects as a response.
ConnectionRequestBody	OCFConnectionRequestBody carries the parameters for created a new asset.
ConnectionResponse	OCFConnectionResponse is the response structure used on OMAS REST API calls that return a Connection object as a response.
ConnectionsResponse	ConnectionsResponse is the response structure used on the OMAS REST API calls that return a list of Connection objects as a response.
ExternalIdentifiersResponse	ExternalIdentifiersResponse is the response structure used on the OMAS REST API calls that return a list of ExternalIdentifier objects as a response.
ExternalReferencesResponse	ExternalReferencesResponse is the response structure used on the OMAS REST API calls that return a list of ExternalReference objects as a response.
FeedbackRequestBody	FeedbackRequestBody provides a base class for passing feedback objects as a request body over a REST API.
GlossaryTermListResponse	GlossaryTermListResponse returns a list of meanings from the server.
GlossaryTermResponse	GlossaryTermResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a Glossary Term object as a response.
InformalTagsResponse	InformalTagsResponse is the response structure used on the OMAS REST API calls that return a list of InformalTag objects as a response.
LicensesResponse	LicensesResponse is the response structure used on the OMAS REST API calls that return a list of License objects as a response.
LikesResponse	LikesResponse is the response structure used on the OMAS REST API calls that return a list of Like objects as a response.
LocationsResponse	LocationsResponse is the response structure used on the OMAS REST API calls that return a list of ExternalIdentifier objects as a response.
MeaningResponse	MeaningResponse is the response structure used on the OCF Metadata Management REST API calls that returns a Meaning object as a response.
MeaningsResponse	MeaningsResponse returns a list of meanings from the server.
MoreInformationResponse	MoreInformationResponse returns a list of referenceables that are connected to the element identified on the request that is connected by the MoreInformation relationship from the server.
NoteLogResponse	NoteLogResponse is the response structure used on the OMAS REST API calls that returns a NoteLogHeader object as a response.
NoteLogsResponse	NoteLogsResponse is the response structure used on the OMAS REST API calls that return a list of NoteLogHeader objects as a response.
NotesResponse	NotesResponse is the response structure used on the OMAS REST API calls that return a list of Note objects as a response.
OCFOMASAPIRequestBody	OCFOMASAPIRequestBody provides a common header for Open Connector Framework (OCF) bean-based request bodies.
OCFOMASAPIResponse	OCFOMASAPIResponse provides a common header for or Open Connector Framework (OCF) bean-based REST responses.
OriginRequestBody	OriginRequestBody provides a structure for passing information about an asset's origin as a request body over a REST API.
OwnerRequestBody	OwnerRequestBody provides a structure for passing information about an asset owner as a request body over a REST API.
PagedResponse	PagedResponse is used for responses that can contain paged responses
RatingRequestBody	RatingRequestBody provides a structure for passing star rating as a request body over a REST API.
RatingsResponse	RatingsResponse is the response structure used on the OMAS REST API calls that return a list of Rating objects as a response.
ReferenceableRequestBody	ReferenceableRequestBody provides a structure for passing a referenceables' properties as a request body over a REST API.
ReferenceablesResponse	ReferenceablesResponse returns a list of referenceables from the server.
RelatedAssetsResponse	RelatedAssetsResponse is the response structure used on the OMAS REST API calls that return a list of AssetRelatedAsset objects as a response.
RelatedMediaReferencesResponse	RelatedMediaReferencesResponse is the response structure used on the OMAS REST API calls that return a list of RelatedMediaReference objects as a response.
SchemaAttributesResponse	SchemaAttributesResponse is the response structure used on the OMAS REST API calls that return a list of SchemaAttribute objects as a response.
SchemaRequestBody	SchemaRequestBody carries the parameters for created a new schema to attach to an asset.
SchemaTypeResponse	SchemaTypeResponse is the response structure used on the OMAS REST API calls that return a StructSchemaType object as a response.
TagRequestBody	TagRequestBody provides a structure for passing an informal tag as a request body over a REST API.
TagResponse	TagResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a Tag object as a response.
TagsResponse	TagsResponse returns a list of tags from the server.
ValidValueResponse	ValidValueResponse is the response structure used on the OMAS REST API calls that return a valid value bean object as a response.
ValidValuesResponse	ValidValuesResponse returns a list of assets from the server.