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.
-
ClassesClassDescriptionThe response structure used on the Governance Action Framework REST API calls that returns a CatalogTarget element object as a response.The response structure used on REST API calls that returns a list of CatalogTarget objects as a response.CompletionStatusRequestBody provides a structure for passing the properties to record that a governance service finished a governance action.The response structure used on the Governance Action Framework REST API calls that returns a EngineAction element object as a response.The response structure used on REST API calls that returns a list of EngineActionElement objects as a response.EngineActionStatusRequestBody provides a structure for passing a new EngineActionStatus.The response structure used on the Governance Action Framework (GAF) API calls that returns a FirstGovernanceActionProcessStep element object as a response.The response structure used on the Governance Action Framework REST API calls that returns a GovernanceActionProcess element object as a response.The response structure used on REST API calls that returns a list of GovernanceActionProcessElement objects as a response.The response structure used on the Governance Action Framework (GAF) API calls that returns a GovernanceActionProcessGraph element object as a response.The response structure used on the open metadata REST API calls that returns a GovernanceActionProcessStep element object as a response.The response structure used on REST API calls that returns a list of GovernanceActionProcessStepElement objects as a response.GovernanceActionTypeElementResponse is the response structure used on the Governance Action Framework REST API calls that returns a GovernanceActionType element object as a response.The response structure used on REST API calls that returns a list of GovernanceActionTypeElement objects as a response.The response structure used on the Governance Action Framework REST API calls that returns a GovernanceEngine element object as a response.The response structure used on REST API calls that returns a list of GovernanceEngineElement objects as a response.The response structure used on the Governance Action Framework 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.EngineActionRequestBody provides a structure for passing the properties for a new engine action.InitiateGovernanceActionProcessRequestBody provides a structure for passing the properties for initiating a new instance of a governance action process.GovernanceActionTypeRequestBody provides a structure for passing the properties for initiating a new instance of an engine action from a governance action type.The response structure used on the Governance Action Framework REST API calls that returns a IntegrationConnector element object as a response.The response structure used on REST API calls that returns a list of IntegrationConnectorElement objects as a response.The response structure used on the Governance Action Framework REST API calls that returns a IntegrationGroup element object as a response.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.NextGovernanceActionProcessStepRequestBody contains the properties for a next action type relationship.The response structure used on REST API calls that returns a list of NextGovernanceActionProcessStepElement objects as a response.OMAGGAFAPIResponse provides a common header for Metadata Store Service managed rest to its REST API.The response structure used on the Governance Action Framework REST API calls that returns a RegisteredGovernanceServiceElement object as a response.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 Action Framework REST API calls that returns a RegisteredIntegrationConnectorElement object as a response.The response structure used on REST API calls that returns a list of RegisteredIntegrationConnectors objects as a response.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 EngineActionStatus.UpdateGovernanceActionProcessRequestBody describes the request body used to update governance action process properties.UpdateGovernanceActionProcessStepRequestBody describes the request body used to update governance action process step 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.UpdateStatusRequestBody provides a structure for passing the updated status and effectivity dates for a metadata element.