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

    • setImpactClassification

      @PostMapping(path="/elements/{elementGUID}/impact") public VoidResponse setImpactClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify the element to indicate the level of impact it is having or likely to have on the organization. The level of impact 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
      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

    • clearImpactClassification

      @PostMapping(path="/elements/{elementGUID}/impact/remove") public VoidResponse clearImpactClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Remove the impact classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      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

    • setConfidenceClassification

      @PostMapping(path="/elements/{elementGUID}/confidence") public VoidResponse setConfidenceClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify 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
      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, @RequestBody(required=false) MetadataSourceRequestBody 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
      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, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify 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
      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, @RequestBody(required=false) MetadataSourceRequestBody 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
      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, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify 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
      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, @RequestBody(required=false) MetadataSourceRequestBody 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
      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, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify 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
      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, @RequestBody(required=false) MetadataSourceRequestBody 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
      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

    • addGovernanceExpectations

      @PostMapping(path="/elements/{elementGUID}/governance-expectations") public VoidResponse addGovernanceExpectations(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Add the governance expectations classification to an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      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

    • updateGovernanceExpectations

      @PostMapping(path="/elements/{elementGUID}/governance-expectations/update") public VoidResponse updateGovernanceExpectations(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) UpdateClassificationRequestBody requestBody)
      Update the governance expectations classification to an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      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

    • clearGovernanceExpectations

      @PostMapping(path="/elements/{elementGUID}/governance-expectations/remove") public VoidResponse clearGovernanceExpectations(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Remove the governance expectations classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element
      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

    • addGovernanceMeasurements

      @PostMapping(path="/elements/{elementGUID}/governance-measurements") public VoidResponse addGovernanceMeasurements(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Add the governance measurements classification to an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      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

    • updateGovernanceMeasurements

      @PostMapping(path="/elements/{elementGUID}/governance-measurements/update") public VoidResponse updateGovernanceMeasurements(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) UpdateClassificationRequestBody requestBody)
      Update the governance measurements classification to an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      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

    • clearGovernanceMeasurements

      @PostMapping(path="/elements/{elementGUID}/governance-measurements/remove") public VoidResponse clearGovernanceMeasurements(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Remove the governance measurements classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element
      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

    • addSecurityTags

      @PostMapping(path="/elements/{elementGUID}/security-tags") public VoidResponse addSecurityTags(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Add the security tags for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      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, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Remove the security tags classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element
      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, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Add 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.
      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, @RequestBody(required=false) MetadataSourceRequestBody 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.
      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

    • addDigitalResourceOrigin

      @PostMapping(path="/elements/{elementGUID}/digital-resource-origin") public VoidResponse addDigitalResourceOrigin(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Add the digital resource origin 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.
      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

    • clearDigitalResourceOrigin

      @PostMapping(path="/elements/{elementGUID}/digital-resource-origin/remove") public VoidResponse clearDigitalResourceOrigin(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Remove the digital resource origin classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element where the classification needs to be removed.
      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

    • addZoneMembership

      @PostMapping(path="/elements/{elementGUID}/zone-membership") public VoidResponse addZoneMembership(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Add the zone membership 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.
      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

    • clearZoneMembership

      @PostMapping(path="/elements/{elementGUID}/zone-membership/remove") public VoidResponse clearZoneMembership(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) MetadataSourceRequestBody 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.
      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, @RequestBody(required=false) NewRelationshipRequestBody 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
      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, @RequestBody(required=false) DeleteRequestBody 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
      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

    • addScopeToElement

      @PostMapping(path="/elements/{elementGUID}/scoped-by/{scopeGUID}") public VoidResponse addScopeToElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String scopeGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Link a scope to an element using the ScopedBy relationship.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to link
      scopeGUID - identifier of the scope to link
      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

    • removeScopeFromElement

      @PostMapping(path="/elements/{elementGUID}/scoped-by/{scopeGUID}/remove") public VoidResponse removeScopeFromElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String scopeGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Remove the ScopedBy relationship between a scope and an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      scopeGUID - identifier of the scope to link
      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

    • addResourceListToElement

      @PostMapping(path="/elements/{elementGUID}/resource-list/{resourceGUID}") public VoidResponse addResourceListToElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String resourceGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Link a resource to an element using the ResourceList relationship.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to link
      resourceGUID - identifier of the resource to link
      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

    • removeResourceListFromElement

      @PostMapping(path="/elements/{elementGUID}/resource-list/{resourceGUID}/remove") public VoidResponse removeResourceListFromElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String resourceGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Remove the ResourceList relationship between a resource and an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      resourceGUID - identifier of the resource to link
      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

    • addMoreInformationToElement

      @PostMapping(path="/elements/{elementGUID}/more-information/{resourceGUID}") public VoidResponse addMoreInformationToElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String resourceGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Link a resource to an element using the MoreInformation relationship.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to link
      resourceGUID - identifier of the resource to link
      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

    • removeMoreInformationFromElement

      @PostMapping(path="/elements/{elementGUID}/more-information/{resourceGUID}/remove") public VoidResponse removeMoreInformationFromElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String resourceGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Remove the MoreInformation relationship between a resource and an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      resourceGUID - identifier of the resource to link
      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