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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateDataClass
(String serverName, NewDataClassRequestBody 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, NewDataFieldRequestBody 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, NewDataStructureRequestBody 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, boolean cascadedDelete, MetadataSourceRequestBody requestBody) Delete a data class.deleteDataField
(String serverName, String dataFieldGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody) Delete a data field.deleteDataStructure
(String serverName, String dataStructureGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody) Delete a data structure.detachCertificationTypeToDataStructure
(String serverName, String certificationTypeGUID, String dataStructureGUID, MetadataSourceRequestBody requestBody) Detach a data structure from a certification type.detachDataClassDefinition
(String serverName, String dataDefinitionGUID, String dataClassGUID, MetadataSourceRequestBody requestBody) Detach a data definition from a data class.detachMemberDataField
(String serverName, String parentDataStructureGUID, String memberDataFieldGUID, MetadataSourceRequestBody requestBody) Detach a data field from a data structure.detachNestedDataClass
(String serverName, String parentDataClassGUID, String childDataClassGUID, MetadataSourceRequestBody requestBody) Detach two nested data classes from one another.detachNestedDataFields
(String serverName, String parentDataFieldGUID, String nestedDataFieldGUID, MetadataSourceRequestBody requestBody) Detach two data fields from one another.detachSemanticDefinition
(String serverName, String dataDefinitionGUID, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Detach a data definition from a glossary term.detachSpecialistDataClass
(String serverName, String parentDataClassGUID, String childDataClassGUID, MetadataSourceRequestBody requestBody) Detach two data classes from one another.findDataClasses
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, FilterRequestBody requestBody) Retrieve the list of data class metadata elements that contain the search string.findDataFields
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, FilterRequestBody requestBody) Retrieve the list of data field metadata elements that contain the search string.findDataStructures
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, FilterRequestBody requestBody) Retrieve the list of data structure metadata elements that contain the search string.getDataClassByGUID
(String serverName, String dataClassGUID, AnyTimeRequestBody requestBody) Return the properties of a specific data class.getDataClassesByName
(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of data classes with a particular name.getDataFieldByGUID
(String serverName, String dataFieldGUID, AnyTimeRequestBody requestBody) Return the properties of a specific data field.getDataFieldsByName
(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of data fields with a particular name.getDataStructureByGUID
(String serverName, String dataStructureGUID, AnyTimeRequestBody requestBody) Return the properties of a specific data structure.getDataStructuresByName
(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of data structures with a particular name.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.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.linkMemberDataField
(String serverName, String parentDataStructureGUID, String memberDataFieldGUID, MemberDataFieldRequestBody requestBody) Attach a data field to a data structure.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).linkNestedDataFields
(String serverName, String parentDataFieldGUID, String nestedDataFieldGUID, MemberDataFieldRequestBody requestBody) Connect two data field as parent and child.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.linkSpecialistDataClass
(String serverName, String parentDataClassGUID, String childDataClassGUID, MetadataSourceRequestBody requestBody) Connect two data classes to show that one provides a more specialist evaluation.updateDataClass
(String serverName, String dataClassGUID, boolean replaceAllProperties, UpdateDataClassRequestBody requestBody) Update the properties of a data class.updateDataField
(String serverName, String dataFieldGUID, boolean replaceAllProperties, UpdateDataFieldRequestBody requestBody) Update the properties of a data field.updateDataStructure
(String serverName, String dataStructureGUID, boolean replaceAllProperties, UpdateDataStructureRequestBody requestBody) Update the properties of a data structure.
-
Constructor Details
-
DataDesignerResource
public DataDesignerResource()Default constructor
-
-
Method Details
-
createDataStructure
@PostMapping(path="/data-structures") public GUIDResponse createDataStructure(@PathVariable String serverName, @RequestBody(required=false) 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
@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 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
@PostMapping(path="/data-structures/{dataStructureGUID}/update") public VoidResponse updateDataStructure(@PathVariable String serverName, @PathVariable String dataStructureGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) 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
@PostMapping(path="/data-structures/{parentDataStructureGUID}/member-data-fields/{memberDataFieldGUID}/attach") public VoidResponse linkMemberDataField(@PathVariable String serverName, @PathVariable String parentDataStructureGUID, @PathVariable String memberDataFieldGUID, @RequestBody(required=false) MemberDataFieldRequestBody requestBody) Attach a data field to a data structure.- Parameters:
serverName
- name of called serverparentDataStructureGUID
- unique identifier of the first data structurememberDataFieldGUID
- unique identifier of the second 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.
-
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) MetadataSourceRequestBody requestBody) Detach a data field from a data structure.- Parameters:
serverName
- name of called serverparentDataStructureGUID
- unique identifier of the first data structurememberDataFieldGUID
- unique identifier of the second 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.
-
deleteDataStructure
@PostMapping(path="/data-structures/{dataStructureGUID}/delete") public VoidResponse deleteDataStructure(@PathVariable String serverName, @PathVariable String dataStructureGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Delete a data structure.- Parameters:
serverName
- name of called serverdataStructureGUID
- unique identifier of the element to deletecascadedDelete
- 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
@PostMapping(path="/data-structures/by-name") public DataStructuresResponse getDataStructuresByName(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @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 tostartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- 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 DataStructuresResponse findDataStructures(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) 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 tostartsWith
- 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 pointpageSize
- maximum results that can be returnedrequestBody
- 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 DataStructureResponse getDataStructureByGUID(@PathVariable String serverName, @PathVariable String dataStructureGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody) Return the properties of a specific data structure.- 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)
-
createDataField
@PostMapping(path="/data-fields") public GUIDResponse createDataField(@PathVariable String serverName, @RequestBody(required=false) 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
@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 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
@PostMapping(path="/data-fields/{dataFieldGUID}/update") public VoidResponse updateDataField(@PathVariable String serverName, @PathVariable String dataFieldGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) 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
@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) MemberDataFieldRequestBody 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
@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) MetadataSourceRequestBody requestBody) Detach two data fields from one another.- 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.
-
deleteDataField
@PostMapping(path="/data-fields/{dataFieldGUID}/delete") public VoidResponse deleteDataField(@PathVariable String serverName, @PathVariable String dataFieldGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Delete a data field.- Parameters:
serverName
- name of called serverdataFieldGUID
- unique identifier of the element to deletecascadedDelete
- 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
@PostMapping(path="/data-fields/by-name") public DataFieldsResponse getDataFieldsByName(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @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 tostartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- 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 DataFieldsResponse findDataFields(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) 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 tostartsWith
- 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 pointpageSize
- maximum results that can be returnedrequestBody
- 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 DataFieldResponse getDataFieldByGUID(@PathVariable String serverName, @PathVariable String dataFieldGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody) Return the properties of a specific data field.- 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
@PostMapping(path="/data-classes") public GUIDResponse createDataClass(@PathVariable String serverName, @RequestBody(required=false) 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
@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 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
@PostMapping(path="/data-classes/{dataClassGUID}/update") public VoidResponse updateDataClass(@PathVariable String serverName, @PathVariable String dataClassGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) 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
@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) 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 serverparentDataClassGUID
- unique identifier of the parent data classchildDataClassGUID
- unique identifier of the child 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
@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) MetadataSourceRequestBody requestBody) Detach two nested data classes from one another.- Parameters:
serverName
- name of called serverparentDataClassGUID
- unique identifier of the parent data classchildDataClassGUID
- unique identifier of the child 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.
-
linkSpecialistDataClass
@PostMapping(path="/data-classes/{parentDataClassGUID}/specialist-data-classes/{childDataClassGUID}/attach") public VoidResponse linkSpecialistDataClass(@PathVariable String serverName, @PathVariable String parentDataClassGUID, @PathVariable String childDataClassGUID, @RequestBody(required=false) MetadataSourceRequestBody 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.
-
detachSpecialistDataClass
@PostMapping(path="/data-classes/{parentDataClassGUID}/specialist-data-classes/{childDataClassGUID}/detach") public VoidResponse detachSpecialistDataClass(@PathVariable String serverName, @PathVariable String parentDataClassGUID, @PathVariable String childDataClassGUID, @RequestBody(required=false) MetadataSourceRequestBody 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
@PostMapping(path="/data-classes/{dataClassGUID}/delete") public VoidResponse deleteDataClass(@PathVariable String serverName, @PathVariable String dataClassGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Delete a data class.- Parameters:
serverName
- name of called serverdataClassGUID
- unique identifier of the element to deletecascadedDelete
- can data classes be deleted if other 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
@PostMapping(path="/data-classes/by-name") public DataClassesResponse getDataClassesByName(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @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 tostartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- 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 DataClassesResponse findDataClasses(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) 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 tostartsWith
- 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 pointpageSize
- maximum results that can be returnedrequestBody
- 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 DataClassResponse getDataClassByGUID(@PathVariable String serverName, @PathVariable String dataClassGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody) Return the properties of a specific data class.- 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
@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) 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 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
@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) MetadataSourceRequestBody 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
@PostMapping(path="/data-definitions/{dataDefinitionGUID}/semantic-definition/{glossaryTermGUID}/attach") public VoidResponse linkSemanticDefinition(@PathVariable String serverName, @PathVariable String dataDefinitionGUID, @PathVariable String glossaryTermGUID, @RequestBody(required=false) 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 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
@PostMapping(path="/data-definitions/{dataDefinitionGUID}/semantic-definition/{glossaryTermGUID}/detach") public VoidResponse detachSemanticDefinition(@PathVariable String serverName, @PathVariable String dataDefinitionGUID, @PathVariable String glossaryTermGUID, @RequestBody(required=false) MetadataSourceRequestBody 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
@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) 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 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
@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) MetadataSourceRequestBody 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.
-