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

Class AutomatedCurationResource

java.lang.Object
org.odpi.openmetadata.viewservices.automatedcuration.server.spring.AutomatedCurationResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}") public class AutomatedCurationResource extends Object
The AutomatedCurationResource provides the Spring API endpoints of the Automated Curation Open Metadata View Service (OMVS). =

  • Constructor Details

    • AutomatedCurationResource

      public AutomatedCurationResource()
      Default constructor

  • Method Details

    • findTechnologyTypes

      @PostMapping(path="/technology-types/by-search-string") public TechnologyTypeSummaryListResponse findTechnologyTypes(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of deployed implementation type metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • getTechnologyTypesForOpenMetadataType

      @PostMapping(path="/open-metadata-types/{typeName}/technology-types") public TechnologyTypeSummaryListResponse getTechnologyTypesForOpenMetadataType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String typeName, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the list of deployed implementation type metadata elements linked to a particular open metadata type.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      typeName - does the value start with the supplied string?
      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 a problem reported in the open metadata server(s)

    • getTechnologyTypeDetail

      @PostMapping(path="/technology-types/by-name") public TechnologyTypeReportResponse getTechnologyTypeDetail(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element. There are no wildcards allowed in the name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • getTechnologyTypeHierarchy

      @PostMapping(path="/technology-types/hierarchy") public TechnologyTypeHierarchyResponse getTechnologyTypeHierarchy(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element and its subtypes. A mermaid version if the hierarchy is also returned.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • getTechnologyTypeElements

      @PostMapping(path="/technology-types/elements") public OpenMetadataRootElementsResponse getTechnologyTypeElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Retrieve the elements for the requested deployed implementation type. There are no wildcards allowed in the name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - the deployedImplementationType 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 a problem reported in the open metadata server(s)

    • createElementFromTemplate

      @PostMapping(path="/catalog-templates/new-element") public GUIDResponse createElementFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody TemplateRequestBody requestBody)
      Create a new element from a template.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - information about the template
      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 a problem reported in the open metadata server(s)

    • saveClientSideSecret

      @PostMapping("/secrets-stores/{secretsStoreGUID}/client-side-secret/save") public VoidResponse saveClientSideSecret(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String secretsStoreGUID, @RequestBody(required=false) SecretsCollectionRequestBody requestBody)
      Creates or replaces the details of a client-side secret in the requested secret store.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      secretsStoreGUID - unique identifier of secret store asset
      requestBody - details of the secrets collection
      Returns:
      a list of projects InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteClientSideSecret

      @PostMapping("/secrets-stores/{secretsStoreGUID}/client-side-secret/delete") public VoidResponse deleteClientSideSecret(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String secretsStoreGUID, @RequestBody(required=false) NameRequestBody requestBody)
      Deletes a client-side secret from the requested secret store.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      secretsStoreGUID - unique identifier of secret store asset
      requestBody - details of the secrets collection
      Returns:
      a list of projects InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • initiateEngineAction

      @PostMapping(path="/governance-engines/{governanceEngineName}/engine-actions/initiate") public GUIDResponse initiateEngineAction(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceEngineName, @RequestBody InitiateEngineActionRequestBody requestBody)
      Create an engine action in the metadata store that will trigger the governance service associated with the supplied request type. The engine action remains to act as a record of the actions taken for auditing.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      governanceEngineName - name of the governance engine that should execute the request
      requestBody - properties for the engine action and to pass to the governance service
      Returns:
      unique identifier of the engine action or InvalidParameterException null qualified name UserNotAuthorizedException the caller is not authorized to create an engine action PropertyServerException a problem with the metadata store

    • initiateGovernanceActionType

      @PostMapping(path="/governance-action-types/initiate") public GUIDResponse initiateGovernanceActionType(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody InitiateGovernanceActionTypeRequestBody requestBody)
      Using the named governance action process as a template, initiate a chain of engine actions.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - properties to initiate the new instance of the engine action
      Returns:
      unique identifier of the first engine action of the process or InvalidParameterException null or unrecognized qualified name of the process UserNotAuthorizedException the caller is not authorized to create a governance action process PropertyServerException a problem with the metadata store

    • initiateGovernanceActionProcess

      @PostMapping(path="/governance-action-processes/initiate") public GUIDResponse initiateGovernanceActionProcess(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody InitiateGovernanceActionProcessRequestBody requestBody)
      Using the named governance action process as a template, initiate a chain of engine actions.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - properties to initiate the new instance of the process
      Returns:
      unique identifier of the governance action process instance or InvalidParameterException null or unrecognized qualified name of the process UserNotAuthorizedException the caller is not authorized to create a governance action process PropertyServerException a problem with the metadata store

    • cancelEngineAction

      @PostMapping(path="/engine-actions/{engineActionGUID}/cancel") public VoidResponse cancelEngineAction(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String engineActionGUID)
      Request that an engine action request is cancelled and any running governance service is stopped.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      engineActionGUID - identifier of the engine action request.
      Returns:
      engine action properties and status or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getActiveEngineActions

      @GetMapping(path="/engine-actions/active") public EngineActionElementsResponse getActiveEngineActions(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize)
      Retrieve the engine actions that are still in process.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      startFrom - starting from position
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • updateEngineActionStatus

      @PostMapping(path="/engine-actions/{engineActionGUID}/status/update") public VoidResponse updateEngineActionStatus(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String engineActionGUID, @RequestBody EngineActionStatusRequestBody requestBody)
      Update the status of the engine action - providing the caller is permitted.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      engineActionGUID - identifier of the engine action request
      requestBody - new status enum
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • claimEngineAction

      @PostMapping(path="/engine-actions/{engineActionGUID}/claim") public VoidResponse claimEngineAction(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String engineActionGUID)
      Request that execution of an engine action is allocated to the caller.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      engineActionGUID - identifier of the engine action request
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getActiveClaimedEngineActions

      @GetMapping(path="/governance-engines/{governanceEngineGUID}/engine-actions/active-claimed") public EngineActionElementsResponse getActiveClaimedEngineActions(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceEngineGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize)
      Retrieve the engine actions that are still in process and that have been claimed by this caller's userId. This call is used when the caller restarts.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      governanceEngineGUID - unique identifier of governance engine
      startFrom - starting from position
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • updateActionTargetStatus

      @PostMapping(path="/engine-actions/action-targets/update") public VoidResponse updateActionTargetStatus(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody ActionTargetStatusRequestBody requestBody)
      Update the status of a specific action target. By default, these values are derived from the values for the governance action service. However, if the governance action service has to process many target elements, then setting the status on each individual target will show the progress of the governance action service.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - the action target and its new status
      Returns:
      void or InvalidParameterException the action target GUID is not recognized. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • recordCompletionStatus

      @PostMapping(path="/engine-actions/{engineActionGUID}/completion-status") public VoidResponse recordCompletionStatus(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String engineActionGUID, @RequestBody CompletionStatusRequestBody requestBody)
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      engineActionGUID - unique identifier of the associated engine action
      requestBody - completion status, output guards, new action targets and completion message
      Returns:
      void or InvalidParameterException the completion status is null. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.