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

Class PrivacyOfficerResource

java.lang.Object

org.odpi.openmetadata.viewservices.privacyofficer.server.spring.PrivacyOfficerResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/privacy-officer")
public class PrivacyOfficerResource
extends Object

The PrivacyOfficerResource provides part of the server-side implementation of the Privacy Officer OMVS. =

Constructor Summary

Constructors

Constructor	Description
PrivacyOfficerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	detachDataProcessingTarget(String serverName, String dataProcessingActionGUID, String targetGUID, DeleteRelationshipRequestBody requestBody)	Detach a data processing action from a target element.
VoidResponse	detachPermittedProcessing(String serverName, String dataProcessingPurposeGUID, String dataProcessingDescriptionGUID, DeleteRelationshipRequestBody requestBody)	Detach a data processing purpose from a data processing description.
VoidResponse	linkDataProcessingTarget(String serverName, String dataProcessingActionGUID, String targetGUID, NewRelationshipRequestBody requestBody)	Link a data processing action to a target element.
VoidResponse	linkPermittedProcessing(String serverName, String dataProcessingPurposeGUID, String dataProcessingDescriptionGUID, NewRelationshipRequestBody requestBody)	Link a data processing purpose to a data processing description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrivacyOfficerResource

public PrivacyOfficerResource()

Default constructor

Method Details

linkPermittedProcessing

@PostMapping(path="/data-processing-purposes/{dataProcessingPurposeGUID}/permitted-processing/{dataProcessingDescriptionGUID}/attach")
public VoidResponse linkPermittedProcessing(@PathVariable
 String serverName,
 @PathVariable
 String dataProcessingPurposeGUID,
 @PathVariable
 String dataProcessingDescriptionGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Link a data processing purpose to a data processing description.

Parameters:

serverName - name of called server

dataProcessingPurposeGUID - unique identifier of the data processing purpose

dataProcessingDescriptionGUID - unique identifier of the data processing description

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachPermittedProcessing

@PostMapping(path="/data-processing-purposes/{dataProcessingPurposeGUID}/permitted-processing/{dataProcessingDescriptionGUID}/detach")
public VoidResponse detachPermittedProcessing(@PathVariable
 String serverName,
 @PathVariable
 String dataProcessingPurposeGUID,
 @PathVariable
 String dataProcessingDescriptionGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a data processing purpose from a data processing description.

Parameters:

serverName - name of called server

dataProcessingPurposeGUID - unique identifier of the data processing purpose

dataProcessingDescriptionGUID - unique identifier of the data processing description

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

linkDataProcessingTarget

@PostMapping(path="/data-processing-actions/{dataProcessingActionGUID}/targets/{targetGUID}/attach")
public VoidResponse linkDataProcessingTarget(@PathVariable
 String serverName,
 @PathVariable
 String dataProcessingActionGUID,
 @PathVariable
 String targetGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Link a data processing action to a target element.

Parameters:

serverName - name of called server

dataProcessingActionGUID - unique identifier of the data processing action

targetGUID - unique identifier of the target element

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachDataProcessingTarget

@PostMapping(path="/data-processing-actions/{dataProcessingActionGUID}/targets/{targetGUID}/detach")
public VoidResponse detachDataProcessingTarget(@PathVariable
 String serverName,
 @PathVariable
 String dataProcessingActionGUID,
 @PathVariable
 String targetGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a data processing action from a target element.

Parameters:

serverName - name of called server

dataProcessingActionGUID - unique identifier of the data processing action

targetGUID - unique identifier of the target element

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.