Package org.odpi.openmetadata.frameworkservices.gaf.server.spring

Class GovernanceConfigurationResource

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.server.spring.GovernanceConfigurationResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/framework-services/{serviceURLMarker}/governance-configuration-service/users/{userId}") public class GovernanceConfigurationResource extends Object
EngineConfigurationResource provides the Spring wrapper for the Governance Engine Configuration Services

  • Constructor Details

    • GovernanceConfigurationResource

      public GovernanceConfigurationResource()

  • Method Details

    • createGovernanceEngine

      @PostMapping(path="/governance-engines/{typeName}") public GUIDResponse createGovernanceEngine(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String typeName, @RequestBody NewGovernanceEngineRequestBody requestBody)
      Create a new governance engine definition.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      typeName - type of governance engine
      requestBody - containing: qualifiedName - unique name for the governance engine; displayName - display name for messages and user interfaces; description - description of the types of governance services that wil be associated with this governance engine.
      Returns:
      unique identifier (guid) of the governance engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getGovernanceEngineByGUID

      @GetMapping(path="/governance-engines/{guid}") public GovernanceEngineElementResponse getGovernanceEngineByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
      Return the properties from a governance engine definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier (guid) of the governance engine definition.
      Returns:
      properties from the governance engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getGovernanceEngineByName

      @PostMapping(path="/governance-engines/by-name") public GovernanceEngineElementResponse getGovernanceEngineByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody NameRequestBody name)
      Return the properties from the named governance engine definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      name - qualified name or display name (if unique).
      Returns:
      properties from the governance engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getAllGovernanceEngines

      @GetMapping(path="/governance-engines") public GovernanceEngineElementsResponse getAllGovernanceEngines(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the list of governance engine definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of governance engine definitions or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • updateGovernanceEngine

      @PostMapping(path="/governance-engines/{guid}/update") public VoidResponse updateGovernanceEngine(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestBody UpdateGovernanceEngineRequestBody requestBody)
      Update the properties of an existing governance engine definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance engine - used to locate the definition.
      requestBody - containing the new properties of the governance engine.
      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 governance engine definition.

    • deleteGovernanceEngine

      @PostMapping(path="/governance-engines/{guid}/delete") public VoidResponse deleteGovernanceEngine(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestBody DeleteRequestBody requestBody)
      Remove the properties of the governance engine. Both the guid and the qualified name is supplied to validate that the correct governance engine is being deleted.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance engine - used to locate the definition.
      requestBody - containing the unique name for the governance engine.
      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 governance engine definition.

    • createGovernanceService

      @PostMapping(path="/governance-services/types/{typeName}") public GUIDResponse createGovernanceService(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String typeName, @RequestBody NewGovernanceServiceRequestBody requestBody)
      Create a governance service definition. The same governance service can be associated with multiple governance engines.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      typeName - type of governance service
      requestBody - containing: qualifiedName - unique name for the governance service; displayName - display name for the governance service; description - description of the analysis provided by the governance service; connection - connection to instantiate the governance service implementation.
      Returns:
      unique identifier of the governance service or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getGovernanceServiceByGUID

      @GetMapping(path="/governance-services/{guid}") public GovernanceServiceElementResponse getGovernanceServiceByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
      Return the properties from a governance service definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier (guid) of the governance service definition.
      Returns:
      properties of the governance service or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getGovernanceServiceByName

      @GetMapping(path="/governance-services/by-name") public GovernanceServiceElementResponse getGovernanceServiceByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody NameRequestBody requestBody)
      Return the properties from a governance service definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      requestBody - qualified name or display name (if unique).
      Returns:
      properties from the governance engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getAllGovernanceServices

      @GetMapping(path="/governance-services") public GovernanceServiceElementsResponse getAllGovernanceServices(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the list of governance services definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of governance service definitions or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getGovernanceServiceRegistrations

      @GetMapping(path="/governance-services/{guid}/registrations") public GUIDListResponse getGovernanceServiceRegistrations(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
      Return the list of governance engines that a specific governance service is registered with.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - governance service to search for.
      Returns:
      list of governance engine unique identifiers (guids) or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • updateGovernanceService

      @PostMapping(path="/governance-services/{guid}/update") public VoidResponse updateGovernanceService(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestBody UpdateGovernanceServiceRequestBody requestBody)
      Update the properties of an existing governance service definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance service - used to locate the definition.
      requestBody - containing the new parameters for the governance service.
      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 governance engine definition.

    • deleteGovernanceService

      @PostMapping(path="/governance-services/{guid}/delete") public VoidResponse deleteGovernanceService(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestBody DeleteRequestBody requestBody)
      Remove the properties of the governance service. Both the guid and the qualified name is supplied to validate that the correct governance service is being deleted. The governance service is also unregistered from its governance engines.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance service - used to locate the definition.
      requestBody - containing the unique name for the governance service.
      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 governance engine definition.

    • registerGovernanceServiceWithEngine

      @PostMapping(path="/governance-engines/{guid}/governance-services") public VoidResponse registerGovernanceServiceWithEngine(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestBody GovernanceServiceRegistrationRequestBody requestBody)
      Register a governance service with a specific governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance engine.
      requestBody - containing: guid - unique identifier of the governance service; governanceRequestTypes - list of asset governance types that this governance service is able to process.
      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 governance engine definition.

    • getRegisteredGovernanceService

      @GetMapping(path="/governance-engines/{governanceEngineGUID}/governance-services/{governanceServiceGUID}") public RegisteredGovernanceServiceResponse getRegisteredGovernanceService(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceEngineGUID, @PathVariable String governanceServiceGUID)
      Retrieve a specific governance service registered with a governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      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 governance engine definition.

    • getRegisteredGovernanceServices

      @GetMapping(path="/governance-engines/{governanceEngineGUID}/governance-services") public RegisteredGovernanceServicesResponse getRegisteredGovernanceServices(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceEngineGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Retrieve the identifiers of the governance services registered with a governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      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 governance engine definition.

    • unregisterGovernanceServiceFromEngine

      @PostMapping(path="/governance-engines/{governanceEngineGUID}/governance-services/{governanceServiceGUID}/delete") public VoidResponse unregisterGovernanceServiceFromEngine(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceEngineGUID, @PathVariable String governanceServiceGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Unregister a governance service from the governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - 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 governance engine definition.

    • createIntegrationGroup

      @PostMapping(path="/integration-groups/new") public GUIDResponse createIntegrationGroup(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody IntegrationGroupProperties requestBody)
      Create a new integration group definition.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      requestBody - containing properties of integration group.
      Returns:
      unique identifier (guid) of the integration group definition 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 group definition.

    • getIntegrationGroupByGUID

      @GetMapping(path="/integration-groups/{guid}") public IntegrationGroupElementResponse getIntegrationGroupByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
      Return the properties from an integration group definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier (guid) of the integration group definition.
      Returns:
      properties from the integration group definition 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 group definition.

    • getIntegrationGroupByName

      @GetMapping(path="/integration-groups/by-name/{name}") public IntegrationGroupElementResponse getIntegrationGroupByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String name)
      Return the properties from an integration group definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      name - qualified name or display name (if unique).
      Returns:
      properties from the integration group definition 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 group definition.

    • getAllIntegrationGroups

      @GetMapping(path="/integration-groups") public IntegrationGroupElementsResponse getAllIntegrationGroups(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the list of integration group definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of integration group definitions 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 group definition.

    • updateIntegrationGroup

      @PostMapping(path="/integration-groups/{guid}/update") public VoidResponse updateIntegrationGroup(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestParam boolean isMergeUpdate, @RequestBody IntegrationGroupProperties requestBody)
      Update the properties of an existing integration group definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the integration group - used to locate the definition.
      isMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with matching names, or should the entire properties of the instance be replaced?
      requestBody - containing the new properties of the integration group.
      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 group definition.

    • deleteIntegrationGroup

      @PostMapping(path="/integration-groups/{guid}/delete") public VoidResponse deleteIntegrationGroup(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestBody DeleteRequestBody requestBody)
      Remove the properties of the integration group. Both the guid and the qualified name is supplied to validate that the correct integration group is being deleted.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the integration group - used to locate the definition.
      requestBody - containing the unique name for the integration group.
      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 group definition.

    • createIntegrationConnector

      @PostMapping(path="/integration-connectors/new") public GUIDResponse createIntegrationConnector(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody IntegrationConnectorProperties requestBody)
      Create an integration connector definition. The same integration connector can be associated with multiple integration groups.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      requestBody - containing: qualifiedName - unique name for the integration connector; displayName - display name for the integration connector; description - description of the analysis provided by the integration connector; connection - connection to instantiate the integration connector implementation.
      Returns:
      unique identifier of the integration connector 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 group definition.

    • getIntegrationConnectorByGUID

      @GetMapping(path="/integration-connectors/{guid}") public IntegrationConnectorElementResponse getIntegrationConnectorByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
      Return the properties from an integration connector definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier (guid) of the integration connector definition.
      Returns:
      properties of the integration connector 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 group definition.

    • getIntegrationConnectorByName

      @GetMapping(path="/integration-connectors/by-name/{name}") public IntegrationConnectorElementResponse getIntegrationConnectorByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String name)
      Return the properties from an integration connector definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      name - qualified name or display name (if unique).
      Returns:
      properties from the integration group definition 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 group definition.

    • getAllIntegrationConnectors

      @GetMapping(path="/integration-connectors") public IntegrationConnectorElementsResponse getAllIntegrationConnectors(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the list of integration connectors definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of integration connector definitions 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 group definition.

    • getIntegrationConnectorRegistrations

      @GetMapping(path="/integration-connectors/{guid}/registrations") public GUIDListResponse getIntegrationConnectorRegistrations(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
      Return the list of integration groups that a specific integration connector is registered with.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - integration connector to search for.
      Returns:
      list of integration group unique identifiers (guids) 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 group definition.

    • updateIntegrationConnector

      @PostMapping(path="/integration-connectors/{guid}/update") public VoidResponse updateIntegrationConnector(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestParam boolean isMergeUpdate, @RequestBody IntegrationConnectorProperties requestBody)
      Update the properties of an existing integration connector definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the integration connector - used to locate the definition.
      isMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with matching names, or should the entire properties of the instance be replaced?
      requestBody - containing the new parameters for the integration connector.
      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 group definition.

    • deleteIntegrationConnector

      @PostMapping(path="/integration-connectors/{guid}/delete") public VoidResponse deleteIntegrationConnector(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid, @RequestBody DeleteRequestBody requestBody)
      Remove the properties of the integration connector. Both the guid and the qualified name is supplied to validate that the correct integration connector is being deleted. The integration connector is also unregistered from its integration groups.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the integration connector - used to locate the definition.
      requestBody - containing the unique name for the integration connector.
      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 group definition.

    • registerIntegrationConnectorWithGroup

      @PostMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors/{integrationConnectorGUID}") public VoidResponse registerIntegrationConnectorWithGroup(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String integrationGroupGUID, @PathVariable String integrationConnectorGUID, @RequestBody RegisteredIntegrationConnectorProperties requestBody)
      Register an integration connector with a specific integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      requestBody - containing: integrationGroupGUID - unique identifier of the integration connector; governanceRequestTypes - list of asset governance types that this integration connector is able to process.
      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 group definition.

    • getRegisteredIntegrationConnector

      @GetMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors/{integrationConnectorGUID}") public RegisteredIntegrationConnectorResponse getRegisteredIntegrationConnector(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String integrationGroupGUID, @PathVariable String integrationConnectorGUID)
      Retrieve a specific integration connector registered with an integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      Returns:
      details of the integration connector 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 group definition.

    • getRegisteredIntegrationConnectors

      @GetMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors") public RegisteredIntegrationConnectorsResponse getRegisteredIntegrationConnectors(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String integrationGroupGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Retrieve the details of the integration connectors registered with an integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      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 group definition.

    • unregisterIntegrationConnectorFromGroup

      @PostMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors/{integrationConnectorGUID}/delete") public VoidResponse unregisterIntegrationConnectorFromGroup(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String integrationGroupGUID, @PathVariable String integrationConnectorGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Unregister an integration connector from the integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      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 group definition.

    • addCatalogTarget

      @PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}") public GUIDResponse addCatalogTarget(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      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:
      guid 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.

    • updateCatalogTarget

      @PostMapping(path="/catalog-targets/{relationshipGUID}/update") public VoidResponse updateCatalogTarget(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody CatalogTargetProperties requestBody)
      Update a catalog target for an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      relationshipGUID - 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="/catalog-targets/{relationshipGUID}") public CatalogTargetResponse getCatalogTarget(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID)
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the relationship
      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 serviceURLMarker, @PathVariable String userId, @PathVariable String integrationConnectorGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration connector.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      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="/catalog-targets/{relationshipGUID}/delete") public VoidResponse removeCatalogTarget(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody NullRequestBody requestBody)
      Unregister a catalog target from the integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the relationship.
      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.