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.
AnyTimeRequestBody	AnyTimeRequestBody describes the start and stop time of the historical query.
ArchiveRequestBody	ArchiveRequestBody provides a structure for passing the archive information for a metadata element.
AttributeTypeDefListResponse	AttributeTypeDefListResponse provides a simple bean for returning an array of AttributeTypeDefs
AttributeTypeDefResponse	AttributeTypeDefResponse provides a response structure for an OMRS REST API call that returns an AttributeTypeDef object.
CatalogTargetResponse	CatalogTargetResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a CatalogTarget element object as a response.
CatalogTargetsResponse	CatalogTargetsResponse is the response structure used on REST API calls that returns a list of CatalogTarget objects as a response.
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.
EffectiveTimeQueryRequestBody	EffectiveTimeQueryRequestBody carries the date/time for a query.
EngineActionElementResponse	EngineActionElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a EngineAction element object as a response.
EngineActionElementsResponse	EngineActionElementsResponse is the response structure used on REST API calls that returns a list of EngineActionElement objects as a response.
EngineActionStatusRequestBody	EngineActionStatusRequestBody provides a structure for passing a new EngineActionStatus.
FindRelationshipRequestBody	FindRelationshipRequestBody provides a structure for passing the properties for the find relationships request.
FindRequestBody	FindRequestBody provides a structure for passing the properties for the find request.
FirstGovernanceActionProcessStepResponse	FirstGovernanceActionProcessStepResponse is the response structure used on the Governance Action Framework (GAF) API calls that returns a FirstGovernanceActionProcessStep element object as a response.
GovernanceActionProcessElementResponse	GovernanceActionProcessElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceActionProcess element object as a response.
GovernanceActionProcessElementsResponse	GovernanceActionProcessElementsResponse is the response structure used on REST API calls that returns a list of GovernanceActionProcessElement objects as a response.
GovernanceActionProcessGraphResponse	FirstGovernanceActionProcessStepResponse is the response structure used on the Governance Action Framework (GAF) API calls that returns a FirstGovernanceActionProcessStep element object as a response.
GovernanceActionProcessStepResponse	GovernanceActionProcessStepElementResponse is the response structure used on the open metadata REST API calls that returns a GovernanceActionProcessStep element object as a response.
GovernanceActionProcessStepsResponse	GovernanceActionProcessStepsResponse is the response structure used on REST API calls that returns a list of GovernanceActionProcessStepElement objects as a response.
GovernanceActionRequestBody	Deprecated.
GovernanceActionTypeResponse	GovernanceActionTypeElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceActionType element object as a response.
GovernanceActionTypesResponse	GovernanceActionTypesResponse is the response structure used on REST API calls that returns a list of GovernanceActionTypeElement objects as a response.
GovernanceEngineElementResponse	GovernanceEngineElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceEngine element object as a response.
GovernanceEngineElementsResponse	GovernanceEngineElementsResponse is the response structure used on REST API calls that returns a list of GovernanceEngineElement objects as a response.
GovernanceServiceElementResponse	GovernanceServiceElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceService element object as a response.
GovernanceServiceElementsResponse	GovernanceServiceElementsResponse is the response structure used on REST API calls that returns a list of GovernanceServiceElement objects as a response.
GovernanceServiceRegistrationRequestBody	GovernanceServiceRegistrationRequestBody provides a structure for passing details of a governance service that is to be registered with a governance engine.
HistoryExternalIdentifiersRequestBody	HistoryRequestBody describes the start and stop time of the historical query.
HistoryRequestBody	HistoryRequestBody describes the start and stop time of the historical query.
IncidentReportRequestBody	IncidentReportRequestBody provides a structure for passing the properties for a new incident report.
InformationSupplyChainResponse	InformationSupplyChainResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a InformationSupplyChainElement element object as a response.
InformationSupplyChainsResponse	InformationSupplyChainsResponse is the response structure used on REST API calls that returns a list of InformationSupplyChainElement objects as a response.
InitiateEngineActionRequestBody	EngineActionRequestBody provides a structure for passing the properties for a new engine action.
InitiateGovernanceActionProcessRequestBody	InitiateGovernanceActionProcessRequestBody provides a structure for passing the properties for initiating a new instance of a governance action process.
InitiateGovernanceActionTypeRequestBody	GovernanceActionTypeRequestBody provides a structure for passing the properties for initiating a new instance of an engine action from a governance action type.
IntegrationConnectorElementResponse	IntegrationConnectorElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a IntegrationConnector element object as a response.
IntegrationConnectorElementsResponse	IntegrationConnectorElementsResponse is the response structure used on REST API calls that returns a list of IntegrationConnectorElement objects as a response.
IntegrationGroupElementResponse	IntegrationGroupElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a IntegrationGroup element object as a response.
IntegrationGroupElementsResponse	IntegrationGroupElementsResponse is the response structure used on REST API calls that returns a list of IntegrationGroupElement objects as a response.
MetadataCorrelationHeadersResponse	MetadataCorrelationHeadersResponse is a response object for passing back a a list of correlation headers or an exception if the request failed.
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.
NewGovernanceActionProcessRequestBody	NewGovernanceActionProcessRequestBody describes the request body used to create governance action process properties.
NewGovernanceEngineRequestBody	NewGovernanceEngineRequestBody provides a structure for passing the properties of a new governance engine as a request body over a REST API.
NewGovernanceServiceRequestBody	NewGovernanceServiceRequestBody provides a structure for passing the properties of a new governance service as a request body over a REST API.
NewOpenMetadataElementRequestBody	NewOpenMetadataElementRequestBody 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.
NextGovernanceActionProcessStepRequestBody	NextGovernanceActionProcessStepRequestBody contains the properties for a next action type relationship.
NextGovernanceActionProcessStepsResponse	NextGovernanceActionProcessStepsResponse is the response structure used on REST API calls that returns a list of NextGovernanceActionProcessStepElement objects as a response.
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.
OpenMetadataGraphResponse	OpenMetadataGraphResponse is the response structure used on the Governance Action Framework REST API calls that returns an OpenMetadataElementGraph object as a response.
OpenMetadataRelationshipListResponse	OpenMetadataRelationshipListResponse is a response object for passing back a list of GAF OpenMetadataRelationship or an exception if the request failed.
OpenMetadataRelationshipResponse	OpenMetadataRelationshipResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the relationship (OpenMetadataRelationship).
PeerDuplicatesRequestBody	PeerDuplicatesRequestBody provides a structure for passing the properties associated with duplicates.
RegisteredGovernanceServiceResponse	RegisteredGovernanceServiceResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a RegisteredGovernanceServiceElement object as a response.
RegisteredGovernanceServicesResponse	RegisteredGovernanceServicesResponse is the response structure used on REST API calls that returns a list of RegisteredGovernanceServices objects as a response.
RegisteredIntegrationConnectorResponse	RegisteredIntegrationConnectorResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a RegisteredIntegrationConnectorElement object as a response.
RegisteredIntegrationConnectorsResponse	RegisteredIntegrationConnectorsResponse is the response structure used on REST API calls that returns a list of RegisteredIntegrationConnectors objects as a response.
RelatedMetadataElementListResponse	OpenMetadataRelationshipListResponse is a response object for passing back a list of GAF OpenMetadataRelationship or an exception if the request failed.
RelatedMetadataElementsResponse	RelatedMetadataElementsResponse is a response object for passing back a list of GAF RelatedMetadataElementSummary or an exception if the request failed.
RequestTypeRequestBody	RequestTypeRequestBody provides a structure for passing a requestType and requestParameters as a request body over a REST API.
SolutionBlueprintResponse	SolutionBlueprintResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a SolutionBlueprintElement element object as a response.
SolutionBlueprintsResponse	SolutionBlueprintsResponse is the response structure used on REST API calls that returns a list of SolutionBlueprintElement objects as a response.
SolutionComponentResponse	SolutionComponentResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a SolutionComponentElement element object as a response.
SolutionComponentsResponse	SolutionComponentsResponse is the response structure used on REST API calls that returns a list of GovernanceActionProcessStepElement objects as a response.
SolutionRoleResponse	SolutionRoleResponse is the response structure used on the open metadata REST API calls that returns a SolutionRoleElement element object as a response.
SolutionRolesResponse	SolutionRolesResponse is the response structure used on REST API calls that returns a list of SolutionRoleElement objects as a response.
StatusRequestBody	StatusRequestBody provides a structure for passing a new EngineActionStatus.
StewardshipRequestBody	StewardshipRequestBody provides a structure for passing the properties associated with stewardship actions.
TemplateRequestBody	TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.
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.
TypeDefGalleryResponse	TypeDefGalleryResponse provides the response structure for an OMRS REST API call that returns a TypeDefGallery.
TypeDefListResponse	TypeDefListResponse provides a simple bean for returning a list of TypeDefs (or information to create a valid OMRS exception).
TypeDefResponse	TypeDefResponse provides the response structure for an OMRS API call that returns a TypeDef
TypeLimitedFindRequest	TypeLimitedFindRequest extends the paged find request to allow the caller to request results from only one type of instance.
TypeLimitedHistoricalFindRequest	TypeLimitedHistoricalFindRequest provides an extension to the search parameters to include the point in time that the request should be based on.
UpdateEffectivityDatesRequestBody	UpdateEffectivityDatesRequestBody provides a structure for passing the effectivity dates for a metadata element, classification or relationship.
UpdateGovernanceActionProcessRequestBody	UpdateGovernanceActionProcessRequestBody describes the request body used to update governance action process properties.
UpdateGovernanceActionProcessStepRequestBody	UpdateGovernanceActionProcessStepRequestBody describes the request body used to update governance action process step properties.
UpdateGovernanceActionTypeRequestBody	UpdateGovernanceActionTypeRequestBody describes the request body used to update governance action type properties.
UpdateGovernanceEngineRequestBody	UpdateGovernanceEngineRequestBody provides a structure for passing the updated properties of a governance engine as a request body over a REST API.
UpdateGovernanceServiceRequestBody	UpdateGovernanceServiceRequestBody provides a structure for passing the updated properties of a governance service as a request body over a REST API.
UpdateMetadataCorrelatorsRequestBody	UpdateRequestBody carries the correlation properties and effective time for a create, update or delete request.
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.
ValidMetadataValueDetailListResponse	ValidMetadataValueDetailListResponse is a response object for passing back a list of ValidMetadataValue properties or an exception if the request failed.
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.