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

Class ExternalReferenceExchangeResource

  • @RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-manager/users/{userId}")
public class ExternalReferenceExchangeResource
extends Object
    GlossaryExchangeResource is the server-side implementation of the Asset Manager OMAS's support for glossaries. It matches the GlossaryExchangeClient.

    • Constructor Detail

      • ExternalReferenceExchangeResource

        public ExternalReferenceExchangeResource()
        Default constructor

    • Method Detail

      • createExternalReference

        @PostMapping(path="/external-references")
public GUIDResponse createExternalReference​(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @RequestParam
                                            boolean assetManagerIsHome,
                                            @RequestBody
                                            ExternalReferenceRequestBody requestBody)
        Create a definition of a external reference.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        assetManagerIsHome - ensure that only the asset manager can update this asset
        requestBody - properties for a external reference
        Returns:
        unique identifier of the external reference or InvalidParameterException qualifiedName or userId is null; qualifiedName is not unique PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • updateExternalReference

        @PostMapping(path="/external-references/{externalReferenceGUID}")
public VoidResponse updateExternalReference​(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String externalReferenceGUID,
                                            @RequestParam
                                            boolean isMergeUpdate,
                                            @RequestBody
                                            ExternalReferenceRequestBody requestBody)
        Update the definition of a external reference.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        externalReferenceGUID - unique identifier of external reference
        isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
        requestBody - properties to change
        Returns:
        void or InvalidParameterException guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • deleteExternalReference

        @PostMapping(path="/external-references/{externalReferenceGUID}/remove")
public VoidResponse deleteExternalReference​(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String externalReferenceGUID,
                                            @RequestBody
                                            MetadataCorrelationProperties requestBody)
        Remove the definition of a external reference.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        externalReferenceGUID - unique identifier of external reference
        requestBody - unique identifiers of the external reference in the external asset manager
        Returns:
        void or InvalidParameterException guid or userId is null; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • linkExternalReferenceToElement

        @PostMapping(path="/external-references/{externalReferenceGUID}/links/{attachedToGUID}")
public GUIDResponse linkExternalReferenceToElement​(@PathVariable
                                                   String serverName,
                                                   @PathVariable
                                                   String userId,
                                                   @PathVariable
                                                   String attachedToGUID,
                                                   @PathVariable
                                                   String externalReferenceGUID,
                                                   @RequestParam
                                                   boolean assetManagerIsHome,
                                                   @RequestBody
                                                   ExternalReferenceLinkRequestBody requestBody)
        Link an external reference to an object.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        assetManagerIsHome - ensure that only the asset manager can update this asset
        attachedToGUID - object linked to external references.
        requestBody - description for the reference from the perspective of the object that the reference is being attached to.
        externalReferenceGUID - unique identifier (guid) of the external reference details.
        Returns:
        Unique identifier for new relationship or InvalidParameterException problem with the GUID or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • updateExternalReferenceToElementLink

        @PostMapping(path="/external-references/links/{externalReferenceLinkGUID}/update")
public VoidResponse updateExternalReferenceToElementLink​(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @PathVariable
                                                         String externalReferenceLinkGUID,
                                                         @RequestBody
                                                         ExternalReferenceLinkRequestBody requestBody)
        Update the link between an external reference to an object.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        externalReferenceLinkGUID - unique identifier (guid) of the external reference details.
        requestBody - description for the reference from the perspective of the object that the reference is being attached to.
        Returns:
        void or InvalidParameterException problem with the GUID or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • unlinkExternalReferenceFromElement

        @PostMapping(path="/external-references/links/{externalReferenceLinkGUID}/remove")
public VoidResponse unlinkExternalReferenceFromElement​(@PathVariable
                                                       String serverName,
                                                       @PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String externalReferenceLinkGUID,
                                                       @RequestBody
                                                       AssetManagerIdentifiersRequestBody requestBody)
        Remove the link between a external reference and an element. If the element is its anchor, the external reference is removed.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        externalReferenceLinkGUID - identifier of the external reference relationship.
        requestBody - unique identifier of software server capability representing the caller
        Returns:
        void or InvalidParameterException problem with the GUID or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • getExternalReferences

        @PostMapping(path="/external-references/by-type")
public ExternalReferenceElementsResponse getExternalReferences​(@PathVariable
                                                               String serverName,
                                                               @PathVariable
                                                               String userId,
                                                               @RequestParam
                                                               int startFrom,
                                                               @RequestParam
                                                               int pageSize,
                                                               @RequestBody
                                                               EffectiveTimeQueryRequestBody requestBody)
        Retrieve the list of external references sorted in open metadata.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        requestBody - the time that the retrieved elements must be effective for
        Returns:
        links to addition information or InvalidParameterException guid invalid or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • getExternalReferencesById

        @PostMapping(path="/external-references/by-resource-id")
