Class DataDiscoveryRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.datadiscovery.server.DataDiscoveryRESTServices
The DataDiscoveryRESTServices provides the server-side implementation of the Data Discovery Open Metadata
 View Service (OMVS).  This interface provides access to a person's profile, roles and network.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionattachAnnotationToReport(String serverName, String surveyReportGUID, String newAnnotationGUID, NewRelationshipRequestBody requestBody) Create a relationship that links a new annotation to its survey report.createAnnotation(String serverName, NewElementRequestBody requestBody) Create an annotation.createAnnotationFromTemplate(String serverName, TemplateRequestBody requestBody) Create a new metadata element to represent an annotation using an existing metadata element as a template.deleteAnnotation(String serverName, String annotationGUID, DeleteElementRequestBody requestBody) Delete an annotation.detachAnnotationFromDescribedElement(String serverName, String elementGUID, String annotationGUID, DeleteRelationshipRequestBody requestBody) Detach an annotation from the element that it is describing (via AssociatedAnnotation relationship).detachAnnotationFromItsPredecessor(String serverName, String previousAnnotationGUID, String newAnnotationGUID, DeleteRelationshipRequestBody requestBody) Detach an annotation from an annotation from the previous run of the survey.detachAnnotationFromReport(String serverName, String surveyReportGUID, String newAnnotationGUID, DeleteRelationshipRequestBody requestBody) Detach an annotation from its report (ReportedAnnotation relationship).detachDataClassMatch(String serverName, String annotationGUID, String dataClassGUID, DeleteRelationshipRequestBody requestBody) Detach a data class annotation from a data class.detachDiscoveredSchemaType(String serverName, String annotationGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody) Detach a schema analysis annotation from a matching schema type.detachRequestForActionTarget(String serverName, String annotationGUID, String elementGUID, DeleteRelationshipRequestBody requestBody) Detach a request for action annotation from its intended target element.detachResourceProfileData(String serverName, String annotationGUID, String assetGUID, DeleteRelationshipRequestBody requestBody) Detach a resource profile log annotation from an asset where the profile data is stored.findAnnotations(String serverName, SearchStringRequestBody requestBody) Retrieve the list of annotation metadata elements that contain the search string.getAnnotationByGUID(String serverName, String annotationGUID, GetRequestBody requestBody) Retrieve the list of annotation metadata elements that contain the search string.getAnnotationExtensions(String serverName, String annotationGUID, ResultsRequestBody requestBody) Returns the list of annotations that extend the supplied annotation (AnnotationExtension relationship).getAnnotationsByAnalysisStep(String serverName, FilterRequestBody requestBody) Returns the list of annotations associated with a particular analysis step.getAnnotationsByAnnotationType(String serverName, FilterRequestBody requestBody) Returns the list of annotations with a particular annotation type property.getAnnotationsByName(String serverName, FilterRequestBody requestBody) Retrieve the list of annotation metadata elements that contain the search string.getAnnotationsForElement(String serverName, String elementGUID, ResultsRequestBody requestBody) Returns the list of annotations that describe the supplied element (AssociatedAnnotation relationship).getNewAnnotations(String serverName, String surveyReportGUID, ResultsRequestBody requestBody) Returns the annotations created under the supplied survey report.getPreviousAnnotations(String serverName, String annotationGUID, ResultsRequestBody requestBody) Returns the list of annotations that are extended by the supplied annotation (AnnotationExtension relationship).linkAnnotationToDescribedElement(String serverName, String elementGUID, String annotationGUID, NewRelationshipRequestBody requestBody) Attach an annotation to the element that it is describing (via AssociatedAnnotation relationship).linkAnnotationToItsPredecessor(String serverName, String previousAnnotationGUID, String newAnnotationGUID, NewRelationshipRequestBody requestBody) Attach an annotation to the equivalent annotation from the previous run of the survey.linkDataClassMatch(String serverName, String annotationGUID, String dataClassGUID, NewRelationshipRequestBody requestBody) Attach a data class annotation to a data class.linkDiscoveredSchemaType(String serverName, String annotationGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody) Attach a schema analysis annotation to a matching schema type.linkRequestForActionTarget(String serverName, String annotationGUID, String elementGUID, NewRelationshipRequestBody requestBody) Attach a request for action annotation to the element that needs attention.linkResourceProfileData(String serverName, String annotationGUID, String assetGUID, NewRelationshipRequestBody requestBody) Attach a resource profile log annotation to an asset where the profile data is stored.updateAnnotation(String serverName, String annotationGUID, UpdateElementRequestBody requestBody) Update the properties of an annotation.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenControllergetUser
