Package org.odpi.openmetadata.viewservices.classificationexplorer.server

Class ClassificationExplorerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.classificationexplorer.server.ClassificationExplorerRESTServices
public class ClassificationExplorerRESTServices extends TokenController
The ClassificationExplorerRESTServices provides the implementation of the Classification Explorer Open Metadata View Service (OMVS). This interface provides view interfaces for glossary UIs.

  • Constructor Details

    • ClassificationExplorerRESTServices

      public ClassificationExplorerRESTServices()
      Default constructor

  • Method Details

    • setImpactClassification

      public VoidResponse setImpactClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Classify/reclassify the element (typically a context event, to do or incident report) to indicate the level of impact that the event is expected to have on the organization The level of impact is expressed by the levelIdentifier property.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException the full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearImpactClassification

      public VoidResponse clearImpactClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the impact classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException the full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setConfidenceClassification

      public VoidResponse setConfidenceClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearConfidenceClassification

      public VoidResponse clearConfidenceClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setCriticalityClassification

      public VoidResponse setCriticalityClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearCriticalityClassification

      public VoidResponse clearCriticalityClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setConfidentialityClassification

      public VoidResponse setConfidentialityClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearConfidentialityClassification

      public VoidResponse clearConfidentialityClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setRetentionClassification

      public VoidResponse setRetentionClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearRetentionClassification

      public VoidResponse clearRetentionClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addGovernanceExpectations

      public VoidResponse addGovernanceExpectations(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Add the governance expectations classification to an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element to attach to
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateGovernanceExpectations

      public VoidResponse updateGovernanceExpectations(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody)
      Update the governance expectations classification to an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element to attach to
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearGovernanceExpectations

      public VoidResponse clearGovernanceExpectations(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the governance expectations classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addGovernanceMeasurements

      public VoidResponse addGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Add the governance measurements for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element to attach to
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateGovernanceMeasurements

      public VoidResponse updateGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody)
      Update the governance measurements for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element to attach to
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearGovernanceMeasurements

      public VoidResponse clearGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the governance measurements classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addDataScope

      public VoidResponse addDataScope(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Add the data scope for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element to attach to
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateDataScope

      public VoidResponse updateDataScope(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody)
      Update the data scope for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element to attach to
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearDataScope

      public VoidResponse clearDataScope(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the data scope classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSecurityTags

      public VoidResponse addSecurityTags(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Add the security tags for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element to attach to
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearSecurityTags

      public VoidResponse clearSecurityTags(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the security tags classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of element
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addOwnership

      public VoidResponse addOwnership(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Add the ownership classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearOwnership

      public VoidResponse clearOwnership(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the ownership classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - element where the classification needs to be cleared from.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addOrigin

      public VoidResponse addOrigin(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Add the DigitalResourceOrigin classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearOrigin

      public VoidResponse clearOrigin(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the DigitalResourceOrigin classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - element where the classification needs to be cleared from.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addZoneMembership

      public VoidResponse addZoneMembership(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Add the zone membership classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearZoneMembership

      public VoidResponse clearZoneMembership(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the zone membership classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - element where the classification needs to be cleared from.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setupSemanticAssignment

      public VoidResponse setupSemanticAssignment(String serverName, String urlMarker, String elementGUID, String glossaryTermGUID, NewRelationshipRequestBody requestBody)
      Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field, or asset). This relationship indicates that the data associated with the element meaning matches the description in the glossary term.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      glossaryTermGUID - unique identifier of the glossary term that provides the meaning
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearSemanticAssignment

      public VoidResponse clearSemanticAssignment(String serverName, String urlMarker, String elementGUID, String glossaryTermGUID, DeleteRelationshipRequestBody requestBody)
      Remove a semantic assignment relationship between an element and its glossary term.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      glossaryTermGUID - unique identifier of the glossary term that provides the meaning
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addScopeToElement

      public VoidResponse addScopeToElement(String serverName, String urlMarker, String elementGUID, String scopeGUID, NewRelationshipRequestBody requestBody)
      Link a scope to an element using the ScopedBy relationship.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to link
      scopeGUID - identifier of the scope to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeScopeFromElement

      public VoidResponse removeScopeFromElement(String serverName, String urlMarker, String elementGUID, String scopeGUID, DeleteRelationshipRequestBody requestBody)
      Remove the ScopedBy relationship between a scope and an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to update
      scopeGUID - identifier of the scope to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • assignActorToElement

      public VoidResponse assignActorToElement(String serverName, String urlMarker, String elementGUID, String actorGUID, NewRelationshipRequestBody requestBody)
      Attach an actor to an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to link
      actorGUID - identifier of the actor to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • unassignActorFromElement

      public VoidResponse unassignActorFromElement(String serverName, String urlMarker, String elementGUID, String actorGUID, DeleteRelationshipRequestBody requestBody)
      Detach an actor from an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to update
      actorGUID - identifier of the actor to detach
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addResourceListToElement

      public VoidResponse addResourceListToElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody)
      Link a resource to an element using the ResourceList relationship.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to link
      resourceGUID - identifier of the resource to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeResourceListFromElement

      public VoidResponse removeResourceListFromElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, DeleteRelationshipRequestBody requestBody)
      Remove the ResourceList relationship between a resource and an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to update
      resourceGUID - identifier of the resource to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addMoreInformationToElement

      public VoidResponse addMoreInformationToElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody)
      Link a resource to an element using the MoreInformation relationship.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to link
      resourceGUID - identifier of the resource to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeMoreInformationFromElement

      public VoidResponse removeMoreInformationFromElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, DeleteRelationshipRequestBody requestBody)
      Remove the MoreInformation relationship between a resource and an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to update
      resourceGUID - identifier of the resource to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSearchKeywordToElement

      public GUIDResponse addSearchKeywordToElement(String serverName, String urlMarker, String elementGUID, NewAttachmentRequestBody requestBody)
      Adds a search keyword to the element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      elementGUID - String - unique id for the element.
      requestBody - containing type of search keyword enum and the text of the search keyword.
      Returns:
      elementGUID for the new search keyword object or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - a problem adding the element properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateSearchKeyword

      public BooleanResponse updateSearchKeyword(String serverName, String urlMarker, String searchKeywordGUID, UpdateElementRequestBody requestBody)
      Update an existing search keyword.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      searchKeywordGUID - unique identifier for the search keyword to change.
      requestBody - containing type of search keyword enum and the text of the search keyword.
      Returns:
      void or InvalidParameterException - one of the parameters is null or invalid. PropertyServerException - a problem updating the element properties in the metadata repository. UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeSearchKeywordFromElement

      public VoidResponse removeSearchKeywordFromElement(String serverName, String urlMarker, String searchKeywordGUID, DeleteElementRequestBody requestBody)
      Removes a search keyword added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      searchKeywordGUID - String - unique id for the search keyword object
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - a problem updating the element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • setKnownDuplicateClassification

      public VoidResponse setKnownDuplicateClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Classify/reclassify the element with the KnownDuplicate classification
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearKnownDuplicateClassification

      public VoidResponse clearKnownDuplicateClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the KnownDuplicate classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • linkElementsAsPeerDuplicates

      public VoidResponse linkElementsAsPeerDuplicates(String serverName, String urlMarker, String elementGUID, String peerDuplicateGUID, NewRelationshipRequestBody requestBody)
      Create a relationship between two elements that show they represent the same "thing". If the relationship already exists, the properties are updated.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to link
      peerDuplicateGUID - identifier of the duplicate to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • unlinkElementsAsPeerDuplicates

      public VoidResponse unlinkElementsAsPeerDuplicates(String serverName, String urlMarker, String elementGUID, String peerDuplicateGUID, DeleteRelationshipRequestBody requestBody)
      Remove the PeerDuplicateLink relationship between an element and its duplicate.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to update
      peerDuplicateGUID - identifier of the duplicate to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setConsolidatedDuplicateClassification

      public VoidResponse setConsolidatedDuplicateClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)
      Classify/reclassify the element with the ConsolidatedDuplicate classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearConsolidatedDuplicateClassification

      public VoidResponse clearConsolidatedDuplicateClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the ConsolidatedDuplicate classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • linkConsolidatedDuplicateToSourceElement

      public VoidResponse linkConsolidatedDuplicateToSourceElement(String serverName, String urlMarker, String elementGUID, String sourceElementGUID, NewRelationshipRequestBody requestBody)
      Create a ConsolidatedDuplicateLink relationship between an element and one of the source elements of its properties.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that was created with the values from a number of duplicate elements
      sourceElementGUID - unique identifier of one of the source elements
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • unlinkConsolidatedDuplicateFromSourceElement

      public VoidResponse unlinkConsolidatedDuplicateFromSourceElement(String serverName, String urlMarker, String elementGUID, String sourceElementGUID, DeleteRelationshipRequestBody requestBody)
      Remove a ConsolidatedDuplicateLink relationship between an element and one of its source elements.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that was created with the values from a number of duplicate elements
      sourceElementGUID - unique identifier of one of the source elements
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException a full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getImpactClassifiedElements

      public OpenMetadataRootElementsResponse getImpactClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the impact classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getConfidenceClassifiedElements

      public OpenMetadataRootElementsResponse getConfidenceClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the confidence classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getCriticalityClassifiedElements

      public OpenMetadataRootElementsResponse getCriticalityClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the criticality classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getConfidentialityClassifiedElements

      public OpenMetadataRootElementsResponse getConfidentialityClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the confidentiality classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getRetentionClassifiedElements

      public OpenMetadataRootElementsResponse getRetentionClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the confidence classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getSecurityTaggedElements

      public OpenMetadataRootElementsResponse getSecurityTaggedElements(String serverName, String urlMarker, SecurityTagQueryProperties requestBody)
      Return information about the elements classified with the security tags classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getOwnersElements

      public OpenMetadataRootElementsResponse getOwnersElements(String serverName, String urlMarker, FilterRequestBody requestBody)
      Return information about the elements classified with the confidence classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getElementsByOrigin

      public OpenMetadataRootElementsResponse getElementsByOrigin(String serverName, String urlMarker, FindDigitalResourceOriginProperties requestBody)
      Return information about the elements from a specific origin.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getMeanings

      public OpenMetadataRootElementsResponse getMeanings(String serverName, String urlMarker, String elementGUID, SemanticAssignmentQueryProperties requestBody)
      Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      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

    • getSemanticAssignees

      public OpenMetadataRootElementsResponse getSemanticAssignees(String serverName, String urlMarker, String glossaryTermGUID, SemanticAssignmentQueryProperties requestBody)
      Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to
      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

      public OpenMetadataRootElementsResponse getGovernedElements(String serverName, String urlMarker, String governanceDefinitionGUID, ResultsRequestBody requestBody)
      Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      governanceDefinitionGUID - unique identifier of the governance definition that the returned elements are linked to
      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

    • getGovernedByDefinitions

      public OpenMetadataRootElementsResponse getGovernedByDefinitions(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getSourceElements

      public OpenMetadataRootElementsResponse getSourceElements(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Retrieve the elements linked via a "SourcedFrom" 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the governance definition that the returned elements are linked to
      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

    • getElementsSourcedFrom

      public OpenMetadataRootElementsResponse getElementsSourcedFrom(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Retrieve the elements linked via a "SourcedFrom" 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getScopes

      public OpenMetadataRootElementsResponse getScopes(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Retrieve the elements linked via a "ScopedBy" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getScopedElements

      public OpenMetadataRootElementsResponse getScopedElements(String serverName, String urlMarker, String scopeGUID, ResultsRequestBody requestBody)
      Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      scopeGUID - unique identifier of the element that the returned elements are linked to
      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

    • getResourceList

      public OpenMetadataRootElementsResponse getResourceList(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getSupportedByResource

      public OpenMetadataRootElementsResponse getSupportedByResource(String serverName, String urlMarker, String resourceGUID, ResultsRequestBody requestBody)
      Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      resourceGUID - unique identifier of the element that the returned elements are linked to
      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

    • getLicensedElements

      public OpenMetadataRootElementsResponse getLicensedElements(String serverName, String urlMarker, String licenseTypeGUID, ResultsRequestBody requestBody)
      Return information about the elements linked to a license type.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      licenseTypeGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getLicenses

      public OpenMetadataRootElementsResponse getLicenses(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Return information about the licenses linked to an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertifiedElements

      public OpenMetadataRootElementsResponse getCertifiedElements(String serverName, String urlMarker, String certificationTypeGUID, ResultsRequestBody requestBody)
      Return information about the elements linked to a certification type.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      certificationTypeGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertifications

      public OpenMetadataRootElementsResponse getCertifications(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Return information about the certifications linked to an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getMetadataElementByGUID

      public OpenMetadataRootElementResponse getMetadataElementByGUID(String serverName, String urlMarker, String elementGUID, GetRequestBody requestBody)
      Retrieve the metadata element using its unique identifier.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      elementGUID - unique identifier for the metadata element
      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 a problem accessing the metadata store

    • getMetadataElementByUniqueName

      public OpenMetadataRootElementResponse getMetadataElementByUniqueName(String serverName, String urlMarker, FindPropertyNameProperties requestBody)
      Retrieve the metadata element using its unique name (typically the qualified name).
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      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 a problem accessing the metadata store

    • getMetadataElementGUIDByUniqueName

      public GUIDResponse getMetadataElementGUIDByUniqueName(String serverName, String urlMarker, FindPropertyNameProperties 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
      urlMarker - view service URL marker
      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 a problem accessing the metadata store

    • getElements

      public OpenMetadataRootElementsResponse getElements(String serverName, String urlMarker, ResultsRequestBody requestBody)
      Retrieve elements of the requested type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • findRootElements

      public OpenMetadataRootElementsResponse findRootElements(String serverName, String urlMarker, FindRequestBody requestBody)
      Retrieve elements that match the complex query.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • getElementsByPropertyValue

      public OpenMetadataRootElementsResponse getElementsByPropertyValue(String serverName, String urlMarker, 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
      urlMarker - view service URL marker
      requestBody - properties and optional 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 a problem reported in the open metadata server(s)

    • findElementsByPropertyValue

      public OpenMetadataRootElementsResponse findElementsByPropertyValue(String serverName, String urlMarker, 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
      urlMarker - view service URL marker
      requestBody - properties and optional 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 a problem reported in the open metadata server(s)

    • findAuthoredElements

      public OpenMetadataRootElementsResponse findAuthoredElements(String serverName, String urlMarker, ContentStatusSearchString requestBody)
      Retrieve the authored elements that match the search string and optional status.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of elements InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getAuthoredElementsByCategory

      public OpenMetadataRootElementsResponse getAuthoredElementsByCategory(String serverName, String urlMarker, ContentStatusFilterRequestBody requestBody)
      Retrieve the authored elements that match the category name and status.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of elements InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getElementsByClassification

      public OpenMetadataRootElementsResponse getElementsByClassification(String serverName, String urlMarker, String classificationName, ResultsRequestBody 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
      urlMarker - view service URL marker
      classificationName - name of classification
      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 a problem reported in the open metadata server(s)

    • getElementsByClassificationWithPropertyValue

      public OpenMetadataRootElementsResponse getElementsByClassificationWithPropertyValue(String serverName, String urlMarker, String classificationName, 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
      urlMarker - view service URL marker
      classificationName - name of classification
      requestBody - properties and optional 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 a problem reported in the open metadata server(s)

    • findElementsByClassificationWithPropertyValue

      public OpenMetadataRootElementsResponse findElementsByClassificationWithPropertyValue(String serverName, String urlMarker, String classificationName, 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
      urlMarker - view service URL marker
      classificationName - name of classification
      requestBody - properties and optional 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 a problem reported in the open metadata server(s)

    • getRelatedElements

      public OpenMetadataRootElementsResponse getRelatedElements(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, ResultsRequestBody requestBody)
      Retrieve related elements of the requested type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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 - 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 a problem reported in the open metadata server(s)

    • getRelatedElementsWithPropertyValue

      public OpenMetadataRootElementsResponse getRelatedElementsWithPropertyValue(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, 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
      urlMarker - view service URL marker
      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
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • findRelatedElementsWithPropertyValue

      public OpenMetadataRootElementsResponse findRelatedElementsWithPropertyValue(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, FindPropertyNamesProperties requestBody)
      Retrieve elements linked via the requested relationship type name and with the relationship's properties specified. The value must be contained in one of the properties specified (or any property if no property names are specified). An open metadata type name may be supplied to restrict the linked elements that are matched.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getRelationships

      public MetadataRelationshipSummariesResponse getRelationships(String serverName, String urlMarker, String relationshipTypeName, ResultsRequestBody requestBody)
      Retrieve relationships of the requested relationship type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      relationshipTypeName - name of relationship
      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 a problem reported in the open metadata server(s)

    • getRelationshipsWithPropertyValue

      public MetadataRelationshipSummariesResponse getRelationshipsWithPropertyValue(String serverName, String urlMarker, String relationshipTypeName, 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
      urlMarker - view service URL marker
      requestBody - properties and optional 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 a problem reported in the open metadata server(s)

    • findRelationshipsWithPropertyValue

      public MetadataRelationshipSummariesResponse findRelationshipsWithPropertyValue(String serverName, String urlMarker, String relationshipTypeName, 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
      urlMarker - view service URL marker
      relationshipTypeName - name of relationship
      requestBody - properties and optional 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 a problem reported in the open metadata server(s)

    • retrieveInstanceForGUID

      public ElementHeaderResponse retrieveInstanceForGUID(String serverName, String urlMarker, String guid, GetRequestBody 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
      urlMarker - view service URL marker
      guid - identifier to use in the lookup
      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 a problem reported in the open metadata server(s)

    • getElementsByCategory

      public OpenMetadataRootElementsResponse getElementsByCategory(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of elements with the named category.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • getSearchKeywordByGUID

      public OpenMetadataRootElementResponse getSearchKeywordByGUID(String serverName, String urlMarker, String searchKeywordGUID, GetRequestBody requestBody)
      Return the requested search keyword.
      Parameters:
      serverName - name of the server instances for this request
      searchKeywordGUID - unique identifier for the search keyword object.
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      search keyword properties or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.

    • getSearchKeywordsByKeyword

      public OpenMetadataRootElementsResponse getSearchKeywordsByKeyword(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of search keyword metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • findSearchKeywords

      public OpenMetadataRootElementsResponse findSearchKeywords(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of search keyword metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)