public ExternalReferenceElementsResponse getExternalReferencesById​(@PathVariable
                                                                   String serverName,
                                                                   @PathVariable
                                                                   String userId,
                                                                   @RequestParam
                                                                   int startFrom,
                                                                   @RequestParam
                                                                   int pageSize,
                                                                   @RequestBody
                                                                   NameRequestBody requestBody)
        Retrieve the list of external references for this requestBody.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        requestBody - unique reference id assigned by the resource owner (supports wildcards). This is the qualified name of the entity
        Returns:
        links to addition information or InvalidParameterException guid invalid or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • getExternalReferencesByURL

        @PostMapping(path="/external-references/by-url")
public ExternalReferenceElementsResponse getExternalReferencesByURL​(@PathVariable
                                                                    String serverName,
                                                                    @PathVariable
                                                                    String userId,
                                                                    @RequestParam
                                                                    int startFrom,
                                                                    @RequestParam
                                                                    int pageSize,
                                                                    @RequestBody
                                                                    NameRequestBody requestBody)
        Retrieve the list of external references for this URL.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        requestBody - URL of the external resource.
        Returns:
        links to addition information or InvalidParameterException guid invalid or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • getExternalReferencesByName

        @PostMapping(path="/external-references/by-name")
public ExternalReferenceElementsResponse getExternalReferencesByName​(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @RequestParam
                                                                     int startFrom,
                                                                     @RequestParam
                                                                     int pageSize,
                                                                     @RequestBody
                                                                     NameRequestBody requestBody)
        Retrieve the list of external references for this name.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        requestBody - name of the external resource.
        Returns:
        links to addition information or InvalidParameterException guid invalid or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • getExternalReferencesForAssetManager

        @PostMapping(path="/external-references/by-asset-manager")
public ExternalReferenceElementsResponse getExternalReferencesForAssetManager​(@PathVariable
                                                                              String serverName,
                                                                              @PathVariable
                                                                              String userId,
                                                                              @RequestParam
                                                                              int startFrom,
                                                                              @RequestParam
                                                                              int pageSize,
                                                                              @RequestBody
                                                                              EffectiveTimeQueryRequestBody requestBody)
        Retrieve the list of external reference created on behalf of the named asset manager.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        startFrom - paging start point
        pageSize - maximum results that can be returned
        requestBody - the time that the retrieved elements must be effective 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)

      • findExternalReferences

        @PostMapping(path="/external-references/by-search-string")
public ExternalReferenceElementsResponse findExternalReferences​(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @RequestParam
                                                                int startFrom,
                                                                @RequestParam
                                                                int pageSize,
                                                                @RequestBody
                                                                SearchStringRequestBody requestBody)
        Find the external references that contain the search string - which may contain wildcards.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        requestBody - regular expression (RegEx) to search for
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        links to addition information or InvalidParameterException guid invalid or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • retrieveAttachedExternalReferences

        @PostMapping(path="/external-references/attached-to/{attachedToGUID}")
public ExternalReferenceLinkElementsResponse retrieveAttachedExternalReferences​(@PathVariable
                                                                                String serverName,
                                                                                @PathVariable
                                                                                String userId,
                                                                                @PathVariable
                                                                                String attachedToGUID,
                                                                                @RequestParam
                                                                                int startFrom,
                                                                                @RequestParam
                                                                                int pageSize,
                                                                                @RequestBody
                                                                                EffectiveTimeQueryRequestBody requestBody)
        Retrieve the list of external references attached to the supplied object.
        Parameters:
        serverName - name of the server to route the request to
        userId - the name of the calling user.
        attachedToGUID - object linked to external reference.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        requestBody - the time that the retrieved elements must be effective for
        Returns:
        links to addition information or InvalidParameterException guid invalid or the external references are not correctly specified, or are null. PropertyServerException the server is not available. UserNotAuthorizedException the calling user is not authorized to issue the call.

      • getExternalReferenceByGUID

        @PostMapping(path="/external-references/{externalReferenceGUID}/by-guid")
public ExternalReferenceElementResponse getExternalReferenceByGUID​(@PathVariable
                                                                   String serverName,
                                                                   @PathVariable
                                                                   String userId,
                                                                   @PathVariable
                                                                   String externalReferenceGUID,
                                                                   @RequestBody
                                                                   EffectiveTimeQueryRequestBody requestBody)
        Return information about a specific external reference.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        externalReferenceGUID - unique identifier for the external reference
        requestBody - the time that the retrieved elements must be effective for
        Returns:
        properties of the external reference or InvalidParameterException externalReferenceGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem