Package org.odpi.openmetadata.viewservices.actionauthor.server.spring

Class ActionAuthorResource

java.lang.Object
org.odpi.openmetadata.viewservices.actionauthor.server.spring.ActionAuthorResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/action-author") public class ActionAuthorResource extends Object
The ActionAuthorResource provides the Spring API endpoints of the Action Author Open Metadata View Service (OMVS). =

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActionAuthorResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createGovernanceActionProcess(String serverName, 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, 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, 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.GovernanceActionProcessElementsResponse
    findGovernanceActionProcesses(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody requestBody)
    Retrieve the list of governance action type metadata elements that contain the search string.
    org.odpi.openmetadata.frameworkservices.gaf.rest.FirstGovernanceActionProcessStepResponse
    getFirstActionProcessStep(String serverName, 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 processGUID)
    Retrieve the governance action process metadata element with the supplied unique identifier.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementsResponse
    getGovernanceActionProcessesByName(String serverName, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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 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 processStepGUID)
    Retrieve the governance action process step metadata element with the supplied unique identifier.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepsResponse
    getGovernanceActionProcessStepsByName(String serverName, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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 governanceActionTypeGUID)
    Retrieve the governance action type metadata element with the supplied unique identifier.
    org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypesResponse
    getGovernanceActionTypesByName(String serverName, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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 processStepGUID, int startFrom, int pageSize)
    Return the list of next process steps defined for the governance action process.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    publishGovernanceActionProcess(String serverName, String processGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Update the zones for the governance action process (asset) so that it becomes visible to consumers.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeFirstProcessStep(String serverName, 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 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 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 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
    removeNextActionProcessStep(String serverName, String relationshipGUID, 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
    setupFirstActionProcessStep(String serverName, String processGUID, String processStepGUID, org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody requestBody)
    Set up a link between a governance action process and a governance action process step.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    setupNextActionProcessStep(String serverName, 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
    updateGovernanceActionProcess(String serverName, 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 governanceActionTypeGUID, 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 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
    updateNextActionProcessStep(String serverName, 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 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

    • ActionAuthorResource

      public ActionAuthorResource()
      Default constructor

  • Method Details

    • createGovernanceActionType

      @PostMapping(path="/governance-action-types") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceActionType(@PathVariable String serverName, @RequestBody 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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceActionType(@PathVariable String serverName, @PathVariable String governanceActionTypeGUID, @RequestBody 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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeGovernanceActionType(@PathVariable String serverName, @PathVariable String governanceActionTypeGUID, @RequestBody(required=false) 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
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypesResponse findGovernanceActionTypes(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody requestBody)
      Retrieve the list of governance action type metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypesResponse getGovernanceActionTypesByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionTypeResponse getGovernanceActionTypeByGUID(@PathVariable String serverName, @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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceActionProcess(@PathVariable String serverName, @RequestBody 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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceActionProcess(@PathVariable String serverName, @PathVariable String processGUID, @RequestBody 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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse publishGovernanceActionProcess(@PathVariable String serverName, @PathVariable String processGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse withdrawGovernanceActionProcess(@PathVariable String serverName, @PathVariable String processGUID, @RequestBody(required=false) 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 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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeGovernanceActionProcess(@PathVariable String serverName, @PathVariable String processGUID, @RequestBody(required=false) 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
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementsResponse findGovernanceActionProcesses(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody requestBody)
      Retrieve the list of governance action process metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessElementResponse getGovernanceActionProcessByGUID(@PathVariable String serverName, @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
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessGraphResponse getGovernanceActionProcessGraph(@PathVariable String serverName, @PathVariable String processGUID, @RequestBody(required=false) 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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceActionProcessStep(@PathVariable String serverName, @RequestBody 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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceActionProcessStep(@PathVariable String serverName, @PathVariable String governanceActionTypeGUID, @RequestBody 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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeGovernanceActionProcessStep(@PathVariable String serverName, @PathVariable String processStepGUID, @RequestBody(required=false) 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
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepsResponse findGovernanceActionProcessSteps(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody requestBody)
      Retrieve the list of governance action process step metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepsResponse getGovernanceActionProcessStepsByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.GovernanceActionProcessStepResponse getGovernanceActionProcessStepByGUID(@PathVariable String serverName, @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
      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)

    • setupFirstActionProcessStep

      @PostMapping(path="/governance-action-processes/{processGUID}/first-process-step/{processStepGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupFirstActionProcessStep(@PathVariable String serverName, @PathVariable String processGUID, @PathVariable String processStepGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.FilterRequestBody 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
      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)

    • getFirstActionProcessStep

      @GetMapping(path="/governance-action-processes/{processGUID}/first-process-step") public org.odpi.openmetadata.frameworkservices.gaf.rest.FirstGovernanceActionProcessStepResponse getFirstActionProcessStep(@PathVariable String serverName, @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
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeFirstProcessStep(@PathVariable String serverName, @PathVariable String processGUID, @RequestBody(required=false) 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
      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)

    • setupNextActionProcessStep

      @PostMapping(path="/governance-action-process-steps/{currentProcessStepGUID}/next-process-steps/{nextProcessStepGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse setupNextActionProcessStep(@PathVariable String serverName, @PathVariable String currentProcessStepGUID, @PathVariable String nextProcessStepGUID, @RequestBody 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
      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)

    • updateNextActionProcessStep

      @PostMapping(path="/governance-action-process-steps/next-process-steps/{nextProcessStepLinkGUID}/update") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateNextActionProcessStep(@PathVariable String serverName, @PathVariable String nextProcessStepLinkGUID, @RequestBody 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
      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 org.odpi.openmetadata.frameworkservices.gaf.rest.NextGovernanceActionProcessStepsResponse getNextProcessSteps(@PathVariable String serverName, @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
      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)

    • removeNextActionProcessStep

      @PostMapping(path="/governance-action-process-steps/next-process-step/{relationshipGUID}/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeNextActionProcessStep(@PathVariable String serverName, @PathVariable String relationshipGUID, @RequestBody(required=false) 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
      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)