Package org.odpi.openmetadata.frameworkservices.gaf.server

Class OpenGovernanceRESTServices

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.server.OpenGovernanceRESTServices
public class OpenGovernanceRESTServices extends Object
The OpenGovernanceRESTServices provides the server-side implementation of the services used by the governance engine as it is managing requests to execute open governance services in the governance server. These services align with the interface definitions from the Governance Action Framework (GAF).

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenGovernanceRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    cancelEngineAction(String serverName, String serviceURLMarker, String userId, String engineActionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Request that execution of an engine action is stopped.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    claimEngineAction(String serverName, String serviceURLMarker, String userId, String engineActionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Request that execution of an engine action is allocated to the caller.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.NewGovernanceActionProcessRequestBody requestBody)
    Create a new metadata element to represent a governance action process.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createGovernanceActionProcessStep(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepProperties requestBody)
    Create a new metadata element to represent a governance action process step.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createGovernanceActionType(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeProperties requestBody)
    Create a new metadata element to represent a governance action type.
    org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse
    findEngineActions(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of engine action metadata elements that contain the search string.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementsResponse
    findGovernanceActionProcesses(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of governance action process metadata elements that contain the search string.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepsResponse
    findGovernanceActionProcessSteps(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of governance action process step metadata elements that contain the search string.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypesResponse
    findGovernanceActionTypes(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of governance action type metadata elements that contain the search string.
    org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse
    getActiveClaimedEngineActions(String serverName, String serviceURLMarker, String userId, String governanceEngineGUID, int startFrom, int pageSize)
    Retrieve the engine actions that are still in process and that have been claimed by this caller's userId.
    org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse
    getActiveEngineActions(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize)
    Retrieve the engine actions that are still in process.
    org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementResponse
    getEngineAction(String serverName, String serviceURLMarker, String userId, String engineActionGUID)
    Request the status and properties of an executing engine action request.
    org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse
    getEngineActions(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize)
    Retrieve the engine actions that are known to the server.
    org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse
    getEngineActionsByName(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the list of engine action metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworkservices.gaf.rest.FirstGovernanceActionProcessStepResponse
    getFirstProcessStep(String serverName, String serviceURLMarker, String userId, String processGUID)
    Return the governance action process step that is the first step in a governance action process.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementResponse
    getGovernanceActionProcessByGUID(String serverName, String serviceURLMarker, String userId, String processGUID)
    Retrieve the governance action process metadata element with the supplied unique identifier.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementsResponse
    getGovernanceActionProcessesByName(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the list of governance action process metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessGraphResponse
    getGovernanceActionProcessGraph(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody requestBody)
    Retrieve the governance action process metadata element with the supplied unique identifier along with the flow definition describing its implementation.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepResponse
    getGovernanceActionProcessStepByGUID(String serverName, String serviceURLMarker, String userId, String processStepGUID)
    Retrieve the governance action process step metadata element with the supplied unique identifier.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepsResponse
    getGovernanceActionProcessStepsByName(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the list of governance action process step metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypeResponse
    getGovernanceActionTypeByGUID(String serverName, String serviceURLMarker, String userId, String governanceActionTypeGUID)
    Retrieve the governance action type metadata element with the supplied unique identifier.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypesResponse
    getGovernanceActionTypesByName(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the list of governance action type metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworkservices.gaf.rest.NextGovernanceActionProcessStepsResponse
    getNextProcessSteps(String serverName, String serviceURLMarker, String userId, String processStepGUID, int startFrom, int pageSize)
    Return the list of next action process step defined for the governance action process.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    initiateEngineAction(String serverName, String serviceURLMarker, String userId, String governanceEngineName, org.odpi.openmetadata.frameworkservices.gaf.rest.InitiateEngineActionRequestBody requestBody)
    Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    initiateGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.InitiateGovernanceActionProcessRequestBody requestBody)
    Using the named governance action process as a template, initiate a chain of governance actions.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    initiateGovernanceActionType(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.InitiateGovernanceActionTypeRequestBody requestBody)
    Using the named governance action type as a template, initiate an engine action.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkConsolidatedDuplicate(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.omf.rest.ConsolidatedDuplicatesRequestBody requestBody)
    Identify an element that acts as a consolidated version for a set of duplicate elements.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkElementsAsDuplicates(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.omf.rest.PeerDuplicatesRequestBody requestBody)
    Link elements as peer duplicates.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    publishGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Update the zones for the asset so that it becomes visible to consumers.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    recordCompletionStatus(String serverName, String serviceURLMarker, String userId, String governanceActionGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.CompletionStatusRequestBody requestBody)
    Declare that all the processing for the governance action service is finished and the status of the work.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeFirstProcessStep(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the link between a governance process and that governance action process step that defines its first step.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the metadata element representing a governance action process.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeGovernanceActionProcessStep(String serverName, String serviceURLMarker, String userId, String processStepGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the metadata element representing a governance action process step.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeGovernanceActionType(String serverName, String serviceURLMarker, String userId, String governanceActionTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the metadata element representing a governance action type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeNextProcessStep(String serverName, String serviceURLMarker, String userId, String actionLinkGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove a follow-on step from a governance action process.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupFirstProcessStep(String serverName, String serviceURLMarker, String userId, String processGUID, String processStepGUID, String requestBody)
    Set up a link between a governance action process and a governance action process step.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    setupNextProcessStep(String serverName, String serviceURLMarker, String userId, String currentProcessStepGUID, String nextProcessStepGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.NextGovernanceActionProcessStepRequestBody requestBody)
    Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateActionTargetStatus(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.omf.rest.ActionTargetStatusRequestBody requestBody)
    Update the status of a specific action target.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateEngineActionStatus(String serverName, String serviceURLMarker, String userId, String engineActionGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionStatusRequestBody requestBody)
    Update the status of the engine action - providing the caller is permitted.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateGovernanceActionProcessRequestBody requestBody)
    Update the metadata element representing a governance action process.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateGovernanceActionProcessStep(String serverName, String serviceURLMarker, String userId, String processStepGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateGovernanceActionProcessStepRequestBody requestBody)
    Update the metadata element representing a governance action process step.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateGovernanceActionType(String serverName, String serviceURLMarker, String userId, String governanceActionTypeGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateGovernanceActionTypeRequestBody requestBody)
    Update the metadata element representing a governance action type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateNextProcessStep(String serverName, String serviceURLMarker, String userId, String nextProcessStepLinkGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.NextGovernanceActionProcessStepRequestBody requestBody)
    Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    withdrawGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Update the zones for the asset so that it is no longer visible to consumers.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • OpenGovernanceRESTServices

      public OpenGovernanceRESTServices()
      Default constructor

  • Method Details

    • createGovernanceActionType

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceActionType(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionTypeProperties requestBody)
      Create a new metadata element to represent a governance action type.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - properties about the process to store
      Returns:
      unique identifier of the new governance action type or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateGovernanceActionType

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceActionType(String serverName, String serviceURLMarker, String userId, String governanceActionTypeGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateGovernanceActionTypeRequestBody requestBody)
      Update the metadata element representing a governance action type.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      governanceActionTypeGUID - unique identifier of the metadata element to update
      requestBody - new properties for the metadata element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeGovernanceActionType

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeGovernanceActionType(String serverName, String serviceURLMarker, String userId, String governanceActionTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Remove the metadata element representing a governance action type.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      governanceActionTypeGUID - unique identifier of the metadata element to remove
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findGovernanceActionTypes

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypesResponse findGovernanceActionTypes(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Retrieve the list of governance action type metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGovernanceActionTypesByName

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypesResponse getGovernanceActionTypesByName(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the list of governance action type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - name to search for
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGovernanceActionTypeByGUID

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypeResponse getGovernanceActionTypeByGUID(String serverName, String serviceURLMarker, String userId, String governanceActionTypeGUID)
      Retrieve the governance action type metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      governanceActionTypeGUID - unique identifier of the governance action type
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createGovernanceActionProcess

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.NewGovernanceActionProcessRequestBody requestBody)
      Create a new metadata element to represent a governance action process.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - properties about the process to store and status value for the new process (default = ACTIVE)
      Returns:
      unique identifier of the new process or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateGovernanceActionProcess

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateGovernanceActionProcessRequestBody requestBody)
      Update the metadata element representing a governance action process.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the metadata element to update
      requestBody - new properties for the metadata element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • publishGovernanceActionProcess

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse publishGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Asset Manager OMAS).
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the metadata element to publish
      requestBody - null request body
      Returns:
      InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • withdrawGovernanceActionProcess

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse withdrawGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Asset Manager OMAS. This is the setting when the process is first created).
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the metadata element to withdraw
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeGovernanceActionProcess

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Remove the metadata element representing a governance action process.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the metadata element to remove
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findGovernanceActionProcesses

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementsResponse findGovernanceActionProcesses(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Retrieve the list of governance action process metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGovernanceActionProcessesByName

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the list of governance action process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - name to search for
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGovernanceActionProcessByGUID

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementResponse getGovernanceActionProcessByGUID(String serverName, String serviceURLMarker, String userId, String processGUID)
      Retrieve the governance action process metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the requested metadata element
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGovernanceActionProcessGraph

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessGraphResponse getGovernanceActionProcessGraph(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody requestBody)
      Retrieve the governance action process metadata element with the supplied unique identifier along with the flow definition describing its implementation.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the requested metadata element
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createGovernanceActionProcessStep

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceActionProcessStep(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessStepProperties requestBody)
      Create a new metadata element to represent a governance action process step.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - properties about the process to store
      Returns:
      unique identifier of the new governance action process step or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateGovernanceActionProcessStep

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceActionProcessStep(String serverName, String serviceURLMarker, String userId, String processStepGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateGovernanceActionProcessStepRequestBody requestBody)
      Update the metadata element representing a governance action process step.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processStepGUID - unique identifier of the metadata element to update
      requestBody - new properties for the metadata element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeGovernanceActionProcessStep

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeGovernanceActionProcessStep(String serverName, String serviceURLMarker, String userId, String processStepGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Remove the metadata element representing a governance action process step.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processStepGUID - unique identifier of the metadata element to remove
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findGovernanceActionProcessSteps

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepsResponse findGovernanceActionProcessSteps(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Retrieve the list of governance action process step metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGovernanceActionProcessStepsByName

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepsResponse getGovernanceActionProcessStepsByName(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the list of governance action process step metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - name to search for
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGovernanceActionProcessStepByGUID

      public org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepResponse getGovernanceActionProcessStepByGUID(String serverName, String serviceURLMarker, String userId, String processStepGUID)
      Retrieve the governance action process step metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processStepGUID - unique identifier of the governance action process step
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • setupFirstProcessStep

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupFirstProcessStep(String serverName, String serviceURLMarker, String userId, String processGUID, String processStepGUID, String requestBody)
      Set up a link between a governance action process and a governance action process step. This defines the first step in the process.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the governance action process
      processStepGUID - unique identifier of the governance action process step
      requestBody - optional guard
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getFirstProcessStep

      public org.odpi.openmetadata.frameworkservices.gaf.rest.FirstGovernanceActionProcessStepResponse getFirstProcessStep(String serverName, String serviceURLMarker, String userId, String processGUID)
      Return the governance action process step that is the first step in a governance action process.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the governance action process
      Returns:
      properties of the governance action process step or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeFirstProcessStep

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeFirstProcessStep(String serverName, String serviceURLMarker, String userId, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Remove the link between a governance process and that governance action process step that defines its first step.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processGUID - unique identifier of the governance action process
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • setupNextProcessStep

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse setupNextProcessStep(String serverName, String serviceURLMarker, String userId, String currentProcessStepGUID, String nextProcessStepGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.NextGovernanceActionProcessStepRequestBody requestBody)
      Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      currentProcessStepGUID - unique identifier of the governance action process step that defines the previous step in the governance action process
      nextProcessStepGUID - unique identifier of the governance action process step that defines the next step in the governance action process
      requestBody - guard required for this next step to proceed - or null for always run the next step plus flags.
      Returns:
      unique identifier of the new link or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateNextProcessStep

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateNextProcessStep(String serverName, String serviceURLMarker, String userId, String nextProcessStepLinkGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.NextGovernanceActionProcessStepRequestBody requestBody)
      Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      nextProcessStepLinkGUID - unique identifier of the relationship between the governance action process steps
      requestBody - guard required for this next step to proceed - or null for always run the next step - and flags
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getNextProcessSteps

      public org.odpi.openmetadata.frameworkservices.gaf.rest.NextGovernanceActionProcessStepsResponse getNextProcessSteps(String serverName, String serviceURLMarker, String userId, String processStepGUID, int startFrom, int pageSize)
      Return the list of next action process step defined for the governance action process.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      processStepGUID - unique identifier of the current governance action process step
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      return the list of relationships and attached governance action process steps or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeNextProcessStep

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeNextProcessStep(String serverName, String serviceURLMarker, String userId, String actionLinkGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Remove a follow-on step from a governance action process.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      actionLinkGUID - unique identifier of the relationship between the governance action process steps
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getEngineAction

      public org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementResponse getEngineAction(String serverName, String serviceURLMarker, String userId, String engineActionGUID)
      Request the status and properties of an executing engine action request.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      engineActionGUID - identifier of the engine action request.
      Returns:
      engine action properties and status or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getEngineActions

      public org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse getEngineActions(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize)
      Retrieve the engine actions that are known to the server.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - userId of caller
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getActiveEngineActions

      public org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse getActiveEngineActions(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize)
      Retrieve the engine actions that are still in process.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - userId of caller
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getActiveClaimedEngineActions

      public org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse getActiveClaimedEngineActions(String serverName, String serviceURLMarker, String userId, String governanceEngineGUID, int startFrom, int pageSize)
      Retrieve the engine actions that are still in process and that have been claimed by this caller's userId. This call is used when the caller restarts.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - userId of caller
      governanceEngineGUID - unique identifier of governance engine
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • findEngineActions

      public org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse findEngineActions(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Retrieve the list of engine action metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getEngineActionsByName

      public org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionElementsResponse getEngineActionsByName(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the list of engine action metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - name to search for
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • claimEngineAction

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse claimEngineAction(String serverName, String serviceURLMarker, String userId, String engineActionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Request that execution of an engine action is allocated to the caller.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      engineActionGUID - identifier of the engine action request
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • cancelEngineAction

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse cancelEngineAction(String serverName, String serviceURLMarker, String userId, String engineActionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Request that execution of an engine action is stopped.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      engineActionGUID - identifier of the engine action request
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • updateEngineActionStatus

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateEngineActionStatus(String serverName, String serviceURLMarker, String userId, String engineActionGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.EngineActionStatusRequestBody requestBody)
      Update the status of the engine action - providing the caller is permitted.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      engineActionGUID - identifier of the engine action request
      requestBody - new status ordinal
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • linkElementsAsDuplicates

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkElementsAsDuplicates(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.omf.rest.PeerDuplicatesRequestBody requestBody)
      Link elements as peer duplicates. Create a simple relationship between two elements. If the relationship already exists, the properties are updated.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - parameters for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • linkConsolidatedDuplicate

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkConsolidatedDuplicate(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.omf.rest.ConsolidatedDuplicatesRequestBody requestBody)
      Identify an element that acts as a consolidated version for a set of duplicate elements. (The consolidated element is created using createMetadataElement.) Creates a simple relationship between the elements. If the ConsolidatedDuplicate classification already exists, the properties are updated.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - parameters for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • updateActionTargetStatus

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateActionTargetStatus(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.omf.rest.ActionTargetStatusRequestBody requestBody)
      Update the status of a specific action target. By default, these values are derived from the values for the governance action service. However, if the governance action service has to process name target elements, then setting the status on each individual target will show the progress of the governance action service.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - caller's userId
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException the action target GUID is not recognized UserNotAuthorizedException the governance action service is not authorized to update the action target properties PropertyServerException there is a problem connecting to the metadata store

    • recordCompletionStatus

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse recordCompletionStatus(String serverName, String serviceURLMarker, String userId, String governanceActionGUID, org.odpi.openmetadata.frameworkservices.gaf.rest.CompletionStatusRequestBody requestBody)
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - caller's userId
      governanceActionGUID - unique identifier of the governance action to update
      requestBody - completion status enum value, optional guard strings for triggering subsequent action(s) plus a list of additional elements to add to the action targets for the next phase
      Returns:
      void or InvalidParameterException the completion status is null UserNotAuthorizedException the governance action service is not authorized to update the governance action service status PropertyServerException there is a problem connecting to the metadata store

    • initiateEngineAction

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse initiateEngineAction(String serverName, String serviceURLMarker, String userId, String governanceEngineName, org.odpi.openmetadata.frameworkservices.gaf.rest.InitiateEngineActionRequestBody requestBody)
      Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type. The governance action remains to act as a record of the actions taken for auditing.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - caller's userId
      governanceEngineName - name of the governance engine that should execute the request
      requestBody - properties for the governance action and to pass to the governance action service
      Returns:
      unique identifier of the governance action or InvalidParameterException null qualified name UserNotAuthorizedException this governance action service is not authorized to create a governance action PropertyServerException there is a problem with the metadata store

    • initiateGovernanceActionType

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse initiateGovernanceActionType(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.InitiateGovernanceActionTypeRequestBody requestBody)
      Using the named governance action type as a template, initiate an engine action.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - caller's userId
      requestBody - properties to initiate the new instance of the engine action
      Returns:
      unique identifier of the first governance action of the process or InvalidParameterException null or unrecognized qualified name of the process UserNotAuthorizedException this governance action service is not authorized to create a governance action process PropertyServerException there is a problem with the metadata store

    • initiateGovernanceActionProcess

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse initiateGovernanceActionProcess(String serverName, String serviceURLMarker, String userId, org.odpi.openmetadata.frameworkservices.gaf.rest.InitiateGovernanceActionProcessRequestBody requestBody)
      Using the named governance action process as a template, initiate a chain of governance actions.
      Parameters:
      serverName - name of server instance to route request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - caller's userId
      requestBody - properties to initiate the new instance of the process
      Returns:
      unique identifier of the governance action process instance or InvalidParameterException null or unrecognized qualified name of the process UserNotAuthorizedException this governance action service is not authorized to create a governance action process PropertyServerException there is a problem with the metadata store