Package org.odpi.openmetadata.viewservices.datadesigner.server

Class DataDesignerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.datadesigner.server.DataDesignerRESTServices
public class DataDesignerRESTServices extends TokenController
The DataDesignerRESTServices provides the server-side implementation of the Data Designer Open Metadata View Service (OMVS). This interface provides access to data fields, data structures and data value specifications.

  • Constructor Details

    • DataDesignerRESTServices

      public DataDesignerRESTServices()
      Default constructor

  • Method Details

    • createDataStructure

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

    • createDataStructureFromTemplate

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

    • updateDataStructure

      public BooleanResponse updateDataStructure(String serverName, String dataStructureGUID, UpdateElementRequestBody requestBody)
      Update the properties of a data structure.
      Parameters:
      serverName - name of called server.
      dataStructureGUID - unique identifier of the data structure (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean 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.

    • linkMemberDataField

      public VoidResponse linkMemberDataField(String serverName, String dataStructureGUID, String dataFieldGUID, NewRelationshipRequestBody requestBody)
      Attach a data field to a data structure.
      Parameters:
      serverName - name of called server
      dataStructureGUID - unique identifier of the parent data structure.
      dataFieldGUID - unique identifier of the nested data field.
      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.

    • detachMemberDataField

      public VoidResponse detachMemberDataField(String serverName, String dataStructureGUID, String dataFieldGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data field from a data structure.
      Parameters:
      serverName - name of called server
      dataStructureGUID - unique identifier of the parent data structure.
      dataFieldGUID - unique identifier of the nested data field.
      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.

    • deleteDataStructure

      public VoidResponse deleteDataStructure(String serverName, String dataStructureGUID, DeleteElementRequestBody requestBody)
      Delete a data structure.
      Parameters:
      serverName - name of called server
      dataStructureGUID - 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.

    • getDataStructuresByName

      public OpenMetadataRootElementsResponse getDataStructuresByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of data structure 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)

    • getDataStructureByGUID

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

    • findDataStructures

      public OpenMetadataRootElementsResponse findDataStructures(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of data structure 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)

    • createDataField

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

    • createDataFieldFromTemplate

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

    • updateDataField

      public BooleanResponse updateDataField(String serverName, String dataFieldGUID, UpdateElementRequestBody requestBody)
      Update the properties of a data field.
      Parameters:
      serverName - name of called server.
      dataFieldGUID - unique identifier of the data field (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean 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.

    • linkNestedDataFields

      public VoidResponse linkNestedDataFields(String serverName, String parentDataFieldGUID, String nestedDataFieldGUID, NewRelationshipRequestBody requestBody)
      Connect two data field as parent and child.
      Parameters:
      serverName - name of called server
      parentDataFieldGUID - unique identifier of the parent data field
      nestedDataFieldGUID - unique identifier of the child data field
      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.

    • detachNestedDataFields

      public VoidResponse detachNestedDataFields(String serverName, String parentDataFieldGUID, String nestedDataFieldGUID, DeleteRelationshipRequestBody requestBody)
      Detach two data fields from one another.
      Parameters:
      serverName - name of called server
      parentDataFieldGUID - unique identifier of the first data field
      nestedDataFieldGUID - unique identifier of the second data field
      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.

    • deleteDataField

      public VoidResponse deleteDataField(String serverName, String dataFieldGUID, DeleteElementRequestBody requestBody)
      Delete a data field.
      Parameters:
      serverName - name of called server
      dataFieldGUID - 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.

    • getDataFieldsByName

      public OpenMetadataRootElementsResponse getDataFieldsByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of data field 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)

    • findDataFields

      public OpenMetadataRootElementsResponse findDataFields(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of data field 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)

    • getDataFieldByGUID

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

    • createDataValueSpecification

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

    • createDataValueSpecificationFromTemplate

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

    • updateDataValueSpecification

      public BooleanResponse updateDataValueSpecification(String serverName, String dataValueSpecificationGUID, UpdateElementRequestBody requestBody)
      Update the properties of a data value specification.
      Parameters:
      serverName - name of called server.
      dataValueSpecificationGUID - unique identifier of the data value specification (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean 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.

    • linkNestedDataClass

      public VoidResponse linkNestedDataClass(String serverName, String parentDataClassGUID, String childDataClassGUID, NewRelationshipRequestBody requestBody)
      Connect two data classes to show that one is used by the other when it is validating (typically a complex data item).
      Parameters:
      serverName - name of called server
      parentDataClassGUID - unique identifier of the first data class
      childDataClassGUID - unique identifier of the second data class
      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.

    • detachNestedDataClass

      public VoidResponse detachNestedDataClass(String serverName, String parentDataClassGUID, String childDataClassGUID, DeleteRelationshipRequestBody requestBody)
      Detach two nested data value specifications from one another.
      Parameters:
      serverName - name of called server
      parentDataClassGUID - unique identifier of the first data class
      childDataClassGUID - unique identifier of the second data class
      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.

    • linkSpecializedDataValueSpecification

      public VoidResponse linkSpecializedDataValueSpecification(String serverName, String parentDataValueSpecificationGUID, String childDataValueSpecificationGUID, NewRelationshipRequestBody requestBody)
      Connect two data value specifications to show that one provides a more specialist evaluation.
      Parameters:
      serverName - name of called server
      parentDataValueSpecificationGUID - unique identifier of the first data value specification
      childDataValueSpecificationGUID - unique identifier of the second data value specification
      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.

    • detachSpecializedDataValueSpecification

      public VoidResponse detachSpecializedDataValueSpecification(String serverName, String parentDataValueSpecificationGUID, String childDataValueSpecificationGUID, DeleteRelationshipRequestBody requestBody)
      Detach two data value specifications from one another.
      Parameters:
      serverName - name of called server
      parentDataValueSpecificationGUID - unique identifier of the first data value specification
      childDataValueSpecificationGUID - unique identifier of the second data value specification
      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.

    • assignDataValueSpecification

      public VoidResponse assignDataValueSpecification(String serverName, String elementGUID, String dataValueSpecificationGUID, NewRelationshipRequestBody requestBody)
      Connect an element to a data value specification that describes the data associated with this element.
      Parameters:
      serverName - name of called server
      elementGUID - unique identifier of the first data value specification
      dataValueSpecificationGUID - unique identifier of the second data value specification
      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.

    • detachDataValueSpecificationAssignment

      public VoidResponse detachDataValueSpecificationAssignment(String serverName, String elementGUID, String dataValueSpecificationGUID, DeleteRelationshipRequestBody requestBody)
      Detach an element from one of its assigned data value specifications.
      Parameters:
      serverName - name of called server
      elementGUID - unique identifier of the element
      dataValueSpecificationGUID - unique identifier of the data value specification
      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.

    • deleteDataValueSpecification

      public VoidResponse deleteDataValueSpecification(String serverName, String dataValueSpecificationGUID, DeleteElementRequestBody requestBody)
      Delete a data value specification.
      Parameters:
      serverName - name of called server
      dataValueSpecificationGUID - 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.

    • getDataValueSpecificationsByName

      public OpenMetadataRootElementsResponse getDataValueSpecificationsByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of data value specification 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)

    • findDataValueSpecifications

      public OpenMetadataRootElementsResponse findDataValueSpecifications(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of data value specification 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)

    • getDataValueSpecificationByGUID

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

    • linkDataValueSpecificationDefinition

      public VoidResponse linkDataValueSpecificationDefinition(String serverName, String dataDefinitionGUID, String dataValueSpecificationGUID, NewRelationshipRequestBody requestBody)
      Connect an element that is part of a data design to a data value specification to show that the data value specification should be used as the specification for the data values when interpreting the data definition.
      Parameters:
      serverName - name of called server
      dataDefinitionGUID - unique identifier of the data design element (eg data field) that uses the data value specification
      dataValueSpecificationGUID - unique identifier of the data value specification
      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.

    • detachDataValueSpecificationDefinition

      public VoidResponse detachDataValueSpecificationDefinition(String serverName, String dataDefinitionGUID, String dataValueSpecificationGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data definition from a data value specification.
      Parameters:
      serverName - name of called server
      dataDefinitionGUID - unique identifier of the data design element (eg data field) that uses the data value specification
      dataValueSpecificationGUID - unique identifier of the data value specification
      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.

    • linkSemanticDefinition

      public VoidResponse linkSemanticDefinition(String serverName, String dataDefinitionGUID, String glossaryTermGUID, NewRelationshipRequestBody requestBody)
      Connect an element that is part of a data design to a glossary term to show that the term should be used as the semantic definition for the data values when interpreting the data definition.
      Parameters:
      serverName - name of called server
      dataDefinitionGUID - unique identifier of the data design element (eg data field) that uses the data value specification
      glossaryTermGUID - unique identifier of the glossary term
      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.

    • detachSemanticDefinition

      public VoidResponse detachSemanticDefinition(String serverName, String dataDefinitionGUID, String glossaryTermGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data definition from a glossary term.
      Parameters:
      serverName - name of called server
      dataDefinitionGUID - unique identifier of the data design element (eg data field) that uses the data value specification
      glossaryTermGUID - unique identifier of the glossary term
      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.

    • linkCertificationTypeToDataStructure

      public VoidResponse linkCertificationTypeToDataStructure(String serverName, String certificationTypeGUID, String dataStructureGUID, NewRelationshipRequestBody requestBody)
      Connect a certification type to a data structure to guide the survey action service (that checks the data quality of a data resource as part of certifying it with the supplied certification type) to the definition of the data structure to use as a specification of how the data should be both structured and (if data value specifications are attached to the associated data fields using the DataValueSpecificationDefinition relationship) contain the valid values.
      Parameters:
      serverName - name of called server
      certificationTypeGUID - unique identifier of the certification type
      dataStructureGUID - unique identifier of the data structure
      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.

    • detachCertificationTypeToDataStructure

      public VoidResponse detachCertificationTypeToDataStructure(String serverName, String certificationTypeGUID, String dataStructureGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data structure from a certification type.
      Parameters:
      serverName - name of called server
      certificationTypeGUID - unique identifier of the certification type
      dataStructureGUID - unique identifier of the data structure
      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.