Package org.odpi.openmetadata.accessservices.governanceengine.rest
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.
-
ClassesClassDescriptionCatalogTargetResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a CatalogTarget element object as a response.CatalogTargetsResponse is the response structure used on REST API calls that returns a list of CatalogTarget objects as a response.DeleteRequestBody provides a structure for passing the qualified name of an object to be deleted.ElementHeaderResponse is the response structure used on the OMAS REST API calls that return the header for a element.ElementHeadersResponse is a response object for passing back a a list of element headers or an exception if the request failed.FindRequestBody provides a structure for passing the properties for the find request.GovernanceActionElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceAction element object as a response.GovernanceActionElementsResponse is the response structure used on REST API calls that returns a list of GovernanceActionElement objects as a response.GovernanceActionProcessElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceActionProcess element object as a response.GovernanceActionProcessElementsResponse is the response structure used on REST API calls that returns a list of GovernanceActionProcessElement objects as a response.GovernanceActionStatusResponse is the response structure used on the OMAS REST API calls that return a GovernanceActionStatus enum.GovernanceActionTypeElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceActionType element object as a response.GovernanceActionTypeElementsResponse is the response structure used on REST API calls that returns a list of GovernanceActionTypeElement objects as a response.GovernanceEngineElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceEngine element object as a response.GovernanceEngineElementsResponse is the response structure used on REST API calls that returns a list of GovernanceEngineElement objects as a response.GovernanceEngineOMASAPIResponse provides a common header for Governance Engine OMAS managed rest to its REST API.GovernanceServiceElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceService element object as a response.GovernanceServiceElementsResponse is the response structure used on REST API calls that returns a list of GovernanceServiceElement objects as a response.GovernanceServiceRegistrationRequestBody provides a structure for passing details of a governance service that is to be registered with a governance engine.IntegrationConnectorElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a IntegrationConnector element object as a response.IntegrationConnectorElementsResponse is the response structure used on REST API calls that returns a list of IntegrationConnectorElement objects as a response.IntegrationGroupElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a IntegrationGroup element object as a response.IntegrationGroupElementsResponse is the response structure used on REST API calls that returns a list of IntegrationGroupElement objects as a response.NewGovernanceActionProcessRequestBody describes the request body used to create governance action process properties.NewGovernanceEngineRequestBody provides a structure for passing the properties of a new governance engine as a request body over a REST API.NewGovernanceServiceRequestBody provides a structure for passing the properties of a new governance service as a request body over a REST API.NextGovernanceActionTypeElementsResponse is the response structure used on REST API calls that returns a list of NextGovernanceActionTypeElement objects as a response.NextGovernanceActionTypeRequestBody contains the properties for a next action type relationship.OpenMetadataElementsResponse is a response object for passing back a a list of GAF OpenMetadataElements or an exception if the request failed.RegisteredGovernanceServiceResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a RegisteredGovernanceServiceElement object as a response.RegisteredGovernanceServicesResponse is the response structure used on REST API calls that returns a list of RegisteredGovernanceServices objects as a response.RegisteredIntegrationConnectorResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a RegisteredIntegrationConnectorElement object as a response.RegisteredIntegrationConnectorsResponse is the response structure used on REST API calls that returns a list of RegisteredIntegrationConnectors objects as a response.RelatedMetadataElementsListResponse is a response object for passing back a a list of GAF RelatedMetadataElements or an exception if the request failed.RelatedMetadataElementsListResponse is a response object for passing back a a list of GAF RelatedMetadataElements or an exception if the request failed.RequestTypeRequestBody provides a structure for passing a requestType and requestParameters as a request body over a REST API.StatusRequestBody provides a structure for passing a new GovernanceActionStatus.StewardshipRequestBody provides a structure for passing the properties associated with stewardship actions.UpdateEffectivityDatesRequestBody provides a structure for passing the effectivity dates for a metadata element, classification or relationship.UpdateGovernanceActionProcessRequestBody describes the request body used to update governance action process properties.UpdateGovernanceActionTypeRequestBody describes the request body used to update governance action type properties.UpdateGovernanceEngineRequestBody provides a structure for passing the updated properties of a governance engine as a request body over a REST API.UpdateGovernanceServiceRequestBody provides a structure for passing the updated properties of a governance service as a request body over a REST API.UpdatePropertiesRequestBody provides a structure for passing the properties for updating metadata elements, relationships or classifications.UpdateRequestBody provides a structure for passing the common request parameters for updating metadata elements, relationships or classifications.UpdateStatusRequestBody provides a structure for passing the updated status and effectivity dates for a metadata element.