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/automated-curation") 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, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody FilterRequestBody 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
      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)

    • getTechnologyTypesForOpenMetadataType

      @PostMapping(path="/open-metadata-types/{typeName}/technology-types") public TechnologyTypeSummaryListResponse getTechnologyTypesForOpenMetadataType(@PathVariable String serverName, @PathVariable String typeName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody(required=false) EffectiveTimeRequestBody 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
      typeName - does the value start with the supplied string?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • getTechnologyTypeDetail

      @PostMapping(path="/technology-types/by-name") public TechnologyTypeReportResponse getTechnologyTypeDetail(@PathVariable String serverName, @RequestBody 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
      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)

    • createElementFromTemplate

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

    • addCatalogTarget

      @PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}") public VoidResponse addCatalogTarget(@PathVariable String serverName, @PathVariable String integrationConnectorGUID, @PathVariable String metadataElementGUID, @RequestBody CatalogTargetProperties requestBody)
      Add a catalog target to an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      requestBody - properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • getCatalogTarget

      @GetMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}") public CatalogTargetResponse getCatalogTarget(@PathVariable String serverName, @PathVariable String integrationConnectorGUID, @PathVariable String metadataElementGUID)
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      Returns:
      details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getCatalogTargets

      @GetMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets") public CatalogTargetsResponse getCatalogTargets(@PathVariable String serverName, @PathVariable String integrationConnectorGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the details of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      integrationConnectorGUID - unique identifier of the integration connector.
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • removeCatalogTarget

      @PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}/remove") public VoidResponse removeCatalogTarget(@PathVariable String serverName, @PathVariable String integrationConnectorGUID, @PathVariable String metadataElementGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Unregister a catalog target from the integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      integrationConnectorGUID - unique identifier of the integration connector.
      metadataElementGUID - unique identifier of the governance service.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • findGovernanceActionTypes

      @PostMapping(path="/governance-action-types/by-search-string") public GovernanceActionTypesResponse findGovernanceActionTypes(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) 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)

    • 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
      requestBody - effective time
      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)

    • initiateEngineAction

      @PostMapping(path="/governance-engines/{governanceEngineName}/engine-actions/initiate") public GUIDResponse initiateEngineAction(@PathVariable String serverName, @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
      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 there is a problem with the metadata store

    • initiateGovernanceActionType

      @PostMapping(path="/governance-action-types/initiate") public GUIDResponse initiateGovernanceActionType(@PathVariable String serverName, @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
      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 there is a problem with the metadata store

    • initiateGovernanceActionProcess

      @PostMapping(path="/governance-action-processes/initiate") public GUIDResponse initiateGovernanceActionProcess(@PathVariable String serverName, @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
      requestBody - properties to initiate the new instance of the process
      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 there is a problem with the metadata store

    • getEngineAction

      @GetMapping(path="/engine-actions/{engineActionGUID}") public EngineActionElementResponse getEngineAction(@PathVariable String serverName, @PathVariable String engineActionGUID)
      Request the status and properties of an executing engine action request.
      Parameters:
      serverName - name of server instance to route request to
      engineActionGUID - identifier of the engine action request.
      Returns:
      engine action properties and status or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • cancelEngineAction

      @PostMapping(path="/engine-actions/{engineActionGUID}/cancel") public VoidResponse cancelEngineAction(@PathVariable String serverName, @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
      engineActionGUID - identifier of the engine action request.
      Returns:
      engine action properties and status or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getEngineActions

      @GetMapping(path="/engine-actions") public EngineActionElementsResponse getEngineActions(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the engine actions that are known to the server.
      Parameters:
      serverName - name of server instance to route request to
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user 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, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the engine actions that are still in process.
      Parameters:
      serverName - name of server instance to route request to
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • findEngineActions

      @PostMapping(path="/engine-actions/by-search-string") public EngineActionElementsResponse findEngineActions(@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 engine action 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)

    • getEngineActionsByName

      @PostMapping(path="/engine-actions/by-name") public EngineActionElementsResponse getEngineActionsByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody FilterRequestBody requestBody)
      Retrieve the list of engine action 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)