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

Class GlossaryBrowserResource

java.lang.Object
org.odpi.openmetadata.viewservices.glossarybrowser.server.spring.GlossaryBrowserResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/glossary-browser") public class GlossaryBrowserResource extends Object
The GlossaryBrowserResource provides the Spring API endpoints of the Glossary Browser Open Metadata View Service (OMVS). This interface provides a service for Egeria UIs.

  • Constructor Details

    • GlossaryBrowserResource

      public GlossaryBrowserResource()
      Default constructor

  • Method Details

    • getGlossaryTermStatuses

      @GetMapping(path="/glossaries/terms/status-list") public GlossaryTermStatusListResponse getGlossaryTermStatuses(@PathVariable 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

      @GetMapping(path="/glossaries/terms/relationships/status-list") public GlossaryTermRelationshipStatusListResponse getGlossaryTermRelationshipStatuses(@PathVariable 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

      @GetMapping(path="/glossaries/terms/activity-types") public GlossaryTermActivityTypeListResponse getGlossaryTermActivityTypes(@PathVariable String serverName)
      Return the list of glossary term activity type enum values.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      list of enum values

    • findGlossaries

      @PostMapping(path="/glossaries/by-search-string") public GlossaryElementsResponse findGlossaries(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody SearchStringRequestBody requestBody)
      Retrieve the list of glossary metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - string to find in the properties
      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?
      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

      @PostMapping(path="/glossaries/by-name") public GlossaryElementsResponse getGlossariesByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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
      requestBody - name to search for
      startFrom - paging start point
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      pageSize - maximum results that can be returned
      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

      @PostMapping(path="/glossaries/{glossaryGUID}/retrieve") public GlossaryElementResponse getGlossaryByGUID(@PathVariable String serverName, @PathVariable String glossaryGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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

      @PostMapping(path="/glossaries/for-category/{glossaryCategoryGUID}/retrieve") public GlossaryElementResponse getGlossaryForCategory(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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

      @PostMapping(path="/glossaries/for-term/{glossaryTermGUID}/retrieve") public GlossaryElementResponse getGlossaryForTerm(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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

      @PostMapping(path="/glossaries/categories/by-search-string") public GlossaryCategoryElementsResponse findGlossaryCategories(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody GlossarySearchStringRequestBody requestBody)
      Retrieve the list of glossary category metadata elements that contain the search string.
      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

      @PostMapping(path="/glossaries/{glossaryGUID}/categories/retrieve") public GlossaryCategoryElementsResponse getCategoriesForGlossary(@PathVariable String serverName, @PathVariable String glossaryGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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

      @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/categories/retrieve") public GlossaryCategoryElementsResponse getCategoriesForTerm(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Return the list of categories associated with a 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

      @PostMapping(path="/glossaries/categories/by-name") public GlossaryCategoryElementsResponse getGlossaryCategoriesByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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

      @PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/retrieve") public GlossaryCategoryElementResponse getGlossaryCategoryByGUID(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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

      @PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/parent/retrieve") public GlossaryCategoryElementResponse getGlossaryCategoryParent(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the parent glossary category metadata element for the glossary category with the supplied unique identifier. If the requested category does not have a parent category, null is returned.
      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

      @PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/subcategories/retrieve") public GlossaryCategoryElementsResponse getGlossarySubCategories(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the subcategories for 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

      @PostMapping(path="/glossaries/terms/by-search-string") public GlossaryTermElementsResponse findGlossaryTerms(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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

      @PostMapping(path="/glossaries/{glossaryGUID}/terms/retrieve") public GlossaryTermElementsResponse getTermsForGlossary(@PathVariable String serverName, @PathVariable String glossaryGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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

      @PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/terms/retrieve") public GlossaryTermElementsResponse getTermsForGlossaryCategory(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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

      @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/related-terms") public GlossaryTermElementsResponse getRelatedTerms(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) GlossaryTermRelationshipRequestBody requestBody)
      Retrieve the list of glossary terms associated with the requested glossary 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

      @PostMapping(path="/glossaries/terms/by-name") public GlossaryTermElementsResponse getGlossaryTermsByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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

      @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/retrieve") public GlossaryTermElementResponse getGlossaryTermByGUID(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the glossary term metadata element with the supplied unique identifier.
      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)

    • getGlossaryTermHistory

      @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/history") public GlossaryTermElementsResponse getGlossaryTermHistory(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean oldestFirst, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) HistoryRequestBody requestBody)
      Retrieve all the versions of a glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - 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.

    • getDataFieldClassifiedElements

      @PostMapping(path="/elements/by-data-field") public ElementStubsResponse getDataFieldClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getConfidenceClassifiedElements

      @PostMapping(path="/elements/by-confidence") public MetadataElementSummariesResponse getConfidenceClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getCriticalityClassifiedElements

      @PostMapping(path="/elements/by-criticality") public MetadataElementSummariesResponse getCriticalityClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getConfidentialityClassifiedElements

      @PostMapping(path="/elements/by-confidentiality") public MetadataElementSummariesResponse getConfidentialityClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getRetentionClassifiedElements

      @PostMapping(path="/elements/by-retention") public MetadataElementSummariesResponse getRetentionClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getSecurityTaggedElements

      @PostMapping(path="/elements/by-security-tags") public MetadataElementSummariesResponse getSecurityTaggedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getOwnersElements

      @PostMapping(path="/elements/by-ownership") public MetadataElementSummariesResponse getOwnersElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getMembersOfSubjectArea

      @PostMapping(path="/elements/by-subject-area-membership") public MetadataElementSummariesResponse getMembersOfSubjectArea(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getMeanings

      @PostMapping("/glossaries/terms/by-semantic-assignment/{elementGUID}") public GlossaryTermElementsResponse getMeanings(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getSemanticAssignees

      @PostMapping("/elements/by-semantic-assignment/{glossaryTermGUID}") public RelatedMetadataElementSummariesResponse getSemanticAssignees(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getGovernedElements

      @PostMapping(path="/elements/governed-by/{governanceDefinitionGUID}") public RelatedMetadataElementSummariesResponse getGovernedElements(@PathVariable String serverName, @PathVariable String governanceDefinitionGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getGovernedByDefinitions

      @PostMapping(path="/elements/{elementGUID}/governed-by") public GovernanceDefinitionsResponse getGovernedByDefinitions(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getSourceElements

      @PostMapping(path="/elements/sourced-from/{elementGUID}") public RelatedMetadataElementSummariesResponse getSourceElements(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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 element that the returned elements are linked to
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getElementsSourceFrom

      @PostMapping(path="/elements/{elementGUID}/sourced-from") public RelatedMetadataElementSummariesResponse getElementsSourceFrom(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem