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

Class DataDesignerResource

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

  • Constructor Details

    • DataDesignerResource

      public DataDesignerResource()
      Default constructor

  • Method Details

    • createDataStructure

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

    • createDataStructureFromTemplate

      @PostMapping(path="/data-structures/from-template") public GUIDResponse createDataStructureFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/data-structures/{dataStructureGUID}/update") public VoidResponse updateDataStructure(@PathVariable String serverName, @PathVariable String dataStructureGUID, @RequestBody(required=false) 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:
      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

      @PostMapping(path="/data-structures/{dataStructureGUID}/member-data-fields/{dataFieldGUID}/attach") public VoidResponse linkMemberDataField(@PathVariable String serverName, @PathVariable String dataStructureGUID, @PathVariable String dataFieldGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a data field to a data structure.
      Parameters:
      serverName - name of called server
      dataStructureGUID - unique identifier of the first data structure
      dataFieldGUID - unique identifier of the second 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.

    • detachMemberDataField

      @PostMapping(path="/data-structures/{parentDataStructureGUID}/member-data-fields/{memberDataFieldGUID}/detach") public VoidResponse detachMemberDataField(@PathVariable String serverName, @PathVariable String parentDataStructureGUID, @PathVariable String memberDataFieldGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach a data field from a data structure.
      Parameters:
      serverName - name of called server
      parentDataStructureGUID - unique identifier of the first data structure
      memberDataFieldGUID - unique identifier of the second 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.

    • deleteDataStructure

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

    • getDataStructuresByName

      @PostMapping(path="/data-structures/by-name") public OpenMetadataRootElementsResponse getDataStructuresByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of data structures 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 there is a problem reported in the open metadata server(s)

    • findDataStructures

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

    • getDataStructureByGUID

      @PostMapping(path="/data-structures/{dataStructureGUID}/retrieve") public OpenMetadataRootElementResponse getDataStructureByGUID(@PathVariable String serverName, @PathVariable String dataStructureGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific data structure.
      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

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

    • createDataFieldFromTemplate

      @PostMapping(path="/data-fields/from-template") public GUIDResponse createDataFieldFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/data-fields/{dataFieldGUID}/update") public VoidResponse updateDataField(@PathVariable String serverName, @PathVariable String dataFieldGUID, @RequestBody(required=false) 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:
      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

      @PostMapping(path="/data-fields/{parentDataFieldGUID}/nested-data-fields/{nestedDataFieldGUID}/attach") public VoidResponse linkNestedDataFields(@PathVariable String serverName, @PathVariable String parentDataFieldGUID, @PathVariable String nestedDataFieldGUID, @RequestBody(required=false) 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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachNestedDataFields

      @PostMapping(path="/data-fields/{parentDataFieldGUID}/nested-data-fields/{nestedDataFieldGUID}/detach") public VoidResponse detachNestedDataFields(@PathVariable String serverName, @PathVariable String parentDataFieldGUID, @PathVariable String nestedDataFieldGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach two data fields from one another.
      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.

    • deleteDataField

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

    • getDataFieldsByName

      @PostMapping(path="/data-fields/by-name") public OpenMetadataRootElementsResponse getDataFieldsByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of data fields 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 there is a problem reported in the open metadata server(s)

    • findDataFields

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

    • getDataFieldByGUID

      @PostMapping(path="/data-fields/{dataFieldGUID}/retrieve") public OpenMetadataRootElementResponse getDataFieldByGUID(@PathVariable String serverName, @PathVariable String dataFieldGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific data field.
      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

      @PostMapping(path="/data-classes") public GUIDResponse createDataClass(@PathVariable String serverName, @RequestBody(required=false) NewElementRequestBody 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

      @PostMapping(path="/data-classes/from-template") public GUIDResponse createDataClassFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/data-classes/{dataClassGUID}/update") public VoidResponse updateDataClass(@PathVariable String serverName, @PathVariable String dataClassGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a data class.
      Parameters:
      serverName - name of called server.
      dataClassGUID - unique identifier of the data class (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.

    • linkNestedDataClass

      @PostMapping(path="/data-classes/{parentDataClassGUID}/nested-data-classes/{childDataClassGUID}/attach") public VoidResponse linkNestedDataClass(@PathVariable String serverName, @PathVariable String parentDataClassGUID, @PathVariable String childDataClassGUID, @RequestBody(required=false) 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 parent data class
      childDataClassGUID - unique identifier of the child 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

      @PostMapping(path="/data-classes/{parentDataClassGUID}/nested-data-classes/{childDataClassGUID}/detach") public VoidResponse detachNestedDataClass(@PathVariable String serverName, @PathVariable String parentDataClassGUID, @PathVariable String childDataClassGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach two nested data classes from one another.
      Parameters:
      serverName - name of called server
      parentDataClassGUID - unique identifier of the parent data class
      childDataClassGUID - unique identifier of the child 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.

    • linkSpecializedDataClass

      @PostMapping(path="/data-classes/{parentDataClassGUID}/specialized-data-classes/{childDataClassGUID}/attach") public VoidResponse linkSpecializedDataClass(@PathVariable String serverName, @PathVariable String parentDataClassGUID, @PathVariable String childDataClassGUID, @RequestBody(required=false) NewRelationshipRequestBody 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.

    • detachSpecializedDataClass

      @PostMapping(path="/data-classes/{parentDataClassGUID}/specialized-data-classes/{childDataClassGUID}/detach") public VoidResponse detachSpecializedDataClass(@PathVariable String serverName, @PathVariable String parentDataClassGUID, @PathVariable String childDataClassGUID, @RequestBody(required=false) DeleteRequestBody 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

      @PostMapping(path="/data-classes/{dataClassGUID}/delete") public VoidResponse deleteDataClass(@PathVariable String serverName, @PathVariable String dataClassGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Delete a data class.
      Parameters:
      serverName - name of called server
      dataClassGUID - 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.

    • getDataClassesByName

      @PostMapping(path="/data-classes/by-name") public OpenMetadataRootElementsResponse getDataClassesByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of data classes 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 there is a problem reported in the open metadata server(s)

    • findDataClasses

      @PostMapping(path="/data-classes/by-search-string") public OpenMetadataRootElementsResponse findDataClasses(@PathVariable String serverName, @RequestBody(required=false) SearchStringRequestBody 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
      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

      @PostMapping(path="/data-classes/{dataClassGUID}/retrieve") public OpenMetadataRootElementResponse getDataClassByGUID(@PathVariable String serverName, @PathVariable String dataClassGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific data class.
      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

      @PostMapping(path="/data-definitions/{dataDefinitionGUID}/data-class-definition/{dataClassGUID}/attach") public VoidResponse linkDataClassDefinition(@PathVariable String serverName, @PathVariable String dataDefinitionGUID, @PathVariable String dataClassGUID, @RequestBody(required=false) NewRelationshipRequestBody 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

      @PostMapping(path="/data-definitions/{dataDefinitionGUID}/data-class-definition/{dataClassGUID}/detach") public VoidResponse detachDataClassDefinition(@PathVariable String serverName, @PathVariable String dataDefinitionGUID, @PathVariable String dataClassGUID, @RequestBody(required=false) DeleteRequestBody 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

      @PostMapping(path="/data-definitions/{dataDefinitionGUID}/semantic-definition/{glossaryTermGUID}/attach") public VoidResponse linkSemanticDefinition(@PathVariable String serverName, @PathVariable String dataDefinitionGUID, @PathVariable String glossaryTermGUID, @RequestBody(required=false) 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 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

      @PostMapping(path="/data-definitions/{dataDefinitionGUID}/semantic-definition/{glossaryTermGUID}/detach") public VoidResponse detachSemanticDefinition(@PathVariable String serverName, @PathVariable String dataDefinitionGUID, @PathVariable String glossaryTermGUID, @RequestBody(required=false) DeleteRequestBody 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

      @PostMapping(path="/certification-types/{certificationTypeGUID}/data-structure-definition/{dataStructureGUID}/attach") public VoidResponse linkCertificationTypeToDataStructure(@PathVariable String serverName, @PathVariable String certificationTypeGUID, @PathVariable String dataStructureGUID, @RequestBody(required=false) 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 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

      @PostMapping(path="/certification-types/{certificationTypeGUID}/data-structure-definition/{dataStructureGUID}/detach") public VoidResponse detachCertificationTypeToDataStructure(@PathVariable String serverName, @PathVariable String certificationTypeGUID, @PathVariable String dataStructureGUID, @RequestBody(required=false) DeleteRequestBody 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.