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

Class ClassificationManagerResource

java.lang.Object
org.odpi.openmetadata.viewservices.classificationmanager.server.spring.ClassificationManagerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/classification-manager") public class ClassificationManagerResource extends Object
The ClassificationManagerResource provides the Spring API endpoints of the Classification Manager Open Metadata View Service (OMVS). This interface provides a service for Egeria UIs.

  • Constructor Details

    • ClassificationManagerResource

      public ClassificationManagerResource()
      Default constructor

  • Method Details

    • setConfidenceClassification

      @PostMapping(path="/elements/{elementGUID}/confidence") public VoidResponse setConfidenceClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Classify/reclassify the element (typically an asset) to indicate the level of confidence that the organization has that the data is complete, accurate and up-to-date. The level of confidence is expressed by the levelIdentifier property.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearConfidenceClassification

      @PostMapping(path="/elements/{elementGUID}/confidence/remove") public VoidResponse clearConfidenceClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ResultsRequestBody requestBody)
      Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidence to assign to the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setCriticalityClassification

      @PostMapping(path="/elements/{elementGUID}/criticality") public VoidResponse setCriticalityClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization. The level of criticality is expressed by the levelIdentifier property.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearCriticalityClassification

      @PostMapping(path="/elements/{elementGUID}/criticality/remove") public VoidResponse clearCriticalityClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ResultsRequestBody requestBody)
      Remove the criticality classification from the element. This normally occurs when the organization has lost track of the level of criticality to assign to the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setConfidentialityClassification

      @PostMapping(path="/elements/{elementGUID}/confidentiality") public VoidResponse setConfidentialityClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Classify/reclassify the element (typically a data field, schema attribute or glossary term) to indicate the level of confidentiality that any data associated with the element should be given. If the classification is attached to a glossary term, the level of confidentiality is a suggestion for any element linked to the glossary term via the SemanticAssignment classification. The level of confidence is expressed by the levelIdentifier property.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearConfidentialityClassification

      @PostMapping(path="/elements/{elementGUID}/confidentiality/remove") public VoidResponse clearConfidentialityClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ResultsRequestBody requestBody)
      Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidentiality to assign to the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setRetentionClassification

      @PostMapping(path="/elements/{elementGUID}/retention") public VoidResponse setRetentionClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Classify/reclassify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization. The policy to apply to the element/resource is captured by the retentionBasis property. The dates after which the element/resource is archived and then deleted are specified in the archiveAfter and deleteAfter properties respectively.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearRetentionClassification

      @PostMapping(path="/elements/{elementGUID}/retention/remove") public VoidResponse clearRetentionClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ResultsRequestBody requestBody)
      Remove the retention classification from the element. This normally occurs when the organization has lost track of, or no longer needs to track the retention period to assign to the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSecurityTags

      @PostMapping(path="/elements/{elementGUID}/security-tags") public VoidResponse addSecurityTags(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Add or replace the security tags for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearSecurityTags

      @PostMapping(path="/elements/{elementGUID}/security-tags/remove") public VoidResponse clearSecurityTags(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Remove the security tags classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - null request body
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addOwnership

      @PostMapping(path="/elements/{elementGUID}/ownership") public VoidResponse addOwnership(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Add or replace the ownership classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element to link it to - its type must inherit from Referenceable.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearOwnership

      @PostMapping(path="/elements/{elementGUID}/ownership/remove") public VoidResponse clearOwnership(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Remove the ownership classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element where the classification needs to be removed.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addElementToSubjectArea

      @PostMapping(path="/elements/{elementGUID}/subject-area-member") public VoidResponse addElementToSubjectArea(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Classify the element to assert that the definitions it represents are part of a subject area definition.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeElementFromSubjectArea

      @PostMapping(path="/elements/{elementGUID}/subject-area-member/remove") public VoidResponse removeElementFromSubjectArea(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody)
      Remove the subject area designation from the identified element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setupSemanticAssignment

      @PostMapping(path="/elements/{elementGUID}/semantic-assignment/terms/{glossaryTermGUID}") public VoidResponse setupSemanticAssignment(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset). This relationship indicates that the data associated with the element meaning matches the description in the glossary term.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      glossaryTermGUID - unique identifier of the glossary term that provides the meaning
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearSemanticAssignment

      @PostMapping(path="/elements/{elementGUID}/semantic-assignment/terms/{glossaryTermGUID}/remove") public VoidResponse clearSemanticAssignment(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Remove a semantic assignment relationship between an element and its glossary term.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      glossaryTermGUID - unique identifier of the glossary term that provides the meaning
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addGovernanceDefinitionToElement

      @PostMapping(path="/elements/{elementGUID}/governed-by/definition/{definitionGUID}") public VoidResponse addGovernanceDefinitionToElement(@PathVariable String serverName, @PathVariable String definitionGUID, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Link a governance definition to an element using the GovernedBy relationship.
      Parameters:
      serverName - name of the server instance to connect to
      definitionGUID - identifier of the governance definition to link
      elementGUID - unique identifier of the metadata element to link
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeGovernanceDefinitionFromElement

      @PostMapping(path="/elements/{elementGUID}/governed-by/definition/{definitionGUID}/remove") public VoidResponse removeGovernanceDefinitionFromElement(@PathVariable String serverName, @PathVariable String definitionGUID, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Remove the GovernedBy relationship between a governance definition and an element.
      Parameters:
      serverName - name of the server instance to connect to
      definitionGUID - identifier of the governance definition to link
      elementGUID - unique identifier of the metadata element to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem