Package org.odpi.openmetadata.frameworkservices.gaf.rest

package org.odpi.openmetadata.frameworkservices.gaf.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
ActionTargetStatusRequestBody	ActionTargetStatusRequestBody provides a structure for passing the properties that sit in the ActionTarget relationship.
CompletionStatusRequestBody	CompletionStatusRequestBody provides a structure for passing the properties to record that a governance service finished a governance action.
ConsolidatedDuplicatesRequestBody	ConsolidatedDuplicatesRequestBody provides a structure for passing the properties associated with consolidated duplicates.
DeleteRequestBody	DeleteRequestBody provides a structure for passing the qualified name of an object to be deleted.
ElementHeaderResponse	ElementHeaderResponse is the response structure used on the OMAS REST API calls that return the header for a element.
ElementHeadersResponse	ElementHeadersResponse is a response object for passing back a list of element headers or an exception if the request failed.
FindRequestBody	FindRequestBody provides a structure for passing the properties for the find request.
GovernanceActionProcessRequestBody	GovernanceActionProcessRequestBody provides a structure for passing the properties for initiating a new instance of a governance action process.
GovernanceActionRequestBody	GovernanceActionRequestBody provides a structure for passing the properties for a new governance action.
IncidentReportRequestBody	IncidentReportRequestBody provides a structure for passing the properties for a new incident report.
MetadataSourceRequestBody	MetadataSourceRequestBody carries the parameters for marking an element, classification or relationship as external.
NewClassificationRequestBody	NewClassificationRequestBody provides a structure for passing the properties for a new classification for a metadata element.
NewMetadataElementRequestBody	NewMetadataElementRequestBody provides a structure for passing the properties for a new metadata element.
NewRelatedElementsRequestBody	NewRelatedElementsRequestBody provides a structure for passing the properties for a new relationship between metadata elements.
OMAGGAFAPIResponse	OMAGGAFAPIResponse provides a common header for Metadata Store Service managed rest to its REST API.
OpenMetadataElementResponse	OpenMetadataElementResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the OpenMetadataElement.
OpenMetadataElementsResponse	OpenMetadataElementsResponse is a response object for passing back a list of GAF OpenMetadataElements or an exception if the request failed.
PeerDuplicatesRequestBody	PeerDuplicatesRequestBody provides a structure for passing the properties associated with duplicates.
RelatedMetadataElementListResponse	RelatedMetadataElementsListResponse is a response object for passing back a list of GAF RelatedMetadataElements or an exception if the request failed.
RelatedMetadataElementsListResponse	RelatedMetadataElementsListResponse is a response object for passing back a list of GAF RelatedMetadataElements or an exception if the request failed.
RelatedMetadataElementsResponse	RelatedMetadataElementsResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the relationship (RelatedMetadataElements).
RequestTypeRequestBody	RequestTypeRequestBody provides a structure for passing a requestType and requestParameters as a request body over a REST API.
StatusRequestBody	StatusRequestBody provides a structure for passing a new GovernanceActionStatus.
StewardshipRequestBody	StewardshipRequestBody provides a structure for passing the properties associated with stewardship actions.
ToDoRequestBody	ToDoRequestBody provides a structure for passing the properties for a new to do.
TranslationDetailResponse	TranslationDetailResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the TranslationDetail.
TranslationListResponse	TranslationListResponse is a response object for passing back a list of TranslationDetail properties or an exception if the request failed.
UpdateEffectivityDatesRequestBody	UpdateEffectivityDatesRequestBody provides a structure for passing the effectivity dates for a metadata element, classification or relationship.
UpdatePropertiesRequestBody	UpdatePropertiesRequestBody provides a structure for passing the properties for updating metadata elements, relationships or classifications.
UpdateRequestBody	UpdateRequestBody provides a structure for passing the common request parameters for updating metadata elements, relationships or classifications.
UpdateStatusRequestBody	UpdateStatusRequestBody provides a structure for passing the updated status and effectivity dates for a metadata element.
ValidMetadataValueListResponse	ValidMetadataValueListResponse is a response object for passing back a list of ValidMetadataValue properties or an exception if the request failed.
ValidMetadataValueResponse	ValidMetadataValueResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the ValidMetadataValue.