- 
Constructor Details- 
DataDiscoveryRESTServicespublic DataDiscoveryRESTServices()Default constructor
 
- 
- 
Method Details- 
createAnnotationCreate an annotation.- Parameters:
- serverName- name of called server.
- requestBody- properties for the annotation.
- 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.
 
- 
createAnnotationFromTemplatepublic GUIDResponse createAnnotationFromTemplate(String serverName, TemplateRequestBody requestBody) Create a new metadata element to represent an annotation 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)
 
- 
updateAnnotationpublic VoidResponse updateAnnotation(String serverName, String annotationGUID, UpdateElementRequestBody requestBody) Update the properties of an annotation.- Parameters:
- serverName- name of called server.
- annotationGUID- unique identifier of the annotation (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.
 
- 
attachAnnotationToReportpublic VoidResponse attachAnnotationToReport(String serverName, String surveyReportGUID, String newAnnotationGUID, NewRelationshipRequestBody requestBody) Create a relationship that links a new annotation to its survey report. This relationship is typically established during the createAnnotation as the parent relationship. It is included for completeness.- Parameters:
- serverName- name of called server
- surveyReportGUID- unique identifier of the report
- newAnnotationGUID- unique identifier of the annotation
- 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.
 
- 
detachAnnotationFromReportpublic VoidResponse detachAnnotationFromReport(String serverName, String surveyReportGUID, String newAnnotationGUID, DeleteRelationshipRequestBody requestBody) Detach an annotation from its report (ReportedAnnotation relationship).- Parameters:
- serverName- name of called server
- surveyReportGUID- unique identifier of the report
- newAnnotationGUID- unique identifier of the annotation
- 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.
 
- 
linkAnnotationToDescribedElementpublic VoidResponse linkAnnotationToDescribedElement(String serverName, String elementGUID, String annotationGUID, NewRelationshipRequestBody requestBody) Attach an annotation to the element that it is describing (via AssociatedAnnotation relationship).- Parameters:
- serverName- name of called server
- elementGUID- unique identifier of the described element
- annotationGUID- unique identifier of the annotation
- 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.
 
- 
detachAnnotationFromDescribedElementpublic VoidResponse detachAnnotationFromDescribedElement(String serverName, String elementGUID, String annotationGUID, DeleteRelationshipRequestBody requestBody) Detach an annotation from the element that it is describing (via AssociatedAnnotation relationship).- Parameters:
- serverName- name of called server
- elementGUID- unique identifier of the described element
- annotationGUID- unique identifier of the annotation
- 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.
 
- 
linkAnnotationToItsPredecessorpublic VoidResponse linkAnnotationToItsPredecessor(String serverName, String previousAnnotationGUID, String newAnnotationGUID, NewRelationshipRequestBody requestBody) Attach an annotation to the equivalent annotation from the previous run of the survey.- Parameters:
- serverName- name of called server
- previousAnnotationGUID- unique identifier of the annotation from the previous run of the survey
- newAnnotationGUID- unique identifier of the annotation from this run of the survey
- 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.
 
- 
detachAnnotationFromItsPredecessorpublic VoidResponse detachAnnotationFromItsPredecessor(String serverName, String previousAnnotationGUID, String newAnnotationGUID, DeleteRelationshipRequestBody requestBody) Detach an annotation from an annotation from the previous run of the survey.- Parameters:
- serverName- name of called server
- previousAnnotationGUID- unique identifier of the annotation from the previous run of the survey
- newAnnotationGUID- unique identifier of the annotation from this run of the survey
- 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.
 
- 
linkDiscoveredSchemaTypepublic VoidResponse linkDiscoveredSchemaType(String serverName, String annotationGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody) Attach a schema analysis annotation to a matching schema type.- Parameters:
- serverName- name of called server
- annotationGUID- unique identifier of the annotation
- schemaTypeGUID- unique identifier of the schema type
- 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.
 
- 
detachDiscoveredSchemaTypepublic VoidResponse detachDiscoveredSchemaType(String serverName, String annotationGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody) Detach a schema analysis annotation from a matching schema type.- Parameters:
- serverName- name of called server
- annotationGUID- unique identifier of the annotation
- schemaTypeGUID- unique identifier of the schema type
- 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.
 
- 
linkResourceProfileDatapublic VoidResponse linkResourceProfileData(String serverName, String annotationGUID, String assetGUID, NewRelationshipRequestBody requestBody) Attach a resource profile log annotation to an asset where the profile data is stored.- Parameters:
- serverName- name of called server
- annotationGUID- unique identifier of the annotation
- assetGUID- unique identifier of the associated asset
- 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.
 
- 
detachResourceProfileDatapublic VoidResponse detachResourceProfileData(String serverName, String annotationGUID, String assetGUID, DeleteRelationshipRequestBody requestBody) Detach a resource profile log annotation from an asset where the profile data is stored.- Parameters:
- serverName- name of called server
- annotationGUID- unique identifier of the annotation
- assetGUID- unique identifier of the associated asset
- 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.
 
- 
linkDataClassMatchpublic VoidResponse linkDataClassMatch(String serverName, String annotationGUID, String dataClassGUID, NewRelationshipRequestBody requestBody) Attach a data class annotation to a data class.- Parameters:
- serverName- name of called server
- annotationGUID- unique identifier of the annotation
- dataClassGUID- unique identifier of the associated 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.
 
- 
detachDataClassMatchpublic VoidResponse detachDataClassMatch(String serverName, String annotationGUID, String dataClassGUID, DeleteRelationshipRequestBody requestBody) Detach a data class annotation from a data class.- Parameters:
- serverName- name of called server
- annotationGUID- unique identifier of the annotation
- dataClassGUID- unique identifier of the associated 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.
 
- 
linkRequestForActionTargetpublic VoidResponse linkRequestForActionTarget(String serverName, String annotationGUID, String elementGUID, NewRelationshipRequestBody requestBody) Attach a request for action annotation to the element that needs attention.- Parameters:
- serverName- name of called server
- annotationGUID- unique identifier of the annotation
- elementGUID- unique identifier of the associated element
- 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.
 
- 
detachRequestForActionTargetpublic VoidResponse detachRequestForActionTarget(String serverName, String annotationGUID, String elementGUID, DeleteRelationshipRequestBody requestBody) Detach a request for action annotation from its intended target element.- Parameters:
- serverName- name of called server
- annotationGUID- unique identifier of the annotation
- elementGUID- unique identifier of the associated element
- 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.
 
- 
deleteAnnotationpublic VoidResponse deleteAnnotation(String serverName, String annotationGUID, DeleteElementRequestBody requestBody) Delete an annotation.- Parameters:
- serverName- name of called server
- annotationGUID- 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.
 
- 
getAnnotationsByNamepublic OpenMetadataRootElementsResponse getAnnotationsByName(String serverName, FilterRequestBody requestBody) Retrieve the list of annotation 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)
 
