Package org.odpi.openmetadata.accessservices.assetmanager.server.spring

Class StewardshipExchangeResource

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.server.spring.StewardshipExchangeResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-manager/users/{userId}") public class StewardshipExchangeResource extends Object
The StewardshipExchangeResource provides part of the server-side implementation of the Asset Manager Open Metadata Assess Service (OMAS). This interface provides the ability to add governance related classifications and relationship to elements.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StewardshipExchangeResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addAssetOrigin(String serverName, String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Add or replace the origin classification for an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addElementToSubjectArea(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Classify the element to assert that the definitions it represents are part of a subject area definition.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addGovernanceDefinitionToElement(String serverName, String userId, String definitionGUID, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.RelationshipRequestBody requestBody)
    Link a governance definition to an element using the GovernedBy relationship.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addOwnership(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Add or replace the ownership classification for an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSecurityTags(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Add or replace the security tags for an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAssetOrigin(String serverName, String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the origin classification from an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearConfidenceClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the confidence classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearConfidentialityClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the confidence classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearCriticalityClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the criticality classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearDataFieldClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the data field classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearOwnership(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the ownership classification from an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearRetentionClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the retention classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearSemanticAssignment(String serverName, String userId, String elementGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Remove a semantic assignment relationship between an element and its glossary term.
    org.odpi.openmetadata.accessservices.assetmanager.rest.AssetElementsResponse
    getAssetsByOrigin(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.FindByPropertiesRequestBody requestBody)
    Return information about the assets from a specific origin.
    org.odpi.openmetadata.commonservices.ffdc.rest.ElementStubsResponse
    getDataFieldClassifiedElements(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the data field classification.
    org.odpi.openmetadata.commonservices.ffdc.rest.RelatedElementsResponse
    getElementsSourceFrom(String serverName, String userId, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the elements linked via a "SourceFrom" relationship to the requested element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GovernanceDefinitionsResponse
    getGovernedByDefinitions(String serverName, String userId, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
    org.odpi.openmetadata.commonservices.ffdc.rest.RelatedElementsResponse
    getGovernedElements(String serverName, String userId, String governanceDefinitionGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse
    getMeanings(String serverName, String userId, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
    org.odpi.openmetadata.commonservices.ffdc.rest.ElementStubsResponse
    getMembersOfSubjectArea(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the security tags classification.
    org.odpi.openmetadata.commonservices.ffdc.rest.RelatedElementsResponse
    getSemanticAssignees(String serverName, String userId, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
    org.odpi.openmetadata.commonservices.ffdc.rest.RelatedElementsResponse
    getSourceElements(String serverName, String userId, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the elements linked via a "SourceFrom" relationship to the requested element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeElementFromSubjectArea(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the subject area designation from the identified element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeGovernanceDefinitionFromElement(String serverName, String userId, String definitionGUID, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Remove the GovernedBy relationship between a governance definition and an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeSecurityTags(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Remove the security tags classification from an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setConfidenceClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setConfidentialityClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setCriticalityClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setDataFieldClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
    Classify the element to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setRetentionClassification(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupSemanticAssignment(String serverName, String userId, String elementGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.RelationshipRequestBody requestBody)
    Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StewardshipExchangeResource

      public StewardshipExchangeResource()
      Default constructor

  • Method Details

    • setDataFieldClassification

      @PostMapping(path="/elements/{elementGUID}/data-field") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setDataFieldClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Classify the element to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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

    • clearDataFieldClassification

      @PostMapping(path="/elements/{elementGUID}/data-field/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearDataFieldClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Remove the data field classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier of the metadata element to unclassify
      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

    • getDataFieldClassifiedElements

      @PostMapping(path="/elements/by-data-field") public org.odpi.openmetadata.commonservices.ffdc.rest.ElementStubsResponse getDataFieldClassifiedElements(@PathVariable String serverName, @PathVariable String userId, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the data field classification.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      classified elements 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setConfidenceClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.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
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearConfidenceClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody 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
      userId - calling user
      elementGUID - unique identifier of the metadata element to unclassify
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setCriticalityClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.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
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearCriticalityClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody 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
      userId - calling user
      elementGUID - unique identifier of the metadata element to unclassify
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setConfidentialityClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.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
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearConfidentialityClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody 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
      userId - calling user
      elementGUID - unique identifier of the metadata element to unclassify
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setRetentionClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.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
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearRetentionClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody 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
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Add or replace the security tags for an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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

    • removeSecurityTags

      @PostMapping(path="/elements/{elementGUID}/security-tags/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Remove the security tags classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addOwnership(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Add or replace the ownership classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearOwnership(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Remove the ownership classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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

    • addAssetOrigin

      @PostMapping(path="/assets/{assetGUID}/origin") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addAssetOrigin(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Add or replace the origin classification for an asset.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - element to link it to - its type must inherit from Asset.
      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

    • clearAssetOrigin

      @PostMapping(path="/assets/{assetGUID}/origin/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAssetOrigin(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Remove the origin classification from an asset.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - 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

    • getAssetsByOrigin

      @PostMapping(path="/asset/by-origin") public org.odpi.openmetadata.accessservices.assetmanager.rest.AssetElementsResponse getAssetsByOrigin(@PathVariable String serverName, @PathVariable String userId, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.FindByPropertiesRequestBody requestBody)
      Return information about the assets from a specific origin.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      classified elements 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addElementToSubjectArea(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.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
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeElementFromSubjectArea(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ClassificationRequestBody requestBody)
      Remove the subject area designation from the identified element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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

    • getMembersOfSubjectArea

      @PostMapping(path="/elements/by-subject-area-membership") public org.odpi.openmetadata.commonservices.ffdc.rest.ElementStubsResponse getMembersOfSubjectArea(@PathVariable String serverName, @PathVariable String userId, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the security tags classification.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the request
      Returns:
      classified elements 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Remove a semantic assignment relationship between an element and its glossary term.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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

    • getMeanings

      @PostMapping("/glossaries/terms/by-semantic-assignment/{elementGUID}") public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse getMeanings(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getSemanticAssignees

      @PostMapping("/elements/by-semantic-assignment/{glossaryTermGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.RelatedElementsResponse getSemanticAssignees(@PathVariable String serverName, @PathVariable String userId, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      linked elements 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addGovernanceDefinitionToElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String definitionGUID, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.RelationshipRequestBody requestBody)
      Link a governance definition to an element using the GovernedBy relationship.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeGovernanceDefinitionFromElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String definitionGUID, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Remove the GovernedBy relationship between a governance definition and an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      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

    • getGovernedElements

      @PostMapping(path="/elements/governed-by/{governanceDefinitionGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.RelatedElementsResponse getGovernedElements(@PathVariable String serverName, @PathVariable String userId, @PathVariable String governanceDefinitionGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDefinitionGUID - unique identifier of the governance definition that the returned elements are linked to
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getGovernedByDefinitions

      @PostMapping(path="/elements/{elementGUID}/governed-by") public org.odpi.openmetadata.accessservices.assetmanager.rest.GovernanceDefinitionsResponse getGovernedByDefinitions(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier of the element that the returned elements are linked to
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getSourceElements

      @PostMapping(path="/elements/sourced-from/{elementGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.RelatedElementsResponse getSourceElements(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were used to create the requested element. Typically only one element is returned.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier of the element that the returned elements are linked to
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getElementsSourceFrom

      @PostMapping(path="/elements/{elementGUID}/sourced-from") public org.odpi.openmetadata.commonservices.ffdc.rest.RelatedElementsResponse getElementsSourceFrom(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were created using the requested element as a template.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier of the element that the returned elements are linked to
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem