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

Class AssetManagerOMASResource

  • @RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-manager/users/{userId}")
public class AssetManagerOMASResource
extends Object
    Server-side REST API support for asset manager independent REST endpoints

    • Constructor Detail

      • AssetManagerOMASResource

        public AssetManagerOMASResource()
        Instantiates a new Asset Manager OMAS resource.

    • Method Detail

      • getOutTopicConnection

        @GetMapping(path="/topics/out-topic-connection/{callerId}")
public ConnectionResponse getOutTopicConnection​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String callerId)
        Return the connection object for the Asset Manager OMAS's out topic.
        Parameters:
        serverName - name of the server to route the request to
        userId - identifier of calling user
        callerId - unique identifier for the caller
        Returns:
        connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

      • createExternalAssetManager

        @PostMapping(path="/asset-managers")
public GUIDResponse createExternalAssetManager​(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @RequestBody
                                               AssetManagerProperties assetManagerProperties)
        Create information about the external asset manager. This is represented as a software server capability and all information that is specific to the external asset manager (such as the identifiers of the metadata elements it stores) will be linked to it.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetManagerProperties - description of the integration daemon (specify qualified name at a minimum)
        Returns:
        unique identifier of the asset management's software server capability or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

      • getExternalAssetManagerGUID

        @GetMapping(path="/asset-managers/by-name/{qualifiedName}")
public GUIDResponse getExternalAssetManagerGUID​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String qualifiedName)
        Retrieve the unique identifier of the external asset manager from its qualified name. Typically the qualified name comes from the integration connector configuration.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        qualifiedName - unique name to use for the external asset
        Returns:
        unique identifier of the external asset manager's software server capability or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

      • addExternalIdentifier

        @PostMapping(path="/asset-managers/elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers/add")
public VoidResponse addExternalIdentifier​(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          String openMetadataElementGUID,
                                          @PathVariable
                                          String openMetadataElementTypeName,
                                          @RequestBody
                                          MetadataCorrelationProperties requestBody)
        Add the description of a specific external identifier.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
        openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
        requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
        Returns:
        void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

      • updateExternalIdentifier

        @PostMapping(path="/asset-managers/elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers/update")
public VoidResponse updateExternalIdentifier​(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String openMetadataElementGUID,
                                             @PathVariable
                                             String openMetadataElementTypeName,
                                             @RequestBody
                                             MetadataCorrelationProperties requestBody)
        Update the description of a specific external identifier.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
        openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
        requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
        Returns:
        void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

      • removeExternalIdentifier

        @PostMapping(path="/asset-managers/elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers/remove")
public VoidResponse removeExternalIdentifier​(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String openMetadataElementGUID,
                                             @PathVariable
                                             String openMetadataElementTypeName,
                                             @RequestBody
                                             MetadataCorrelationProperties requestBody)
        Remove an external identifier from an existing open metadata element. The open metadata element is not affected.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
        openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
        requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
        Returns:
        void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

      • confirmSynchronization

        @PostMapping(path="/asset-managers/elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers")
public VoidResponse confirmSynchronization​(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String openMetadataElementGUID,
                                           @PathVariable
                                           String openMetadataElementTypeName,
                                           @RequestBody
                                           MetadataCorrelationProperties requestBody)
        Confirm that the values of a particular metadata element have been synchronized. This is important from an audit point of view, and to allow bidirectional updates of metadata using optimistic locking.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        openMetadataElementGUID - unique identifier (GUID) of this element in open metadata
        openMetadataElementTypeName - type name for the open metadata element
        requestBody - details of the external identifier and its scope
        Returns:
        void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

      • getElementsForExternalIdentifier

        @PostMapping(path="/asset-managers/external-identifiers/open-metadata-elements")
public ElementHeadersResponse getElementsForExternalIdentifier​(@PathVariable
                                                               String serverName,
                                                               @PathVariable
                                                               String userId,
                                                               @RequestParam
                                                               int startFrom,
                                                               @RequestParam
                                                               int pageSize,
                                                               @RequestBody
                                                               MetadataCorrelationProperties requestBody)
        Retrieve the unique identifier of the external asset manager from its qualified name. Typically the qualified name comes from the integration connector configuration.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        startFrom - paging start point
        pageSize - maximum results that can be returned
        requestBody - details of the external identifier
        Returns:
        list of linked elements, null if null or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server