Package org.odpi.openmetadata.viewservices.externallinks.server

Class ExternalLinksRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.externallinks.server.ExternalLinksRESTServices
public class ExternalLinksRESTServices extends TokenController
The ExternalLinksRESTServices provides the server-side implementation of the External Links Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • ExternalLinksRESTServices

      public ExternalLinksRESTServices()
      Default constructor

  • Method Details

    • createExternalReference

      public GUIDResponse createExternalReference(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create an external reference.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the external reference.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createExternalReferenceFromTemplate

      public GUIDResponse createExternalReferenceFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent an external reference using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element 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)

    • updateExternalReference

      public VoidResponse updateExternalReference(String serverName, String urlMarker, String externalReferenceGUID, UpdateElementRequestBody requestBody)
      Update the properties of an external reference.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      externalReferenceGUID - unique identifier of the external reference (returned from create)
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkExternalReference

      public VoidResponse linkExternalReference(String serverName, String urlMarker, String elementGUID, String externalReferenceGUID, NewRelationshipRequestBody requestBody)
      Attach an external reference to an element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the external reference
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachExternalReference

      public VoidResponse detachExternalReference(String serverName, String urlMarker, String elementGUID, String externalReferenceGUID, DeleteRelationshipRequestBody requestBody)
      Detach an external reference from an element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the external reference
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkMediaReference

      public VoidResponse linkMediaReference(String serverName, String urlMarker, String elementGUID, String externalReferenceGUID, NewRelationshipRequestBody requestBody)
      Attach an external media reference to an element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the external reference
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachMediaReference

      public VoidResponse detachMediaReference(String serverName, String urlMarker, String elementGUID, String externalReferenceGUID, DeleteRelationshipRequestBody requestBody)
      Detach an external media reference from an element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the external reference
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkCitedDocumentReference

      public VoidResponse linkCitedDocumentReference(String serverName, String urlMarker, String elementGUID, String externalReferenceGUID, NewRelationshipRequestBody requestBody)
      Attach an element to its external document reference.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the external reference
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachCitedDocumentReference

      public VoidResponse detachCitedDocumentReference(String serverName, String urlMarker, String elementGUID, String externalReferenceGUID, DeleteRelationshipRequestBody requestBody)
      Detach an element from its external document reference.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the external reference
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteExternalReference

      public VoidResponse deleteExternalReference(String serverName, String urlMarker, String externalReferenceGUID, DeleteElementRequestBody requestBody)
      Delete an external reference.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      externalReferenceGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getExternalReferencesByName

      public OpenMetadataRootElementsResponse getExternalReferencesByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of external reference metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getExternalReferenceByGUID

      public OpenMetadataRootElementResponse getExternalReferenceByGUID(String serverName, String urlMarker, String externalReferenceGUID, GetRequestBody requestBody)
      Retrieve the list of external reference metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      externalReferenceGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findExternalReferences

      public OpenMetadataRootElementsResponse findExternalReferences(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of external reference metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • addExternalIdentifier

      public VoidResponse addExternalIdentifier(String serverName, String urlMarker, String elementGUID, NewExternalIdRequestBody requestBody)
      Add the description of a specific external identifier.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      elementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      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

      public VoidResponse updateExternalIdentifier(String serverName, String urlMarker, String externalIdGUID, UpdateElementRequestBody requestBody)
      Update the description of a specific external identifier.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      externalIdGUID - unique identifier (GUID) of the externalId in the open metadata ecosystem
      requestBody - unique identifier of this element in the external system 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

    • deleteExternalIdentifier

      public VoidResponse deleteExternalIdentifier(String serverName, String urlMarker, String externalIdGUID, DeleteElementRequestBody 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.
      urlMarker - view service URL marker
      externalIdGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      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

      public VoidResponse confirmSynchronization(String serverName, String urlMarker, String externalIdLinkGUID, UpdateRelationshipRequestBody 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.
      urlMarker - view service URL marker
      externalIdLinkGUID - unique identifier (GUID) of this element in open metadata
      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

    • getExternalIdsByName

      public OpenMetadataRootElementsResponse getExternalIdsByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of external id metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getExternalIdByGUID

      public OpenMetadataRootElementResponse getExternalIdByGUID(String serverName, String urlMarker, String externalIdGUID, GetRequestBody requestBody)
      Retrieve the list of external id metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      externalIdGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findExternalIds

      public OpenMetadataRootElementsResponse findExternalIds(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of external id metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)