Package org.odpi.openmetadata.accessservices.governanceengine.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.
-
Class Summary 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 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.GovernanceActionElementResponse GovernanceActionElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceAction element object as a response.GovernanceActionElementsResponse GovernanceActionElementsResponse is the response structure used on REST API calls that returns a list of GovernanceActionElement objects 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.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.GovernanceActionStatusResponse GovernanceActionStatusResponse is the response structure used on the OMAS REST API calls that return a GovernanceActionStatus enum.GovernanceActionTypeElementResponse GovernanceActionTypeElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceActionType element object as a response.GovernanceActionTypeElementsResponse GovernanceActionTypeElementsResponse 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.GovernanceEngineOMASAPIResponse GovernanceEngineOMASAPIResponse provides a common header for Governance Engine OMAS managed rest to its REST API.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.IncidentReportRequestBody IncidentReportRequestBody provides a structure for passing the properties for a new incident report.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.NextGovernanceActionTypeElementsResponse NextGovernanceActionTypeElementsResponse is the response structure used on REST API calls that returns a list of NextGovernanceActionTypeElement objects as a response.NextGovernanceActionTypeRequestBody NextGovernanceActionTypeRequestBody contains the properties for a next action type relationship.OpenMetadataElementsResponse OpenMetadataElementsResponse is a response object for passing back a a list of GAF OpenMetadataElements or an exception if the request failed.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.RelatedMetadataElementListResponse RelatedMetadataElementsListResponse is a response object for passing back a a list of GAF RelatedMetadataElements or an exception if the request failed.RelatedMetadataElementsListResponse RelatedMetadataElementsListResponse is a response object for passing back a a list of GAF RelatedMetadataElements 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.StatusRequestBody StatusRequestBody provides a structure for passing a new GovernanceActionStatus.StewardshipRequestBody StewardshipRequestBody provides a structure for passing the properties associated with stewardship actions.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.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.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.