Class DataDesignerRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.datadesigner.server.DataDesignerRESTServices
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateDataClass
(String serverName, NewElementRequestBody requestBody) Create a data class.createDataClassFromTemplate
(String serverName, TemplateRequestBody requestBody) Create a new metadata element to represent a data class using an existing metadata element as a template.createDataField
(String serverName, NewElementRequestBody requestBody) Create a data field.createDataFieldFromTemplate
(String serverName, TemplateRequestBody requestBody) Create a new metadata element to represent a data field using an existing metadata element as a template.createDataStructure
(String serverName, NewElementRequestBody requestBody) Create a data structure.createDataStructureFromTemplate
(String serverName, TemplateRequestBody requestBody) Create a new metadata element to represent a data structure using an existing metadata element as a template.deleteDataClass
(String serverName, String dataClassGUID, DeleteRequestBody requestBody) Delete a data class.deleteDataField
(String serverName, String dataFieldGUID, DeleteRequestBody requestBody) Delete a data field.deleteDataStructure
(String serverName, String dataStructureGUID, DeleteRequestBody requestBody) Delete a data structure.detachCertificationTypeToDataStructure
(String serverName, String certificationTypeGUID, String dataStructureGUID, DeleteRequestBody requestBody) Detach a data structure from a certification type.detachDataClassDefinition
(String serverName, String dataDefinitionGUID, String dataClassGUID, DeleteRequestBody requestBody) Detach a data definition from a data class.detachMemberDataField
(String serverName, String dataStructureGUID, String dataFieldGUID, DeleteRequestBody requestBody) Detach a data field from a data structure.detachNestedDataClass
(String serverName, String parentDataClassGUID, String childDataClassGUID, DeleteRequestBody requestBody) Detach two nested data classes from one another.detachNestedDataFields
(String serverName, String parentDataFieldGUID, String nestedDataFieldGUID, DeleteRequestBody requestBody) Detach two data fields from one another.detachSemanticDefinition
(String serverName, String dataDefinitionGUID, String glossaryTermGUID, DeleteRequestBody requestBody) Detach a data definition from a glossary term.detachSpecializedDataClass
(String serverName, String parentDataClassGUID, String childDataClassGUID, DeleteRequestBody requestBody) Detach two data classes from one another.findDataClasses
(String serverName, SearchStringRequestBody requestBody) Retrieve the list of data class metadata elements that contain the search string.findDataFields
(String serverName, SearchStringRequestBody requestBody) Retrieve the list of data field metadata elements that contain the search string.findDataStructures
(String serverName, SearchStringRequestBody requestBody) Retrieve the list of data structure metadata elements that contain the search string.getDataClassByGUID
(String serverName, String dataClassGUID, GetRequestBody requestBody) Retrieve the list of data class metadata elements that contain the search string.getDataClassesByName
(String serverName, FilterRequestBody requestBody) Retrieve the list of data class metadata elements that contain the search string.getDataFieldByGUID
(String serverName, String dataFieldGUID, GetRequestBody requestBody) Retrieve the list of data field metadata elements that contain the search string.getDataFieldsByName
(String serverName, FilterRequestBody requestBody) Retrieve the list of data field metadata elements that contain the search string.getDataStructureByGUID
(String serverName, String dataStructureGUID, GetRequestBody requestBody) Retrieve the list of data structure metadata elements that contain the search string.getDataStructuresByName
(String serverName, FilterRequestBody requestBody) Retrieve the list of data structure metadata elements that contain the search string.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 classes are attached to the associated data fields using the DataClassDefinition relationship) contain the valid values.linkDataClassDefinition
(String serverName, String dataDefinitionGUID, String dataClassGUID, 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.linkMemberDataField
(String serverName, String dataStructureGUID, String dataFieldGUID, NewRelationshipRequestBody requestBody) Attach a data field to a data structure.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).linkNestedDataFields
(String serverName, String parentDataFieldGUID, String nestedDataFieldGUID, NewRelationshipRequestBody requestBody) Connect two data field as parent and child.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.linkSpecializedDataClass
(String serverName, String parentDataClassGUID, String childDataClassGUID, NewRelationshipRequestBody requestBody) Connect two data classes to show that one provides a more specialist evaluation.updateDataClass
(String serverName, String dataClassGUID, UpdateElementRequestBody requestBody) Update the properties of a data class.updateDataField
(String serverName, String dataFieldGUID, UpdateElementRequestBody requestBody) Update the properties of a data field.updateDataStructure
(String serverName, String dataStructureGUID, UpdateElementRequestBody requestBody) Update the properties of a data structure.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
Constructor Details
-
DataDesignerRESTServices
public DataDesignerRESTServices()Default constructor
-
-
Method Details
-
createDataStructure
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 userrequestBody
- 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, 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
public VoidResponse linkMemberDataField(String serverName, String dataStructureGUID, String dataFieldGUID, NewRelationshipRequestBody requestBody) Attach a data field to a data structure.- Parameters:
serverName
- name of called serverdataStructureGUID
- 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 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 dataStructureGUID, String dataFieldGUID, DeleteRequestBody requestBody) Detach a data field from a data structure.- Parameters:
serverName
- name of called serverdataStructureGUID
- 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 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, DeleteRequestBody requestBody) Delete a data structure.- Parameters:
serverName
- name of called serverdataStructureGUID
- unique identifier of the element to deleterequestBody
- 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 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 torequestBody
- 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 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 todataStructureGUID
- unique identifier of the required elementrequestBody
- 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 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 torequestBody
- 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
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
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 userrequestBody
- 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, 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
public VoidResponse linkNestedDataFields(String serverName, String parentDataFieldGUID, String nestedDataFieldGUID, NewRelationshipRequestBody requestBody) Connect two data field as parent and child.- Parameters:
serverName
- name of called serverparentDataFieldGUID
- unique identifier of the parent data fieldnestedDataFieldGUID
- unique identifier of the child data fieldrequestBody
- 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, DeleteRequestBody requestBody) Detach two data fields from one another.- Parameters:
serverName
- name of called serverparentDataFieldGUID
- unique identifier of the first data fieldnestedDataFieldGUID
- unique identifier of the second data fieldrequestBody
- 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, DeleteRequestBody requestBody) Delete a data field.- Parameters:
serverName
- name of called serverdataFieldGUID
- unique identifier of the element to deleterequestBody
- 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 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 torequestBody
- 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 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 torequestBody
- 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 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 todataFieldGUID
- unique identifier of the required elementrequestBody
- 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
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
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 userrequestBody
- 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, 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
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 serverparentDataClassGUID
- unique identifier of the first data classchildDataClassGUID
- unique identifier of the second data classrequestBody
- 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, DeleteRequestBody requestBody) Detach two nested data classes from one another.- Parameters:
serverName
- name of called serverparentDataClassGUID
- unique identifier of the first data classchildDataClassGUID
- unique identifier of the second data classrequestBody
- 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
public VoidResponse linkSpecializedDataClass(String serverName, String parentDataClassGUID, String childDataClassGUID, NewRelationshipRequestBody requestBody) Connect two data classes to show that one provides a more specialist evaluation.- Parameters:
serverName
- name of called serverparentDataClassGUID
- unique identifier of the first data classchildDataClassGUID
- unique identifier of the second data classrequestBody
- 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
public VoidResponse detachSpecializedDataClass(String serverName, String parentDataClassGUID, String childDataClassGUID, DeleteRequestBody requestBody) Detach two data classes from one another.- Parameters:
serverName
- name of called serverparentDataClassGUID
- unique identifier of the first data classchildDataClassGUID
- unique identifier of the second data classrequestBody
- 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, DeleteRequestBody requestBody) Delete a data class.- Parameters:
serverName
- name of called serverdataClassGUID
- unique identifier of the element to deleterequestBody
- 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 OpenMetadataRootElementsResponse getDataClassesByName(String serverName, 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 torequestBody
- 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 OpenMetadataRootElementsResponse findDataClasses(String serverName, 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 torequestBody
- 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 OpenMetadataRootElementResponse getDataClassByGUID(String serverName, String dataClassGUID, GetRequestBody requestBody) Retrieve the list of data class metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request todataClassGUID
- unique identifier of the required elementrequestBody
- 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, 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 serverdataDefinitionGUID
- unique identifier of the data design element (eg data field) that uses the data classdataClassGUID
- unique identifier of the data classrequestBody
- 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, DeleteRequestBody requestBody) Detach a data definition from a data class.- Parameters:
serverName
- name of called serverdataDefinitionGUID
- unique identifier of the data design element (eg data field) that uses the data classdataClassGUID
- unique identifier of the data classrequestBody
- 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, 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 serverdataDefinitionGUID
- unique identifier of the data design element (eg data field) that uses the data classglossaryTermGUID
- unique identifier of the glossary termrequestBody
- 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, DeleteRequestBody requestBody) Detach a data definition from a glossary term.- Parameters:
serverName
- name of called serverdataDefinitionGUID
- unique identifier of the data design element (eg data field) that uses the data classglossaryTermGUID
- unique identifier of the glossary termrequestBody
- 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, 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 servercertificationTypeGUID
- unique identifier of the certification typedataStructureGUID
- unique identifier of the data structurerequestBody
- 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, DeleteRequestBody requestBody) Detach a data structure from a certification type.- Parameters:
serverName
- name of called servercertificationTypeGUID
- unique identifier of the certification typedataStructureGUID
- unique identifier of the data structurerequestBody
- 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.
-