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

Class GovernanceAuthorResource

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

  • Constructor Details

    • GovernanceAuthorResource

      public GovernanceAuthorResource()
      Default constructor

  • Method Details

    • createGovernanceActionType

      @PostMapping(path="/governance-action-types") public GUIDResponse createGovernanceActionType(@PathVariable String serverName, @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
      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 governanceActionTypeGUID, @RequestBody 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 VoidResponse removeGovernanceActionType(@PathVariable String serverName, @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
      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, @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 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 GovernanceActionTypesResponse getGovernanceActionTypesByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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 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 GUIDResponse createGovernanceActionProcess(@PathVariable String serverName, @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
      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 processGUID, @RequestBody 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 VoidResponse publishGovernanceActionProcess(@PathVariable String serverName, @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
      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 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
      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 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
      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, @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 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 GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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 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 GovernanceActionProcessGraphResponse getGovernanceActionProcessGraph(@PathVariable String serverName, @PathVariable String processGUID, @RequestBody(required=false) EffectiveTimeRequestBody 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 GUIDResponse createGovernanceActionProcessStep(@PathVariable String serverName, @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
      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 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
      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 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
      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, @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 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 GovernanceActionProcessStepsResponse getGovernanceActionProcessStepsByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody 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 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 VoidResponse setupFirstActionProcessStep(@PathVariable String serverName, @PathVariable String processGUID, @PathVariable String processStepGUID, @RequestBody(required=false) 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 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 VoidResponse removeFirstProcessStep(@PathVariable String serverName, @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
      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 GUIDResponse setupNextActionProcessStep(@PathVariable String serverName, @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
      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 VoidResponse updateNextActionProcessStep(@PathVariable String serverName, @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
      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 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 VoidResponse removeNextActionProcessStep(@PathVariable String serverName, @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
      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)