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 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.

    • linkDataProcessingSpecification

      @PostMapping(path="/elements/{elementGUID}/data-processing-specifications/{dataProcessingDescriptionGUID}/attach") public VoidResponse linkDataProcessingSpecification(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String dataProcessingDescriptionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a data processing description to the element that performs the processing.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element that performs the data processing
      dataProcessingDescriptionGUID - unique identifier of the data processing description
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachDataProcessingSpecification

      @PostMapping(path="/elements/{elementGUID}/data-processing-specifications/{dataProcessingDescriptionGUID}/detach") public VoidResponse detachDataProcessingSpecification(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String dataProcessingDescriptionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a data processing description from the element that performed the processing.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element that performs the data processing
      dataProcessingDescriptionGUID - unique identifier of the data processing description
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkDetailedProcessingAction

      @PostMapping(path="/data-processing-actions/{parentProcessingActionGUID}/detailed-processing-actions/{childProcessingActionGUID}/attach") public VoidResponse linkDetailedProcessingAction(@PathVariable String serverName, @PathVariable String parentProcessingActionGUID, @PathVariable String childProcessingActionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a child data processing action to its parent data processing action.
      Parameters:
      serverName - name of the server to route the request to
      parentProcessingActionGUID - unique identifier of the parent data processing action
      childProcessingActionGUID - unique identifier of the child data processing action
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachDetailedProcessingAction

      @PostMapping(path="/data-processing-actions/{parentProcessingActionGUID}/detailed-processing-actions/{childProcessingActionGUID}/detach") public VoidResponse detachDetailedProcessingAction(@PathVariable String serverName, @PathVariable String parentProcessingActionGUID, @PathVariable String childProcessingActionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a child data processing action from its parent data processing action.
      Parameters:
      serverName - name of the server to route the request to
      parentProcessingActionGUID - unique identifier of the parent data processing action
      childProcessingActionGUID - unique identifier of the child data processing action
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)