Package org.odpi.openmetadata.viewservices.glossarybrowser.server

Class GlossaryBrowserRESTServices

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    GlossaryBrowserRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addCommentReply(String serverName, String commentGUID, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
    Adds a reply to a comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addCommentToElement(String serverName, String guid, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
    Adds a comment to the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addLikeToElement(String serverName, String guid, boolean isPublic, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Adds a "LikeProperties" to the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addRatingToElement(String serverName, String guid, boolean isPublic, org.odpi.openmetadata.accessservices.assetmanager.properties.RatingProperties requestBody)
    Adds a star rating and optional review text to the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addTagToElement(String serverName, String elementGUID, String tagGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.FeedbackProperties requestBody)
    Adds a tag (either private of public) to an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAcceptedAnswer(String serverName, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Unlink a comment that contains an answer to a question posed in another comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createInformalTag(String serverName, org.odpi.openmetadata.accessservices.assetmanager.properties.TagProperties requestBody)
    Creates a new informal tag and returns the unique identifier for it.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deleteTag(String serverName, String tagGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Removes a tag from the repository.
    org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementsResponse
    findComments(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of comment metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementsResponse
    findGlossaries(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of glossary metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse
    findGlossaryCategories(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody)
    Retrieve the list of glossary category metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse
    findGlossaryTerms(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody)
    Retrieve the list of glossary term metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse
    findMyTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Return the list of the calling user's private tags containing the supplied string in either the name or description.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse
    findNoteLogs(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of note log metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementsResponse
    findNotes(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of note metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse
    findTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Return the list of tags containing the supplied string in either the name or description.
    org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementsResponse
    getAttachedComments(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Return the comments attached to an element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse
    getCategoriesForGlossary(String serverName, String glossaryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Return the list of categories associated with a glossary.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse
    getCategoriesForTerm(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Return the list of categories associated with a glossary term.
    org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementResponse
    getCommentByGUID(String serverName, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Return the requested comment.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse
    getConfidenceClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the confidence classification.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse
    getConfidentialityClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the confidentiality classification.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse
    getCriticalityClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the criticality classification.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse
    getDataFieldClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the data field classification.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse
    getElementsByTag(String serverName, String tagGUID, int startFrom, int pageSize)
    Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.
    org.odpi.openmetadata.accessservices.assetmanager.rest.RelatedElementsResponse
    getElementsSourceFrom(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the elements linked via a "SourceFrom" relationship to the requested element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementsResponse
    getGlossariesByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the list of glossary metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementResponse
    getGlossaryByGUID(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse
    getGlossaryCategoriesByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody)
    Retrieve the list of glossary category metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementResponse
    getGlossaryCategoryByGUID(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary category metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementResponse
    getGlossaryCategoryParent(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary category metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementResponse
    getGlossaryForCategory(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary metadata element for the requested category.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementResponse
    getGlossaryForTerm(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary metadata element for the requested term.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse
    getGlossarySubCategories(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary category metadata element with the supplied unique identifier.
    GlossaryTermActivityTypeListResponse
    getGlossaryTermActivityTypes(String serverName)
    Return the list of glossary term activity types enum values.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementResponse
    getGlossaryTermByGUID(String serverName, String guid, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary term metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse
    getGlossaryTermHistory(String serverName, String guid, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryRequestBody requestBody)
    Retrieve all the versions of a glossary term.
    GlossaryTermRelationshipStatusListResponse
    getGlossaryTermRelationshipStatuses(String serverName)
    Return the list of glossary term relationship status enum values.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse
    getGlossaryTermsByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody)
    Retrieve the list of glossary term metadata elements with a matching qualified or display name.
    GlossaryTermStatusListResponse
    getGlossaryTermStatuses(String serverName)
    Return the list of glossary term status enum values.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GovernanceDefinitionsResponse
    getGovernedByDefinitions(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
    org.odpi.openmetadata.accessservices.assetmanager.rest.RelatedElementsResponse
    getGovernedElements(String serverName, String governanceDefinitionGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse
    getMeanings(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse
    getMembersOfSubjectArea(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the confidence classification.
    org.odpi.openmetadata.frameworkservices.gaf.rest.OpenMetadataElementResponse
    getMetadataElementByGUID(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)
    Retrieve the metadata element using its unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse
    getMyTagsByName(String serverName, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Return the list of the calling user's private tags exactly matching the supplied name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementResponse
    getNoteByGUID(String serverName, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the note metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementResponse
    getNoteLogByGUID(String serverName, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the note log metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse
    getNoteLogsByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the list of note log metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse
    getNoteLogsForElement(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the list of note log metadata elements attached to the element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementsResponse
    getNotesForNoteLog(String serverName, String noteLogGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the list of notes associated with a note log.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse
    getOwnersElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the confidence classification.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse
    getRelatedTerms(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermRelationshipRequestBody requestBody)
    Retrieve the list of glossary terms associated with the requested term.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse
    getRetentionClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the confidence classification.
    org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse
    getSecurityTaggedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
    Return information about the elements classified with the security tags classification.
    org.odpi.openmetadata.accessservices.assetmanager.rest.RelatedElementsResponse
    getSemanticAssignees(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.RelatedElementsResponse
    getSourceElements(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the elements linked via a "SourceFrom" relationship to the requested element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagResponse
    getTag(String serverName, String guid)
    Return the tag for the supplied unique identifier (guid).
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse
    getTagsByName(String serverName, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Return the list of tags exactly matching the supplied name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse
    getTermsForGlossary(String serverName, String glossaryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
    Retrieve the list of glossary terms associated with a glossary.
    org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse
    getTermsForGlossaryCategory(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermRelationshipRequestBody requestBody)
    Retrieve the list of glossary terms associated with a glossary category.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeCommentFromElement(String serverName, String elementGUID, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
    Removes a comment added to the element by this user.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeLikeFromElement(String serverName, String guid, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Removes a "LikeProperties" added to the element by this user.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeRatingFromElement(String serverName, String guid, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Removes a star rating that was added to the element by this user.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeTagFromElement(String serverName, String elementGUID, String tagGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Removes a tag from the element that was added by this user.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupAcceptedAnswer(String serverName, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
    Link a comment that contains the best answer to a question posed in another comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateComment(String serverName, String commentGUID, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
    Update an existing comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateTagDescription(String serverName, String tagGUID, InformalTagUpdateRequestBody requestBody)
    Updates the description of an existing tag (either private or public).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GlossaryBrowserRESTServices

      public GlossaryBrowserRESTServices()
      Default constructor

  • Method Details

    • getMetadataElementByGUID

      public org.odpi.openmetadata.frameworkservices.gaf.rest.OpenMetadataElementResponse getMetadataElementByGUID(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)
      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.
      effectiveTime - 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

    • getGlossaryTermStatuses

      public GlossaryTermStatusListResponse getGlossaryTermStatuses(String serverName)
      Return the list of glossary term status enum values.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      list of enum values

    • getGlossaryTermRelationshipStatuses

      public GlossaryTermRelationshipStatusListResponse getGlossaryTermRelationshipStatuses(String serverName)
      Return the list of glossary term relationship status enum values.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      list of enum values

    • getGlossaryTermActivityTypes

      public GlossaryTermActivityTypeListResponse getGlossaryTermActivityTypes(String serverName)
      Return the list of glossary term activity types enum values.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      list of enum values

    • findGlossaries

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementsResponse findGlossaries(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Retrieve the list of glossary metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 there is a problem reported in the open metadata server(s)

    • getGlossariesByName

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementsResponse getGlossariesByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the list of glossary metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - name to search for
      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 there is a problem reported in the open metadata server(s)

    • getGlossaryByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementResponse getGlossaryByGUID(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      matching metadata element 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)

    • getGlossaryForCategory

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementResponse getGlossaryForCategory(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary metadata element for the requested category.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      matching metadata element 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)

    • getGlossaryForTerm

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryElementResponse getGlossaryForTerm(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary metadata element for the requested term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      matching metadata element 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)

    • findGlossaryCategories

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse findGlossaryCategories(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody)
      Retrieve the list of glossary category metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - string to find in the properties and correlators
      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 there is a problem reported in the open metadata server(s)

    • getCategoriesForGlossary

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse getCategoriesForGlossary(String serverName, String glossaryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Return the list of categories associated with a glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the glossary to query
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      list of metadata elements describing the categories associated with the requested glossary 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)

    • getCategoriesForTerm

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse getCategoriesForTerm(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Return the list of categories associated with a glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the glossary to query
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      list of metadata elements describing the categories associated with the requested glossary 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)

    • getGlossaryCategoriesByName

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse getGlossaryCategoriesByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody)
      Retrieve the list of glossary category metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - name to search for and correlators
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 there is a problem reported in the open metadata server(s)

    • getGlossaryCategoryByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementResponse getGlossaryCategoryByGUID(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary category metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      requested metadata element 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)

    • getGlossaryCategoryParent

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementResponse getGlossaryCategoryParent(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary category metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      parent glossary category element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getGlossarySubCategories

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryCategoryElementsResponse getGlossarySubCategories(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary category metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the requested metadata element
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      list of glossary category elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findGlossaryTerms

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse findGlossaryTerms(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody)
      Retrieve the list of glossary term metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers and search string
      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 there is a problem reported in the open metadata server(s)

    • getTermsForGlossary

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse getTermsForGlossary(String serverName, String glossaryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of glossary terms associated with a glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the glossary of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      list of associated metadata 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)

    • getTermsForGlossaryCategory

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse getTermsForGlossaryCategory(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermRelationshipRequestBody requestBody)
      Retrieve the list of glossary terms associated with a glossary category.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the glossary category of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      list of associated metadata 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)

    • getRelatedTerms

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse getRelatedTerms(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermRelationshipRequestBody requestBody)
      Retrieve the list of glossary terms associated with the requested term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the glossary of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      list of associated metadata 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)

    • getGlossaryTermsByName

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse getGlossaryTermsByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody)
      Retrieve the list of glossary term metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers and name
      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 there is a problem reported in the open metadata server(s)

    • getGlossaryTermByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementResponse getGlossaryTermByGUID(String serverName, String guid, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary term metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      guid - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      matching metadata element 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)

    • getGlossaryTermHistory

      public org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermElementsResponse getGlossaryTermHistory(String serverName, String guid, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryRequestBody requestBody)
      Retrieve all the versions of a glossary term.
      Parameters:
      serverName - name of the server to route the request to
      guid - unique identifier of object to retrieve
      startFrom - the starting element number of the historical versions to return. This is used when retrieving versions beyond the first page of results. Zero means start from the first element.
      pageSize - the maximum number of result versions that can be returned on this request. Zero means unrestricted return results size.
      oldestFirst - defining how the results should be ordered.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      requestBody - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Returns:
      list of beans or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem removing the properties from the repositories. UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addRatingToElement

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addRatingToElement(String serverName, String guid, boolean isPublic, org.odpi.openmetadata.accessservices.assetmanager.properties.RatingProperties requestBody)
      Adds a star rating and optional review text to the element. If the user has already attached a rating then the original one is over-ridden.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the element.
      isPublic - is this visible to other people
      requestBody - containing the StarRating and user review of referenceable (probably element).
      Returns:
      void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the element properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeRatingFromElement

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeRatingFromElement(String serverName, String guid, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Removes a star rating that was added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the rating object
      requestBody - null request body needed to satisfy the HTTP Post request
      Returns:
      void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addLikeToElement

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addLikeToElement(String serverName, String guid, boolean isPublic, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Adds a "LikeProperties" to the element.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the element.
      isPublic - is this visible to other people
      requestBody - feedback request body .
      Returns:
      void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the element properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeLikeFromElement

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeLikeFromElement(String serverName, String guid, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Removes a "LikeProperties" added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the like object
      requestBody - null request body needed to satisfy the HTTP Post request
      Returns:
      void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addCommentToElement

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addCommentToElement(String serverName, String guid, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Adds a comment to the element.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the element.
      isPublic - is this visible to other people
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      guid for new comment object or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the element properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addCommentReply

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addCommentReply(String serverName, String commentGUID, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Adds a reply to a comment.
      Parameters:
      serverName - name of the server instances for this request
      commentGUID - String - unique id for an existing comment. Used to add a reply to a comment.
      isPublic - is this visible to other people
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      guid for new comment object or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the element properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateComment

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateComment(String serverName, String commentGUID, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Update an existing comment.
      Parameters:
      serverName - name of the server instances for this request.
      commentGUID - unique identifier for the comment to change.
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      isPublic - is this visible to other people
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • setupAcceptedAnswer

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupAcceptedAnswer(String serverName, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Link a comment that contains the best answer to a question posed in another comment.
      Parameters:
      serverName - name of the server to route the request to
      questionCommentGUID - unique identifier of the comment containing the question
      answerCommentGUID - unique identifier of the comment containing the accepted answer
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void 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)

    • clearAcceptedAnswer

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAcceptedAnswer(String serverName, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Unlink a comment that contains an answer to a question posed in another comment.
      Parameters:
      serverName - name of the server to route the request to
      questionCommentGUID - unique identifier of the comment containing the question
      answerCommentGUID - unique identifier of the comment containing the accepted answer
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void 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)

    • removeCommentFromElement

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeCommentFromElement(String serverName, String elementGUID, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Removes a comment added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - String - unique id for the element object
      commentGUID - String - unique id for the comment object
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - null request body needed to satisfy the HTTP Post request
      Returns:
      void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getCommentByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementResponse getCommentByGUID(String serverName, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Return the requested comment.
      Parameters:
      serverName - name of the server instances for this request
      commentGUID - unique identifier for the comment object.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - effectiveTime and asset manager identifiers
      Returns:
      comment properties or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.

    • getAttachedComments

      public org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementsResponse getAttachedComments(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Return the comments attached to an element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier for the element that the comments are connected to (maybe a comment too).
      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 - effectiveTime and asset manager identifiers
      Returns:
      list of comments or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.

    • findComments

      public org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementsResponse findComments(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Retrieve the list of comment metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 there is a problem reported in the open metadata server(s)

    • createInformalTag

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createInformalTag(String serverName, org.odpi.openmetadata.accessservices.assetmanager.properties.TagProperties requestBody)
      Creates a new informal tag and returns the unique identifier for it.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - contains the name of the tag and (optional) description of the tag
      Returns:
      guid for new tag or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateTagDescription

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateTagDescription(String serverName, String tagGUID, InformalTagUpdateRequestBody requestBody)
      Updates the description of an existing tag (either private or public).
      Parameters:
      serverName - name of the server instances for this request
      tagGUID - unique id for the tag.
      requestBody - contains the name of the tag and (optional) description of the tag.
      Returns:
      void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • deleteTag

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteTag(String serverName, String tagGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Removes a tag from the repository. All the relationships to referenceables are lost.
      Parameters:
      serverName - name of the server instances for this request
      tagGUID - unique id for the tag.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getTag

      public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagResponse getTag(String serverName, String guid)
      Return the tag for the supplied unique identifier (guid).
      Parameters:
      serverName - name of the server instances for this request
      guid - unique identifier of the tag.
      Returns:
      Tag object or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getTagsByName

      public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse getTagsByName(String serverName, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
      Return the list of tags exactly matching the supplied name.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - name of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getMyTagsByName

      public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse getMyTagsByName(String serverName, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
      Return the list of the calling user's private tags exactly matching the supplied name.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - name of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findTags

      public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse findTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Return the list of tags containing the supplied string in either the name or description.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      requestBody - string to find in the properties
      Returns:
      tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findMyTags

      public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse findMyTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Return the list of the calling user's private tags containing the supplied string in either the name or description.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      requestBody - string to find in the properties
      Returns:
      tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addTagToElement

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addTagToElement(String serverName, String elementGUID, String tagGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.FeedbackProperties requestBody)
      Adds a tag (either private of public) to an element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique id for the element.
      tagGUID - unique id of the tag.
      requestBody - feedback request body.
      Returns:
      void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeTagFromElement

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeTagFromElement(String serverName, String elementGUID, String tagGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Removes a tag from the element that was added by this user.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique id for the element.
      tagGUID - unique id for the tag.
      requestBody - null request body needed for correct protocol exchange.
      Returns:
      void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getElementsByTag

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse getElementsByTag(String serverName, String tagGUID, int startFrom, int pageSize)
      Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.
      Parameters:
      serverName - name of the server instances for this request
      tagGUID - unique identifier of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      element guid list or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • findNoteLogs

      public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse findNoteLogs(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Retrieve the list of note log metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 there is a problem reported in the open metadata server(s)

    • getNoteLogsByName

      public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse getNoteLogsByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the list of note log metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server instances for this request
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - name to search for and correlators
      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 there is a problem reported in the open metadata server(s)

    • getNoteLogsForElement

      public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse getNoteLogsForElement(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of note log metadata elements attached to the element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier of the note log of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      list of associated metadata 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)

    • getNoteLogByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementResponse getNoteLogByGUID(String serverName, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the note log metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      noteLogGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - correlators
      Returns:
      requested metadata element 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)

    • findNotes

      public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementsResponse findNotes(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
      Retrieve the list of note metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 there is a problem reported in the open metadata server(s)

    • getNotesForNoteLog

      public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementsResponse getNotesForNoteLog(String serverName, String noteLogGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of notes associated with a note log.
      Parameters:
      serverName - name of the server instances for this request
      noteLogGUID - unique identifier of the note log of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      list of associated metadata 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)

    • getNoteByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementResponse getNoteByGUID(String serverName, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the note metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      noteGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      matching metadata element 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)

    • getDataFieldClassifiedElements

      public org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse getDataFieldClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the data field classification.
      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 - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse getConfidenceClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the confidence classification.
      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 - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse getCriticalityClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the criticality classification.
      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 - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse getConfidentialityClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the confidentiality classification.
      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 - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse getRetentionClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the confidence classification.
      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 - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse getSecurityTaggedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the security tags classification.
      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 - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse getOwnersElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the confidence classification.
      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 - 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

    • getMembersOfSubjectArea

      public org.odpi.openmetadata.accessservices.assetmanager.rest.ElementStubsResponse getMembersOfSubjectArea(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)
      Return information about the elements classified with the confidence classification.
      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 - 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

    • getMeanings

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

    • getSemanticAssignees

      public org.odpi.openmetadata.accessservices.assetmanager.rest.RelatedElementsResponse getSemanticAssignees(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getGovernedElements

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

    • getGovernedByDefinitions

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

    • getSourceElements

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

    • getElementsSourceFrom

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