@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/discovery-engine/users/{userId}")
public class DiscoveryEngineResource
extends Object
| Constructor and Description |
|---|
DiscoveryEngineResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
AnnotationResponse |
addAnnotationToAnnotation(String serverName,
String userId,
String anchorAnnotationGUID,
Annotation requestBody)
Add a new annotation and link it to an existing annotation.
|
GUIDResponse |
addAnnotationToDiscoveryReport(String serverName,
String userId,
String discoveryReportGUID,
Annotation requestBody)
Add a new annotation to the annotation store as a top level annotation linked directly off of the report.
|
DiscoveryAnalysisReportResponse |
createDiscoveryAnalysisReport(String serverName,
String userId,
String assetGUID,
DiscoveryAnalysisReportRequestBody requestBody)
Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.
|
VoidResponse |
deleteAnnotation(String serverName,
String userId,
String annotationGUID,
NullRequestBody requestBody)
Remove an annotation from the annotation store.
|
AnnotationResponse |
getAnnotation(String serverName,
String userId,
String annotationGUID)
Retrieve a single annotation by unique identifier.
|
AnnotationListResponse |
getAnnotationsForAssetByStatus(String serverName,
String userId,
String assetGUID,
int startingFrom,
int maximumResults,
StatusRequestBody requestBody)
Return the list of annotations from previous runs of the discovery service that are set to a specific status.
|
DiscoveryAnalysisReportResponse |
getDiscoveryReport(String serverName,
String userId,
String discoveryReportGUID)
Request the discovery report for a discovery request that has completed.
|
AnnotationListResponse |
getDiscoveryReportAnnotations(String serverName,
String userId,
String discoveryReportGUID,
int startingFrom,
int maximumResults)
Return the annotations linked directly to the report.
|
AnnotationListResponse |
getExtendedAnnotations(String serverName,
String userId,
String annotationGUID,
int startingFrom,
int maximumResults)
Return any annotations attached to this annotation.
|
VoidResponse |
linkAnnotation(String serverName,
String userId,
String anchorGUID,
String annotationGUID,
NullRequestBody requestBody)
Link an existing annotation to another object.
|
VoidResponse |
unlinkAnnotation(String serverName,
String userId,
String anchorGUID,
String annotationGUID,
NullRequestBody requestBody)
Remove the relationship between an annotation and another object.
|
AnnotationResponse |
updateAnnotation(String serverName,
String userId,
String annotationGUID,
Annotation requestBody)
Replace the current properties of an annotation.
|
DiscoveryAnalysisReportResponse |
updateDiscoveryAnalysisReport(String serverName,
String userId,
String discoveryReportGUID,
DiscoveryAnalysisReport requestBody)
Update the properties of the discovery analysis report.
|
@RequestMapping(method=POST,
path="/assets/{assetGUID}/discovery-analysis-reports")
public DiscoveryAnalysisReportResponse createDiscoveryAnalysisReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody
DiscoveryAnalysisReportRequestBody requestBody)
serverName - name of server instance to route request touserId - calling userassetGUID - unique identifier of the asset being analysedrequestBody - all of the other parameters@RequestMapping(method=POST,
path="/discovery-analysis-reports/{discoveryReportGUID}")
public DiscoveryAnalysisReportResponse updateDiscoveryAnalysisReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID,
@RequestBody
DiscoveryAnalysisReport requestBody)
serverName - name of server instance to route request touserId - calling userdiscoveryReportGUID - unique identifier of the report to updaterequestBody - updated report - this will replace what was previous stored@RequestMapping(method=GET,
path="/discovery-analysis-reports/{discoveryReportGUID}")
public DiscoveryAnalysisReportResponse getDiscoveryReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID)
serverName - name of server instance to route request touserId - identifier of calling userdiscoveryReportGUID - identifier of the discovery request.@RequestMapping(method=GET,
path="/assets/{assetGUID}/annotations")
public AnnotationListResponse getAnnotationsForAssetByStatus(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults,
@RequestBody
StatusRequestBody requestBody)
serverName - name of server instance to route request touserId - calling userassetGUID - unique identifier of the assetstartingFrom - starting position in the list.maximumResults - maximum number of elements that can be returnedrequestBody - status value to use on the query@RequestMapping(method=GET,
path="/discovery-analysis-reports/{discoveryReportGUID}/annotations")
public AnnotationListResponse getDiscoveryReportAnnotations(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of server instance to route request touserId - identifier of calling userdiscoveryReportGUID - identifier of the discovery request.startingFrom - initial position in the stored list.maximumResults - maximum number of definitions to return on this call.@RequestMapping(method=GET,
path="/annotations/{annotationGUID}/extended-annotations")
public AnnotationListResponse getExtendedAnnotations(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String annotationGUID,
@RequestParam
int startingFrom,
@RequestParam
int maximumResults)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - anchor annotationstartingFrom - starting position in the listmaximumResults - maximum number of annotations that can be returned.@RequestMapping(method=GET,
path="/annotations/{annotationGUID}")
public AnnotationResponse getAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String annotationGUID)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - unique identifier of the annotation@RequestMapping(method=POST,
path="/discovery-analysis-reports/{discoveryReportGUID}/annotations")
public GUIDResponse addAnnotationToDiscoveryReport(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String discoveryReportGUID,
@RequestBody
Annotation requestBody)
serverName - name of server instance to route request touserId - identifier of calling userdiscoveryReportGUID - unique identifier of the discovery analysis reportrequestBody - annotation object@RequestMapping(method=POST,
path="/annotations/{anchorAnnotationGUID}/extended-annotations")
public AnnotationResponse addAnnotationToAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String anchorAnnotationGUID,
@RequestBody
Annotation requestBody)
serverName - name of server instance to route request touserId - identifier of calling useranchorAnnotationGUID - unique identifier of the annotation that this new one os to be attached torequestBody - annotation object@RequestMapping(method=POST,
path="/annotations/{annotationGUID}/related-instances/{anchorGUID}")
public VoidResponse linkAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String anchorGUID,
@PathVariable
String annotationGUID,
@RequestBody
NullRequestBody requestBody)
serverName - name of server instance to route request touserId - identifier of calling useranchorGUID - unique identifier that the annotation is to be linked toannotationGUID - unique identifier of the annotationrequestBody - null request body to satisfy POST semantics@RequestMapping(method=POST,
path="/annotations/{annotationGUID}/related-instances/{anchorGUID}/delete")
public VoidResponse unlinkAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String anchorGUID,
@PathVariable
String annotationGUID,
@RequestBody
NullRequestBody requestBody)
serverName - name of server instance to route request touserId - identifier of calling useranchorGUID - unique identifier that the annotation is to be unlinked fromannotationGUID - unique identifier of the annotationrequestBody - null request body to satisfy POST semantics@RequestMapping(method=POST,
path="/annotations/{annotationGUID}")
public AnnotationResponse updateAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String annotationGUID,
@RequestBody
Annotation requestBody)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - identifier of the annotation to changerequestBody - new properties@RequestMapping(method=POST,
path="/annotations/{annotationGUID}/delete")
public VoidResponse deleteAnnotation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String annotationGUID,
@RequestBody
NullRequestBody requestBody)
serverName - name of server instance to route request touserId - identifier of calling userannotationGUID - unique identifier of the annotationrequestBody - null request body to satisfy POST semanticsCopyright © 2018–2019 ODPi. All rights reserved.