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

Class ReferenceDataResource

java.lang.Object
org.odpi.openmetadata.viewservices.referencedata.server.spring.ReferenceDataResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/reference-data") public class ReferenceDataResource extends Object
The ReferenceDataResource provides part of the server-side implementation of the Reference Data OMVS. =

  • Constructor Details

    • ReferenceDataResource

      public ReferenceDataResource()
      Default constructor

  • Method Details

    • createValidValueDefinition

      @PostMapping(path="/valid-value-definitions") public GUIDResponse createValidValueDefinition(@PathVariable String serverName, @RequestBody(required=false) 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createValidValueDefinitionFromTemplate

      @PostMapping(path="/valid-value-definitions/from-template") public GUIDResponse createValidValueDefinitionFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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 a problem reported in the open metadata server(s)

    • updateValidValueDefinition

      @PostMapping(path="/valid-value-definitions/{validValueDefinitionGUID}/update") public BooleanResponse updateValidValueDefinition(@PathVariable String serverName, @PathVariable String validValueDefinitionGUID, @RequestBody(required=false) 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkValidValueImplementation

      @PostMapping(path="/valid-values/{validValueDefinitionGUID}/implementation/elements/{elementGUID}/attach") public GUIDResponse linkValidValueImplementation(@PathVariable String serverName, @PathVariable String validValueDefinitionGUID, @PathVariable String elementGUID, @RequestBody(required=false) 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 element
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • updateValidValueImplementation

      @PostMapping(path="/valid-value-implementations/{validValuesImplementationRelationshipGUID}/update") public VoidResponse updateValidValueImplementation(@PathVariable String serverName, @PathVariable String validValuesImplementationRelationshipGUID, @RequestBody(required=false) UpdateRelationshipRequestBody requestBody)
      Update the properties of a valid values implementation relationship.
      Parameters:
      serverName - name of the server to route the request to
      validValuesImplementationRelationshipGUID - unique identifier of the relationship
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachValidValueImplementation

      @PostMapping(path="/valid-value-implementations/{validValuesImplementationRelationshipGUID}/detach") public VoidResponse detachValidValueImplementation(@PathVariable String serverName, @PathVariable String validValuesImplementationRelationshipGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Remove a valid values implementation relationship.
      Parameters:
      serverName - name of the server to route the request to
      validValuesImplementationRelationshipGUID - unique identifier of the relationship
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkValidValuesAssignment

      @PostMapping(path="/elements/{elementGUID}/valid-values-assignment/{validValueDefinitionGUID}/attach") public VoidResponse linkValidValuesAssignment(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String validValueDefinitionGUID, @RequestBody(required=false) 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 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachValidValuesAssignment

      @PostMapping(path="/elements/{elementGUID}/valid-values-assignment/{validValueDefinitionGUID}/detach") public VoidResponse detachValidValuesAssignment(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String validValueDefinitionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkReferenceValueAssignment

      @PostMapping(path="/elements/{elementGUID}/reference-value-assignment/{validValueDefinitionGUID}/attach") public VoidResponse linkReferenceValueAssignment(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String validValueDefinitionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a valid value to a tagged element.
      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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachReferenceValueAssignment

      @PostMapping(path="/elements/{elementGUID}/reference-value-assignment/{validValueDefinitionGUID}/detach") public VoidResponse detachReferenceValueAssignment(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String validValueDefinitionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a valid value from a tagged element
      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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkAssociatedValidValues

      @PostMapping(path="/valid-values/{validValueDefinitionOneGUID}/associated-valid-values/{validValueDefinitionTwoGUID}/attach") public VoidResponse linkAssociatedValidValues(@PathVariable String serverName, @PathVariable String validValueDefinitionOneGUID, @PathVariable String validValueDefinitionTwoGUID, @RequestBody(required=false) 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachAssociatedValidValues

      @PostMapping(path="/valid-values/{validValueDefinitionOneGUID}/associated-valid-values/{validValueDefinitionTwoGUID}/detach") public VoidResponse detachAssociatedValidValues(@PathVariable String serverName, @PathVariable String validValueDefinitionOneGUID, @PathVariable String validValueDefinitionTwoGUID, @RequestBody(required=false) DeleteRelationshipRequestBody 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkConsistentValidValues

      @PostMapping(path="/valid-values/{validValueDefinitionOneGUID}/consistent-valid-values/{validValueDefinitionTwoGUID}/attach") public VoidResponse linkConsistentValidValues(@PathVariable String serverName, @PathVariable String validValueDefinitionOneGUID, @PathVariable String validValueDefinitionTwoGUID, @RequestBody(required=false) 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachConsistentValidValues

      @PostMapping(path="/valid-values/{validValueDefinitionOneGUID}/consistent-valid-values/{validValueDefinitionTwoGUID}/detach") public VoidResponse detachConsistentValidValues(@PathVariable String serverName, @PathVariable String validValueDefinitionOneGUID, @PathVariable String validValueDefinitionTwoGUID, @RequestBody(required=false) DeleteRelationshipRequestBody 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkMappedValidValues

      @PostMapping(path="/valid-values/{validValueDefinitionOneGUID}/mapped-valid-values/{validValueDefinitionTwoGUID}/attach") public VoidResponse linkMappedValidValues(@PathVariable String serverName, @PathVariable String validValueDefinitionOneGUID, @PathVariable String validValueDefinitionTwoGUID, @RequestBody(required=false) 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachMappedValidValues

      @PostMapping(path="/valid-values/{validValueDefinitionOneGUID}/mapped-valid-values/{validValueDefinitionTwoGUID}/detach") public VoidResponse detachMappedValidValues(@PathVariable String serverName, @PathVariable String validValueDefinitionOneGUID, @PathVariable String validValueDefinitionTwoGUID, @RequestBody(required=false) DeleteRelationshipRequestBody 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkValidValueMember

      @PostMapping(path="/valid-values/{validValueDefinitionGUID}/members/{nestedValidValueDefinitionGUID}/attach") public VoidResponse linkValidValueMember(@PathVariable String serverName, @PathVariable String validValueDefinitionGUID, @PathVariable String nestedValidValueDefinitionGUID, @RequestBody(required=false) 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachValidValueMember

      @PostMapping(path="/valid-values/{validValueDefinitionGUID}/members/{nestedValidValueDefinitionGUID}/detach") public VoidResponse detachValidValueMember(@PathVariable String serverName, @PathVariable String validValueDefinitionGUID, @PathVariable String nestedValidValueDefinitionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteValidValueDefinition

      @PostMapping(path="/valid-value-definitions/{validValueDefinitionGUID}/delete") public VoidResponse deleteValidValueDefinition(@PathVariable String serverName, @PathVariable String validValueDefinitionGUID, @RequestBody(required=false) DeleteElementRequestBody 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getValidValueDefinitionsByName

      @PostMapping(path="/valid-value-definitions/by-name") public OpenMetadataRootElementsResponse getValidValueDefinitionsByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of validValueDefinitions with a particular name.
      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 a problem reported in the open metadata server(s)

    • findValidValueDefinitions

      @PostMapping(path="/valid-value-definitions/by-search-string") public OpenMetadataRootElementsResponse findValidValueDefinitions(@PathVariable String serverName, @RequestBody(required=false) 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 a problem reported in the open metadata server(s)

    • getValidValueDefinitionByGUID

      @PostMapping(path="/valid-value-definitions/{validValueDefinitionGUID}/retrieve") public OpenMetadataRootElementResponse getValidValueDefinitionByGUID(@PathVariable String serverName, @PathVariable String validValueDefinitionGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific validValueDefinition.
      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 a problem reported in the open metadata server(s)

    • detachValidValueImplementation

      @PostMapping(path="/valid-values/{validValueDefinitionGUID}/implementation/elements/{elementGUID}/detach") public VoidResponse detachValidValueImplementation(@PathVariable String serverName, @PathVariable String validValueDefinitionGUID, @PathVariable String elementGUID, @RequestBody(required=false) DeleteRelationshipRequestBody 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request. This is a multi-link relationship, so this request removes every valid values implementation relationship between the two elements. Use the request that takes the relationship's own unique identifier to remove just one of them.