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

Class OpenGovernanceResource

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.server.spring.OpenGovernanceResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/framework-services/{serviceURLMarker}/open-governance-service/users/{userId}") public class OpenGovernanceResource extends Object
OpenGovernanceResource supports the REST APIs for common governance functions.

  • Constructor Details

    • OpenGovernanceResource

      public OpenGovernanceResource()

  • Method Details

    • createGovernanceActionType

      @PostMapping(path="/governance-action-types") public GUIDResponse createGovernanceActionType(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody 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

      @PostMapping(path="/governance-action-types/{governanceActionTypeGUID}/update") public VoidResponse updateGovernanceActionType(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceActionTypeGUID, @RequestBody 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

      @PostMapping(path="/governance-action-types/{governanceActionTypeGUID}/remove") public VoidResponse removeGovernanceActionType(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceActionTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/governance-action-types/by-search-string") public GovernanceActionTypesResponse findGovernanceActionTypes(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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

      @PostMapping(path="/governance-action-types/by-name") public GovernanceActionTypesResponse getGovernanceActionTypesByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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

      @GetMapping(path="/governance-action-types/{governanceActionTypeGUID}") public GovernanceActionTypeResponse getGovernanceActionTypeByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable 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

      @PostMapping(path="/governance-action-processes") public GUIDResponse createGovernanceActionProcess(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody 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

      @PostMapping(path="/governance-action-processes/{processGUID}/update") public VoidResponse updateGovernanceActionProcess(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processGUID, @RequestBody 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

      @PostMapping(path="/governance-action-processes/{processGUID}/publish") public VoidResponse publishGovernanceActionProcess(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Update the zones for the governance action process (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 an Open Metadata AccessService (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

      @PostMapping(path="/governance-action-processes/{processGUID}/withdraw") public VoidResponse withdrawGovernanceActionProcess(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processGUID, @RequestBody(required=false) 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 an Open Metadata AccessService (OMAS). This is also the setting for the zones 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

      @PostMapping(path="/governance-action-processes/{processGUID}/remove") public VoidResponse removeGovernanceActionProcess(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processGUID, @RequestBody(required=false) 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

      @PostMapping(path="/governance-action-processes/by-search-string") public GovernanceActionProcessElementsResponse findGovernanceActionProcesses(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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

      @PostMapping(path="/governance-action-processes/by-name") public GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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

      @GetMapping(path="/governance-action-processes/{processGUID}") public GovernanceActionProcessElementResponse getGovernanceActionProcessByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable 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

      @PostMapping(path="/governance-action-processes/{processGUID}/graph") public GovernanceActionProcessGraphResponse getGovernanceActionProcessGraph(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processGUID, @RequestBody(required=false) 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

      @PostMapping(path="/governance-action-process-steps") public GUIDResponse createGovernanceActionProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody 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

      @PostMapping(path="/governance-action-process-steps/{governanceActionTypeGUID}/update") public VoidResponse updateGovernanceActionProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceActionTypeGUID, @RequestBody 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
      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)

    • removeGovernanceActionProcessStep

      @PostMapping(path="/governance-action-process-steps/{processStepGUID}/remove") public VoidResponse removeGovernanceActionProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processStepGUID, @RequestBody(required=false) 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

      @PostMapping(path="/governance-action-process-steps/by-search-string") public GovernanceActionProcessStepsResponse findGovernanceActionProcessSteps(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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

      @PostMapping(path="/governance-action-process-steps/by-name") public GovernanceActionProcessStepsResponse getGovernanceActionProcessStepsByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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

      @GetMapping(path="/governance-action-process-steps/{processStepGUID}") public GovernanceActionProcessStepResponse getGovernanceActionProcessStepByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable 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

      @PostMapping(path="/governance-action-processes/{processGUID}/first-process-step/{processStepGUID}") public VoidResponse setupFirstProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processGUID, @PathVariable String processStepGUID, @RequestBody(required=false) 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

      @GetMapping(path="/governance-action-processes/{processGUID}/first-process-step") public FirstGovernanceActionProcessStepResponse getFirstProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable 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

      @PostMapping(path="/governance-action-processes/{processGUID}/first-process-step/remove") public VoidResponse removeFirstProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processGUID, @RequestBody(required=false) 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

      @PostMapping(path="/governance-action-process-steps/{currentProcessStepGUID}/next-process-steps/{nextProcessStepGUID}") public GUIDResponse setupNextProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String currentProcessStepGUID, @PathVariable String nextProcessStepGUID, @RequestBody 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

      @PostMapping(path="/governance-action-process-steps/next-process-steps/{nextProcessStepLinkGUID}/update") public VoidResponse updateNextProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String nextProcessStepLinkGUID, @RequestBody 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

      @GetMapping(path="/governance-action-process-steps/{processStepGUID}/next-process-steps") public NextGovernanceActionProcessStepsResponse getNextProcessSteps(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String processStepGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Return the list of next process steps 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 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)

    • removeNextProcessStep

      @PostMapping(path="/governance-action-process-steps/next-process-step/{relationshipGUID}/remove") public VoidResponse removeNextProcessStep(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody(required=false) 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
      relationshipGUID - 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)

    • initiateEngineAction

      @PostMapping(path="/governance-engines/{governanceEngineName}/engine-actions/initiate") public GUIDResponse initiateEngineAction(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceEngineName, @RequestBody InitiateEngineActionRequestBody requestBody)
      Create an engine action in the metadata store that will trigger the governance service associated with the supplied request type. The engine 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 engine action and to pass to the governance service
      Returns:
      unique identifier of the engine action or InvalidParameterException null qualified name UserNotAuthorizedException the caller is not authorized to create an engine action PropertyServerException there is a problem with the metadata store

    • initiateGovernanceAction

      @PostMapping(path="/governance-engines/{governanceEngineName}/governance-actions/initiate") @Deprecated public GUIDResponse initiateGovernanceAction(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceEngineName, @RequestBody GovernanceActionRequestBody requestBody)
      Deprecated.
      Create a governance action in the metadata store which will trigger the governance 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 service
      Returns:
      unique identifier of the engine action or InvalidParameterException null qualified name UserNotAuthorizedException the caller is not authorized to create a governance action PropertyServerException there is a problem with the metadata store

    • initiateGovernanceActionType

      @PostMapping(path="/governance-action-types/initiate") public GUIDResponse initiateGovernanceActionType(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody InitiateGovernanceActionTypeRequestBody requestBody)
      Using the named governance action process as a template, initiate a chain of engine 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 engine action
      Returns:
      unique identifier of the first engine action of the process or InvalidParameterException null or unrecognized qualified name of the process UserNotAuthorizedException the caller is not authorized to create a governance action process PropertyServerException there is a problem with the metadata store

    • initiateGovernanceActionProcess

      @PostMapping(path="/governance-action-processes/initiate") public GUIDResponse initiateGovernanceActionProcess(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody InitiateGovernanceActionProcessRequestBody requestBody)
      Using the named governance action process as a template, initiate a chain of engine 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 the caller is not authorized to create a governance action process PropertyServerException there is a problem with the metadata store

    • getEngineAction

      @GetMapping(path="/engine-actions/{engineActionGUID}") public EngineActionElementResponse getEngineAction(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable 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.

    • cancelEngineAction

      @PostMapping(path="/engine-actions/{engineActionGUID}/cancel") public VoidResponse cancelEngineAction(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String engineActionGUID, @RequestBody(required=false) 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.

    • getEngineActions

      @GetMapping(path="/engine-actions") public EngineActionElementsResponse getEngineActions(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam 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

      @GetMapping(path="/engine-actions/active") public EngineActionElementsResponse getActiveEngineActions(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam 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.

    • findEngineActions

      @PostMapping(path="/engine-actions/by-search-string") public EngineActionElementsResponse findEngineActions(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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

      @PostMapping(path="/engine-actions/by-name") public EngineActionElementsResponse getEngineActionsByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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)

    • linkElementsAsPeerDuplicates

      @PostMapping(path="/related-elements/link-as-peer-duplicate") public VoidResponse linkElementsAsPeerDuplicates(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody PeerDuplicatesRequestBody requestBody)
      Create a relationship between two elements that show they represent the same "thing". 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

      @PostMapping(path="/related-elements/link-as-consolidated-duplicate") public VoidResponse linkConsolidatedDuplicate(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody ConsolidatedDuplicatesRequestBody requestBody)
      Create a relationship between two elements that shows that one is a combination of a number of duplicates, and it should be used instead. 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