- 
getAnnotationsByAnalysisSteppublic OpenMetadataRootElementsResponse getAnnotationsByAnalysisStep(String serverName, FilterRequestBody requestBody) Returns the list of annotations associated with a particular analysis step.- 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)
 
- 
getAnnotationsByAnnotationTypepublic OpenMetadataRootElementsResponse getAnnotationsByAnnotationType(String serverName, FilterRequestBody requestBody) Returns the list of annotations with a particular annotation type property.- 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)
 
- 
getAnnotationsForElementpublic OpenMetadataRootElementsResponse getAnnotationsForElement(String serverName, String elementGUID, ResultsRequestBody requestBody) Returns the list of annotations that describe the supplied element (AssociatedAnnotation relationship).- Parameters:
- serverName- name of the service to route the request to
- elementGUID- unique identifier of the starting 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)
 
- 
getNewAnnotationspublic OpenMetadataRootElementsResponse getNewAnnotations(String serverName, String surveyReportGUID, ResultsRequestBody requestBody) Returns the annotations created under the supplied survey report.- Parameters:
- serverName- name of the service to route the request to
- surveyReportGUID- unique identifier of the starting 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)
 
- 
getAnnotationExtensionspublic OpenMetadataRootElementsResponse getAnnotationExtensions(String serverName, String annotationGUID, ResultsRequestBody requestBody) Returns the list of annotations that extend the supplied annotation (AnnotationExtension relationship).- Parameters:
- serverName- name of the service to route the request to
- annotationGUID- unique identifier of the starting 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)
 
- 
getPreviousAnnotationspublic OpenMetadataRootElementsResponse getPreviousAnnotations(String serverName, String annotationGUID, ResultsRequestBody requestBody) Returns the list of annotations that are extended by the supplied annotation (AnnotationExtension relationship).- Parameters:
- serverName- name of the service to route the request to
- annotationGUID- unique identifier of the starting 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)
 
- 
getAnnotationByGUIDpublic OpenMetadataRootElementResponse getAnnotationByGUID(String serverName, String annotationGUID, GetRequestBody requestBody) Retrieve the list of annotation metadata elements that contain the search string.- Parameters:
- serverName- name of the service to route the request to
- annotationGUID- 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)
 
- 
findAnnotationspublic OpenMetadataRootElementsResponse findAnnotations(String serverName, SearchStringRequestBody requestBody) Retrieve the list of annotation 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)
 
 
-