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 Details

    • ActionAuthorResource

      public ActionAuthorResource()
      Default constructor

  • Method Details

    • linkTargetForGovernanceAction

      @PostMapping(path="/governance-actions/{governanceActionGUID}/action-targets/{elementGUID}/attach") public VoidResponse linkTargetForGovernanceAction(@PathVariable String serverName, @PathVariable String governanceActionGUID, @PathVariable String elementGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Link a governance action to the element it is to work on (action target).
      Parameters:
      serverName - name of the service to route the request to
      governanceActionGUID - unique identifier of the governance action
      elementGUID - unique identifier of the target
      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)

    • detachTargetForGovernanceAction

      @PostMapping(path="/governance-actions/{governanceActionGUID}/action-targets/{elementGUID}/detach") public VoidResponse detachTargetForGovernanceAction(@PathVariable String serverName, @PathVariable String governanceActionGUID, @PathVariable String elementGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a governance action from the element it is to work on (action target).
      Parameters:
      serverName - name of the service to route the request to
      governanceActionGUID - unique identifier of the governance action
      elementGUID - unique identifier of the target
      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)

    • linkGovernanceActionExecutor

      @PostMapping(path="/governance-action-types/{governanceActionTypeGUID}/governance-engine-executor/{governanceEngineGUID}/attach") public VoidResponse linkGovernanceActionExecutor(@PathVariable String serverName, @PathVariable String governanceActionTypeGUID, @PathVariable String governanceEngineGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Link a governance action type to the governance engine that it is to call.
      Parameters:
      serverName - name of the service to route the request to
      governanceActionTypeGUID - unique identifier of the governance action type
      governanceEngineGUID - unique identifier of the governance engine to call
      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)

    • detachGovernanceActionExecutor

      @PostMapping(path="/governance-action-types/{governanceActionTypeGUID}/governance-engine-executor/{governanceEngineGUID}/detach") public VoidResponse detachGovernanceActionExecutor(@PathVariable String serverName, @PathVariable String governanceActionTypeGUID, @PathVariable String governanceEngineGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a governance action type from the governance engine that it is to call.
      Parameters:
      serverName - name of the service to route the request to
      governanceActionTypeGUID - unique identifier of the governance action type
      governanceEngineGUID - unique identifier of the governance engine to call
      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)

    • setupFirstActionProcessStep

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

    • removeFirstProcessStep

      @PostMapping(path="/governance-action-processes/{processGUID}/first-process-step/{firstProcessStepGUID}/detach") public VoidResponse removeFirstProcessStep(@PathVariable String serverName, @PathVariable String processGUID, @PathVariable String firstProcessStepGUID, @RequestBody(required=false) DeleteRelationshipRequestBody 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
      firstProcessStepGUID - unique identifier of the first step in the 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}/attach") public GUIDResponse setupNextActionProcessStep(@PathVariable String serverName, @PathVariable String currentProcessStepGUID, @PathVariable String nextProcessStepGUID, @RequestBody NewRelationshipRequestBody 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 UpdateRelationshipRequestBody 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)

    • removeNextActionProcessStep

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