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

Class ClassificationManagerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.classificationmanager.server.ClassificationManagerRESTServices
public class ClassificationManagerRESTServices extends org.odpi.openmetadata.tokencontroller.TokenController
The ClassificationManagerRESTServices provides the implementation of the Classification ManagerOpen Metadata View Service (OMVS). This interface provides view interfaces for infrastructure and ops users.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClassificationManagerRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addElementToSubjectArea(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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 definitionGUID, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
    Link a governance definition to an element using the GovernedBy relationship.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addOwnership(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
    Add or replace the ownership classification for an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSecurityTags(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
    Add or replace the security tags for an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearConfidenceClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
    Remove the confidence classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearConfidentialityClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
    Remove the confidence classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearCriticalityClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
    Remove the criticality classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearOwnership(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
    Remove the ownership classification from an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearRetentionClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
    Remove the retention classification from the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearSecurityTags(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
    Remove the security tags classification from an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearSemanticAssignment(String serverName, String elementGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Remove a semantic assignment relationship between an element and its glossary term.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse
    findElementsByClassificationWithPropertyValue(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
    Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse
    findElementsByPropertyValue(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
    Retrieve elements by a value found in one of the properties specified.
    org.odpi.openmetadata.commonservices.ffdc.rest.RelatedMetadataElementSummariesResponse
    findRelatedElementsWithPropertyValue(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
    Retrieve elements linked via the requested relationship type name and with the relationship's properties specified.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataRelationshipSummariesResponse
    findRelationshipsWithPropertyValue(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
    Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse
    getElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties requestBody)
    Retrieve elements of the requested type name.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse
    getElementsByClassification(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties requestBody)
    Retrieve elements with the requested classification name.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse
    getElementsByClassificationWithPropertyValue(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
    Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse
    getElementsByPropertyValue(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
    Retrieve elements by a value found in one of the properties specified.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummaryResponse
    getMetadataElementByGUID(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the metadata element using its unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummaryResponse
    getMetadataElementByUniqueName(String serverName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the metadata element using its unique name (typically the qualified name).
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    getMetadataElementGUIDByUniqueName(String serverName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
    org.odpi.openmetadata.commonservices.ffdc.rest.RelatedMetadataElementSummariesResponse
    getRelatedElements(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties requestBody)
    Retrieve related elements of the requested type name.
    org.odpi.openmetadata.commonservices.ffdc.rest.RelatedMetadataElementSummariesResponse
    getRelatedElementsWithPropertyValue(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
    Retrieve elements linked via the requested relationship type name and with the requested a value found in one of the classification's properties specified.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataRelationshipSummariesResponse
    getRelationships(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties requestBody)
    Retrieve relationships of the requested relationship type name.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataRelationshipSummariesResponse
    getRelationshipsWithPropertyValue(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
    Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeElementFromSubjectArea(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
    Remove the subject area designation from the identified element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeGovernanceDefinitionFromElement(String serverName, String definitionGUID, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Remove the GovernedBy relationship between a governance definition and an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.ElementHeaderResponse
    retrieveInstanceForGUID(String serverName, String guid, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
    Retrieve the header for the instance identified by the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setConfidenceClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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 elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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 elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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
    setRetentionClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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 elementGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, 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

    • ClassificationManagerRESTServices

      public ClassificationManagerRESTServices()
      Default constructor

  • Method Details

    • setConfidenceClassification

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setConfidenceClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearConfidenceClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody 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 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setCriticalityClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearCriticalityClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody 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 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setConfidentialityClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearConfidentialityClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody 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 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setRetentionClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearRetentionClassification(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody 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 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

    • addSecurityTags

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSecurityTags(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearSecurityTags(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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 - 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

    • addOwnership

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addOwnership(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearOwnership(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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 cleared from.
      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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addElementToSubjectArea(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeElementFromSubjectArea(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupSemanticAssignment(String serverName, String elementGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearSemanticAssignment(String serverName, String elementGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addGovernanceDefinitionToElement(String serverName, String definitionGUID, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeGovernanceDefinitionFromElement(String serverName, String definitionGUID, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, 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

    • getMetadataElementByGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummaryResponse getMetadataElementByGUID(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the metadata element using its unique identifier.
      Parameters:
      serverName - name of server instance to route request to
      elementGUID - unique identifier for the metadata element
      forLineage - the retrieved element is for lineage processing so include archived elements
      forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
      requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
      Returns:
      metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store

    • getMetadataElementByUniqueName

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummaryResponse getMetadataElementByUniqueName(String serverName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the metadata element using its unique name (typically the qualified name).
      Parameters:
      serverName - name of server instance to route request to
      forLineage - the retrieved element is for lineage processing so include archived elements
      forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
      requestBody - unique name for the metadata element
      Returns:
      metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store

    • getMetadataElementGUIDByUniqueName

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse getMetadataElementGUIDByUniqueName(String serverName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
      Parameters:
      serverName - name of server instance to route request to
      forLineage - the retrieved element is for lineage processing so include archived elements
      forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
      requestBody - unique name for the metadata element
      Returns:
      metadata element unique identifier (guid) or InvalidParameterException the unique identifier is null or not known or UserNotAuthorizedException the governance action service is not able to access the element or PropertyServerException there is a problem accessing the metadata store

    • getElements

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse getElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties requestBody)
      Retrieve elements of the requested type name.
      Parameters:
      serverName - name of the server instance to connect 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 - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByPropertyValue

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse getElementsByPropertyValue(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
      Retrieve elements by a value found in one of the properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      requestBody - properties and optional open metadata type to search on
      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?
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findElementsByPropertyValue

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse findElementsByPropertyValue(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
      Retrieve elements by a value found in one of the properties specified. The value must be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      requestBody - properties and optional open metadata type to search on
      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?
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByClassification

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse getElementsByClassification(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties requestBody)
      Retrieve elements with the requested classification name. It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of element may be returned.
      Parameters:
      serverName - name of the server instance to connect to
      classificationName - name of classification
      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 - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByClassificationWithPropertyValue

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse getElementsByClassificationWithPropertyValue(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
      Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.
      Parameters:
      serverName - name of the server instance to connect to
      classificationName - name of classification
      requestBody - properties and optional open metadata type to search on
      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?
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findElementsByClassificationWithPropertyValue

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataElementSummariesResponse findElementsByClassificationWithPropertyValue(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
      Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      classificationName - name of classification
      requestBody - properties and optional open metadata type to search on
      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?
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelatedElements

      public org.odpi.openmetadata.commonservices.ffdc.rest.RelatedMetadataElementSummariesResponse getRelatedElements(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties requestBody)
      Retrieve related elements of the requested type name.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      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 - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelatedElementsWithPropertyValue

      public org.odpi.openmetadata.commonservices.ffdc.rest.RelatedMetadataElementSummariesResponse getRelatedElementsWithPropertyValue(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
      Retrieve elements linked via the requested relationship type name and with the requested a value found in one of the classification's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - properties and optional open metadata type to search on
      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?
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findRelatedElementsWithPropertyValue

      public org.odpi.openmetadata.commonservices.ffdc.rest.RelatedMetadataElementSummariesResponse findRelatedElementsWithPropertyValue(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
      Retrieve elements linked via the requested relationship type name and with the relationship's properties specified. The value must be contained in the by a value found in one of the properties specified. The value must be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - properties and optional open metadata type to search on
      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?
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelationships

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataRelationshipSummariesResponse getRelationships(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties requestBody)
      Retrieve relationships of the requested relationship type name.
      Parameters:
      serverName - name of the server instance to connect to
      relationshipTypeName - name of relationship
      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 - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelationshipsWithPropertyValue

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataRelationshipSummariesResponse getRelationshipsWithPropertyValue(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
      Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must match exactly.
      Parameters:
      serverName - name of the server instance to connect to
      relationshipTypeName - name of relationship
      requestBody - properties and optional open metadata type to search on
      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?
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findRelationshipsWithPropertyValue

      public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataRelationshipSummariesResponse findRelationshipsWithPropertyValue(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.openmetadata.properties.FindPropertyNamesProperties requestBody)
      Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must only be contained in the properties rather than needing to be an exact match.
      Parameters:
      serverName - name of the server instance to connect to
      relationshipTypeName - name of relationship
      requestBody - properties and optional open metadata type to search on
      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?
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • retrieveInstanceForGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.ElementHeaderResponse retrieveInstanceForGUID(String serverName, String guid, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
      Retrieve the header for the instance identified by the supplied unique identifier. It may be an element (entity) or a relationship between elements.
      Parameters:
      serverName - name of the server instance to connect to
      guid - identifier to use in the lookup
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - effective time
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)