Package org.odpi.openmetadata.accessservices.governanceengine.server.spring

Class GovernanceActionProcessResource

  • @RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/governance-engine/users/{userId}")
public class GovernanceActionProcessResource
extends Object
    The GovernanceActionProcessResource provides the server-side implementation for defining Governance Action Processes.

    • Constructor Detail

      • GovernanceActionProcessResource

        public GovernanceActionProcessResource()
        Default constructor

    • Method Detail

      • createGovernanceActionProcess

        @PostMapping(path="/governance-action-processes/new")
public GUIDResponse createGovernanceActionProcess​(@PathVariable
                                                  String serverName,
                                                  @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
        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 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
        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 userId,
                                                   @PathVariable
                                                   String processGUID,
                                                   @RequestBody(required=false)
                                                   NullRequestBody requestBody)
        Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Asset Manager OMAS).
        Parameters:
        serverName - name of the service to route the request to
        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 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 the Asset Manager OMAS. This is the setting when the process is first created).
        Parameters:
        serverName - name of the service to route the request to
        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 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
        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 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
        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 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
        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 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
        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)

      • createGovernanceActionType

        @PostMapping(path="/governance-action-types/new")
public GUIDResponse createGovernanceActionType​(@PathVariable
                                               String serverName,
                                               @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
        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/{actionTypeGUID}/update")
public VoidResponse updateGovernanceActionType​(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String actionTypeGUID,
                                               @RequestBody
                                               UpdateGovernanceActionTypeRequestBody requestBody)
        Update the metadata element representing a governance action type.
        Parameters:
        serverName - name of the service to route the request to
        userId - calling user
        actionTypeGUID - 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/{actionTypeGUID}/remove")
public VoidResponse removeGovernanceActionType​(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String actionTypeGUID,
                                               @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
        userId - calling user
        actionTypeGUID - 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 GovernanceActionTypeElementsResponse findGovernanceActionTypes​(@PathVariable
                                                                      String serverName,
                                                                      @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
        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 GovernanceActionTypeElementsResponse getGovernanceActionTypesByName​(@PathVariable
                                                                           String serverName,
                                                                           @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
        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/{actionTypeGUID}")
public GovernanceActionTypeElementResponse getGovernanceActionTypeByGUID​(@PathVariable
                                                                         String serverName,
                                                                         @PathVariable
                                                                         String userId,
                                                                         @PathVariable
                                                                         String actionTypeGUID)
        Retrieve the governance action type metadata element with the supplied unique identifier.
        Parameters:
        serverName - name of the service to route the request to
        userId - calling user
        actionTypeGUID - 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)

      • setupFirstActionType

        @PostMapping(path="/governance-action-processes/{processGUID}/first-action-type/{actionTypeGUID}/new")
public VoidResponse setupFirstActionType​(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String processGUID,
                                         @PathVariable
                                         String actionTypeGUID,
                                         @RequestBody(required=false)
                                         String requestBody)
        Set up a link between an governance action process and a governance action type. This defines the first step in the process.
        Parameters:
        serverName - name of the service to route the request to
        userId - calling user
        processGUID - unique identifier of the governance action process
        actionTypeGUID - unique identifier of the governance action type
        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)

      • getFirstActionType

        @GetMapping(path="/governance-action-processes/{processGUID}/first-action-type")
public GovernanceActionTypeElementResponse getFirstActionType​(@PathVariable
                                                              String serverName,
                                                              @PathVariable
                                                              String userId,
                                                              @PathVariable
                                                              String processGUID)
        Return the governance action type that is the first step in a governance action process.
        Parameters:
        serverName - name of the service to route the request to
        userId - calling user
        processGUID - unique identifier of the governance action process
        Returns:
        properties of the 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)

      • removeFirstActionType

        @PostMapping(path="/governance-action-processes/{processGUID}/first-action-type/remove")
public VoidResponse removeFirstActionType​(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          String processGUID,
                                          @RequestBody(required=false)
                                          NullRequestBody requestBody)
        Remove the link between a governance process and that governance action type that defines its first step.
        Parameters:
        serverName - name of the service to route the request to
        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)

      • setupNextActionType

        @PostMapping(path="/governance-action-types/{currentActionTypeGUID}/next-action-types/{nextActionTypeGUID}/new")
public GUIDResponse setupNextActionType​(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String currentActionTypeGUID,
                                        @PathVariable
                                        String nextActionTypeGUID,
                                        @RequestBody
                                        NextGovernanceActionTypeRequestBody requestBody)
        Add a link between two governance action types 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
        userId - calling user
        currentActionTypeGUID - unique identifier of the governance action type that defines the previous step in the governance action process
        nextActionTypeGUID - unique identifier of the governance action type 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)

      • updateNextActionType

        @PostMapping(path="/next-action-types/{nextActionLinkGUID}/update")
public VoidResponse updateNextActionType​(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String nextActionLinkGUID,
                                         @RequestBody
                                         NextGovernanceActionTypeRequestBody requestBody)
        Update the properties of the link between two governance action types 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
        userId - calling user
        nextActionLinkGUID - unique identifier of the relationship between the governance action types
        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)

      • getNextGovernanceActionTypes

        @GetMapping(path="/governance-action-types/{actionTypeGUID}/next-action-type")
public NextGovernanceActionTypeElementsResponse getNextGovernanceActionTypes​(@PathVariable
                                                                             String serverName,
                                                                             @PathVariable
                                                                             String userId,
                                                                             @PathVariable
                                                                             String actionTypeGUID,
                                                                             @RequestParam
                                                                             int startFrom,
                                                                             @RequestParam
                                                                             int pageSize)
        Return the lust of next action type defined for the governance action process.
        Parameters:
        serverName - name of the service to route the request to
        userId - calling user
        actionTypeGUID - unique identifier of the current governance action type
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        return the list of relationships and attached governance action types 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)

      • removeNextActionType

        @GetMapping(path="/governance-action-types/next-action-type/{actionLinkGUID}/remove")
public VoidResponse removeNextActionType​(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String actionLinkGUID,
                                         @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
        userId - calling user
        actionLinkGUID - unique identifier of the relationship between the governance action types
        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)