Package org.odpi.openmetadata.viewservices.collectionmanager.rest

package org.odpi.openmetadata.viewservices.collectionmanager.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
CollectionListResponse	CollectionListResponse is the response structure used on the OMAS REST API calls that return a list of collection elements.
CollectionMemberListResponse	CollectionMemberListResponse is the response structure used on the OMAS REST API calls that return a list of collection membership elements.
CollectionMemberResponse	CollectionMemberResponse is the response structure used on the OMAS REST API calls that return a CollectionMember object as a response.
CollectionResponse	CollectionResponse is the response structure used on the OMAS REST API calls that return a CollectionElement object as a response.
NewCollectionRequestBody	NewCollectionRequestBody describes the properties to create a new collection.
NewDigitalProductRequestBody	NewDigitalProductRequestBody describes the properties to create a new collection with a digital product classification.
NewElementRequestBody	NewElementRequestBody provides a structure for the common properties when creating an element.
NewMetadataElementRequestBody	NewMetadataElementRequestBody provides a structure for passing the properties for a new metadata element.
TemplateRequestBody	TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.