Package org.odpi.openmetadata.viewservices.referencedata.server

Class ReferenceDataRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.referencedata.server.ReferenceDataRESTServices
public class ReferenceDataRESTServices extends TokenController
The ReferenceDataRESTServices provides the server-side implementation of the Reference Data Open Metadata View Service (OMVS).

  • Constructor Details

    • ReferenceDataRESTServices

      public ReferenceDataRESTServices()
      Default constructor

  • Method Details

    • createValidValueDefinition

      public GUIDResponse createValidValueDefinition(String serverName, NewElementRequestBody requestBody)
      Create a validValueDefinition.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the validValueDefinition.
      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.

    • createValidValueDefinitionFromTemplate

      public GUIDResponse createValidValueDefinitionFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a validValueDefinition 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
      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)

    • updateValidValueDefinition

      public VoidResponse updateValidValueDefinition(String serverName, String validValueDefinitionGUID, UpdateElementRequestBody requestBody)
      Update the properties of a validValueDefinition.
      Parameters:
      serverName - name of called server.
      validValueDefinitionGUID - unique identifier of the validValueDefinition (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.

    • linkValidValueImplementation

      public VoidResponse linkValidValueImplementation(String serverName, String validValueDefinitionGUID, String elementGUID, NewRelationshipRequestBody requestBody)
      Attach a valid value to an implementation - probably a referenceable.
      Parameters:
      serverName - name of called server
      validValueDefinitionGUID - unique identifier of the validValueDefinition
      elementGUID - unique identifier of the asset
      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.

    • detachValidValueImplementation

      public VoidResponse detachValidValueImplementation(String serverName, String validValueDefinitionGUID, String elementGUID, DeleteRequestBody requestBody)
      Detach a valid value from an implementation - probably a referenceable.
      Parameters:
      serverName - name of called server
      validValueDefinitionGUID - unique identifier of the validValueDefinition
      elementGUID - unique identifier of the element
      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.

    • linkValidValuesAssignment

      public VoidResponse linkValidValuesAssignment(String serverName, String elementGUID, String validValueDefinitionGUID, NewRelationshipRequestBody requestBody)
      Attach a valid value to a consumer - probably a schema element or data set.
      Parameters:
      serverName - name of called server
      elementGUID - unique identifier of the asset
      validValueDefinitionGUID - unique identifier of the validValueDefinition
      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.

    • detachValidValuesAssignment

      public VoidResponse detachValidValuesAssignment(String serverName, String elementGUID, String validValueDefinitionGUID, DeleteRequestBody requestBody)
      Detach a valid value from a consumer - probably a schema element or data set.
      Parameters:
      serverName - name of called server
      elementGUID - unique identifier of the element
      validValueDefinitionGUID - unique identifier of the validValueDefinition
      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.

    • linkReferenceValueAssignment

      public VoidResponse linkReferenceValueAssignment(String serverName, String elementGUID, String validValueDefinitionGUID, NewRelationshipRequestBody requestBody)
      Attach a valid value to a consumer - probably a schema element or data set.
      Parameters:
      serverName - name of called server
      elementGUID - unique identifier of the asset
      validValueDefinitionGUID - unique identifier of the validValueDefinition
      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.

    • detachReferenceValueAssignment

      public VoidResponse detachReferenceValueAssignment(String serverName, String elementGUID, String validValueDefinitionGUID, DeleteRequestBody requestBody)
      Detach a valid value from a consumer - probably a schema element or data set.
      Parameters:
      serverName - name of called server
      elementGUID - unique identifier of the element
      validValueDefinitionGUID - unique identifier of the validValueDefinition
      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.

    • linkAssociatedValidValues

      public VoidResponse linkAssociatedValidValues(String serverName, String validValueDefinitionOneGUID, String validValueDefinitionTwoGUID, NewRelationshipRequestBody requestBody)
      Attach a valid value to one of its peers.
      Parameters:
      serverName - name of called server
      validValueDefinitionOneGUID - unique identifier of the first validValueDefinition
      validValueDefinitionTwoGUID - unique identifier of the second validValueDefinition
      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.

    • detachAssociatedValidValues

      public VoidResponse detachAssociatedValidValues(String serverName, String validValueDefinitionOneGUID, String validValueDefinitionTwoGUID, DeleteRequestBody requestBody)
      Detach a valid value from one of its peers.
      Parameters:
      serverName - name of called server
      validValueDefinitionOneGUID - unique identifier of the first validValueDefinition
      validValueDefinitionTwoGUID - unique identifier of the second validValueDefinition
      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.

    • linkConsistentValidValues

      public VoidResponse linkConsistentValidValues(String serverName, String validValueDefinitionOneGUID, String validValueDefinitionTwoGUID, NewRelationshipRequestBody requestBody)
      Attach a valid value to one of its peers.
      Parameters:
      serverName - name of called server
      validValueDefinitionOneGUID - unique identifier of the first validValueDefinition
      validValueDefinitionTwoGUID - unique identifier of the second validValueDefinition
      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.

    • detachConsistentValidValues

      public VoidResponse detachConsistentValidValues(String serverName, String validValueDefinitionOneGUID, String validValueDefinitionTwoGUID, DeleteRequestBody requestBody)
      Detach a valid value from one of its peers.
      Parameters:
      serverName - name of called server
      validValueDefinitionOneGUID - unique identifier of the first validValueDefinition
      validValueDefinitionTwoGUID - unique identifier of the second validValueDefinition
      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.

    • linkMappedValidValues

      public VoidResponse linkMappedValidValues(String serverName, String validValueDefinitionOneGUID, String validValueDefinitionTwoGUID, NewRelationshipRequestBody requestBody)
      Attach a valid value to one of its peers.
      Parameters:
      serverName - name of called server
      validValueDefinitionOneGUID - unique identifier of the first validValueDefinition
      validValueDefinitionTwoGUID - unique identifier of the second validValueDefinition
      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.

    • detachMappedValidValues

      public VoidResponse detachMappedValidValues(String serverName, String validValueDefinitionOneGUID, String validValueDefinitionTwoGUID, DeleteRequestBody requestBody)
      Detach a valid value from one of its peers.
      Parameters:
      serverName - name of called server
      validValueDefinitionOneGUID - unique identifier of the first validValueDefinition
      validValueDefinitionTwoGUID - unique identifier of the second validValueDefinition
      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.

    • linkValidValueMember

      public VoidResponse linkValidValueMember(String serverName, String validValueDefinitionGUID, String nestedValidValueDefinitionGUID, NewRelationshipRequestBody requestBody)
      Attach a valid value to a valid value set.
      Parameters:
      serverName - name of called server
      validValueDefinitionGUID - unique identifier of the super validValueDefinition
      nestedValidValueDefinitionGUID - unique identifier of the nested validValueDefinition
      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.

    • detachValidValueMember

      public VoidResponse detachValidValueMember(String serverName, String validValueDefinitionGUID, String nestedValidValueDefinitionGUID, DeleteRequestBody requestBody)
      Detach a valid value from a valid value set.
      Parameters:
      serverName - name of called server
      validValueDefinitionGUID - unique identifier of the super validValueDefinition
      nestedValidValueDefinitionGUID - unique identifier of the nested validValueDefinition
      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.

    • deleteValidValueDefinition

      public VoidResponse deleteValidValueDefinition(String serverName, String validValueDefinitionGUID, DeleteRequestBody requestBody)
      Delete a validValueDefinition.
      Parameters:
      serverName - name of called server
      validValueDefinitionGUID - 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.

    • getValidValueDefinitionsByName

      public OpenMetadataRootElementsResponse getValidValueDefinitionsByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of validValueDefinition metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      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)

    • getValidValueDefinitionByGUID

      public OpenMetadataRootElementResponse getValidValueDefinitionByGUID(String serverName, String validValueDefinitionGUID, GetRequestBody requestBody)
      Retrieve the list of validValueDefinition metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      validValueDefinitionGUID - 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)

    • findValidValueDefinitions

      public OpenMetadataRootElementsResponse findValidValueDefinitions(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of validValueDefinition metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      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)