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 classes.

  • Constructor Details

    • DataDesignerRESTServices

      public DataDesignerRESTServices()
      Default constructor

  • Method Details

    • createDataStructure

      public GUIDResponse createDataStructure(String serverName, NewDataStructureRequestBody 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 there is 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 there is a problem reported in the open metadata server(s)

    • updateDataStructure

      public VoidResponse updateDataStructure(String serverName, String dataStructureGUID, boolean replaceAllProperties, UpdateDataStructureRequestBody requestBody)
      Update the properties of a data structure.
      Parameters:
      serverName - name of called server.
      dataStructureGUID - unique identifier of the data structure (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      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.

    • linkMemberDataField

      public VoidResponse linkMemberDataField(String serverName, String parentDataStructureGUID, String nestedDataFieldGUID, MemberDataFieldRequestBody requestBody)
      Attach a data field to a data structure.
      Parameters:
      serverName - name of called server
      parentDataStructureGUID - unique identifier of the parent data structure.
      nestedDataFieldGUID - 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 there is 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 parentDataStructureGUID, String nestedDataFieldGUID, MetadataSourceRequestBody requestBody)
      Detach a data field from a data structure.
      Parameters:
      serverName - name of called server
      parentDataStructureGUID - unique identifier of the parent data structure.
      nestedDataFieldGUID - 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 there is 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, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete a data structure.
      Parameters:
      serverName - name of called server
      dataStructureGUID - unique identifier of the element to delete
      cascadedDelete - can data structures be deleted if data fields are attached?
      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.

    • getDataStructuresByName

      public DataStructuresResponse getDataStructuresByName(String serverName, int startFrom, int pageSize, 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • findDataStructures

      public DataStructuresResponse findDataStructures(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, 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
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • getDataStructureByGUID

      public DataStructureResponse getDataStructureByGUID(String serverName, String dataStructureGUID, AnyTimeRequestBody 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 there is a problem reported in the open metadata server(s)

    • createDataField

      public GUIDResponse createDataField(String serverName, NewDataFieldRequestBody 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 there is 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 there is a problem reported in the open metadata server(s)

    • updateDataField

      public VoidResponse updateDataField(String serverName, String dataFieldGUID, boolean replaceAllProperties, UpdateDataFieldRequestBody requestBody)
      Update the properties of a data field.
      Parameters:
      serverName - name of called server.
      dataFieldGUID - unique identifier of the data field (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      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.

    • linkNestedDataFields

      public VoidResponse linkNestedDataFields(String serverName, String parentDataFieldGUID, String nestedDataFieldGUID, MemberDataFieldRequestBody 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 there is 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, MetadataSourceRequestBody 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 there is 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, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete a data field.
      Parameters:
      serverName - name of called server
      dataFieldGUID - unique identifier of the element to delete
      cascadedDelete - can data fields be deleted if other data fields are attached?
      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.

    • getDataFieldsByName

      public DataFieldsResponse getDataFieldsByName(String serverName, int startFrom, int pageSize, 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • findDataFields

      public DataFieldsResponse findDataFields(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, 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
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • getDataFieldByGUID

      public DataFieldResponse getDataFieldByGUID(String serverName, String dataFieldGUID, AnyTimeRequestBody 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 there is a problem reported in the open metadata server(s)

    • createDataClass

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

    • createDataClassFromTemplate

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

    • updateDataClass

      public VoidResponse updateDataClass(String serverName, String dataClassGUID, boolean replaceAllProperties, UpdateDataClassRequestBody requestBody)
      Update the properties of a data class.
      Parameters:
      serverName - name of called server.
      dataClassGUID - unique identifier of the data class (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      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.

    • linkNestedDataClass

      public VoidResponse linkNestedDataClass(String serverName, String parentDataClassGUID, String childDataClassGUID, MetadataSourceRequestBody 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 there is 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, MetadataSourceRequestBody requestBody)
      Detach two nested data classes 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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkSpecialistDataClass

      public VoidResponse linkSpecialistDataClass(String serverName, String parentDataClassGUID, String childDataClassGUID, MetadataSourceRequestBody requestBody)
      Connect two data classes to show that one provides a more specialist evaluation.
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachSpecialistDataClass

      public VoidResponse detachSpecialistDataClass(String serverName, String parentDataClassGUID, String childDataClassGUID, MetadataSourceRequestBody requestBody)
      Detach two data classes 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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteDataClass

      public VoidResponse deleteDataClass(String serverName, String dataClassGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete a data class.
      Parameters:
      serverName - name of called server
      dataClassGUID - unique identifier of the element to delete
      cascadedDelete - can data classes be deleted if linked data classes are attached?
      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.

    • getDataClassesByName

      public DataClassesResponse getDataClassesByName(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of data class metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • findDataClasses

      public DataClassesResponse findDataClasses(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of data class metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • getDataClassByGUID

      public DataClassResponse getDataClassByGUID(String serverName, String dataClassGUID, AnyTimeRequestBody requestBody)
      Retrieve the list of data class metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      dataClassGUID - 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)

    • linkDataClassDefinition

      public VoidResponse linkDataClassDefinition(String serverName, String dataDefinitionGUID, String dataClassGUID, MetadataSourceRequestBody requestBody)
      Connect an element that is part of a data design to a data class to show that the data class 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 class
      dataClassGUID - unique identifier of the data class
      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.

    • detachDataClassDefinition

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

    • linkSemanticDefinition

      public VoidResponse linkSemanticDefinition(String serverName, String dataDefinitionGUID, String glossaryTermGUID, MetadataSourceRequestBody 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 class
      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 there is 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, MetadataSourceRequestBody 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 class
      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 there is 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, MetadataSourceRequestBody 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 classes are attached to the associated data fields using the DataClassDefinition 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 there is 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, MetadataSourceRequestBody 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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.