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

Class ExternalIdentifierResource

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.server.spring.ExternalIdentifierResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/framework-services/{serviceURLMarker}/open-metadata-store/users/{userId}") public class ExternalIdentifierResource extends Object
Server-side REST API support for asset manager independent REST endpoints

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExternalIdentifierResource()
    Instantiates a new Asset Manager OMAS resource.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties requestBody)
    Add the description of a specific external identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    confirmSynchronization(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties requestBody)
    Confirm that the values of a particular metadata element have been synchronized.
    org.odpi.openmetadata.commonservices.ffdc.rest.ElementHeadersResponse
    getElementsForExternalIdentifier(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
    Retrieve the unique identifier of the external asset manager from its qualified name.
    org.odpi.openmetadata.frameworkservices.gaf.rest.MetadataCorrelationHeadersResponse
    getExternalIdentifiers(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.gaf.rest.EffectiveTimeQueryRequestBody requestBody)
    Assemble the correlation headers attached to the supplied element guid.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
    Remove an external identifier from an existing open metadata element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties requestBody)
    Update the description of a specific external identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse
    validateExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties requestBody)
    That the external identifier matches the open metadata GUID.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ExternalIdentifierResource

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

  • Method Details

    • addExternalIdentifier

      @PostMapping(path="/metadata-elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers/add") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addExternalIdentifier(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String openMetadataElementGUID, @PathVariable String openMetadataElementTypeName, @RequestBody org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties requestBody)
      Add the description of a specific external identifier.
      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 - 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="/metadata-elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers/update") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateExternalIdentifier(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String openMetadataElementGUID, @PathVariable String openMetadataElementTypeName, @RequestBody org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties requestBody)
      Update the description of a specific external identifier.
      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 - 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

    • validateExternalIdentifier

      @PostMapping(path="/metadata-elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers/validate") public org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse validateExternalIdentifier(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String openMetadataElementGUID, @PathVariable String openMetadataElementTypeName, @RequestBody org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties requestBody)
      That the external identifier matches the open metadata GUID.
      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 - 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="/metadata-elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeExternalIdentifier(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String openMetadataElementGUID, @PathVariable String openMetadataElementTypeName, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateMetadataCorrelatorsRequestBody 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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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="/metadata-elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/synchronized") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse confirmSynchronization(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String openMetadataElementGUID, @PathVariable String openMetadataElementTypeName, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.frameworks.governanceaction.properties.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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      openMetadataElementGUID - unique identifier (GUID) of this element in open metadata
      openMetadataElementTypeName - type name for the open metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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="/external-identifiers/open-metadata-elements") public org.odpi.openmetadata.commonservices.ffdc.rest.ElementHeadersResponse getElementsForExternalIdentifier(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateMetadataCorrelatorsRequestBody 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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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

    • getExternalIdentifiers

      @PostMapping(path="/metadata-elements/{openMetadataElementTypeName}/{openMetadataElementGUID}/external-identifiers") public org.odpi.openmetadata.frameworkservices.gaf.rest.MetadataCorrelationHeadersResponse getExternalIdentifiers(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String openMetadataElementGUID, @PathVariable String openMetadataElementTypeName, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.frameworkservices.gaf.rest.EffectiveTimeQueryRequestBody requestBody)
      Assemble the correlation headers attached to the supplied element guid.
      Parameters:
      serverName - name of the server to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      openMetadataElementGUID - unique identifier of the requested metadata element
      openMetadataElementTypeName - type name for the open metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - correlation properties
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)