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

Class ClassificationExplorerResource

java.lang.Object
org.odpi.openmetadata.viewservices.classificationexplorer.server.spring.ClassificationExplorerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}") public class ClassificationExplorerResource extends Object
The ClassificationExplorerResource provides the Spring API endpoints of the Classification Explorer Open Metadata View Service (OMVS).

  • Constructor Details

    • ClassificationExplorerResource

      public ClassificationExplorerResource()
      Default constructor

  • Method Details

    • getImpactClassifiedElements

      @PostMapping(path="/elements/by-impact") public OpenMetadataRootElementsResponse getImpactClassifiedElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the impact classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties for the request
      Returns:
      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 OpenMetadataRootElementsResponse getConfidenceClassifiedElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the confidence classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties for the request
      Returns:
      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 OpenMetadataRootElementsResponse getCriticalityClassifiedElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the criticality classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties for the request
      Returns:
      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 OpenMetadataRootElementsResponse getConfidentialityClassifiedElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the confidentiality classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties for the request
      Returns:
      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 OpenMetadataRootElementsResponse getRetentionClassifiedElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the retention classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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 OpenMetadataRootElementsResponse getSecurityTaggedElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SecurityTagQueryProperties requestBody)
      Return information about the elements classified with the security tags classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties for the request
      Returns:
      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 OpenMetadataRootElementsResponse getOwnersElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Return information about the elements classified with the ownership classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getElementsByOrigin

      @PostMapping(path="/elements/by-digital-resource-origin") public OpenMetadataRootElementsResponse getElementsByOrigin(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FindDigitalResourceOriginProperties requestBody)
      Return information about the digital resources from a specific origin.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties for the request
      Returns:
      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 OpenMetadataRootElementsResponse getMeanings(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, SemanticAssignmentQueryProperties requestBody)
      Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      requestBody - properties for relationship request
      Returns:
      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 OpenMetadataRootElementsResponse getSemanticAssignees(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String glossaryTermGUID, @RequestBody(required=false) SemanticAssignmentQueryProperties requestBody)
      Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to
      requestBody - properties for relationship request
      Returns:
      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 OpenMetadataRootElementsResponse getGovernedElements(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      governanceDefinitionGUID - unique identifier of the governance definition that the returned elements are linked to
      requestBody - properties for relationship request
      Returns:
      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 OpenMetadataRootElementsResponse getGovernedByDefinitions(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      requestBody - properties for relationship request
      Returns:
      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/{elementGUID}/source") public OpenMetadataRootElementsResponse getSourceElements(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody 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
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getElementsSourcedFrom

      @PostMapping(path="/elements/{elementGUID}/sourced-from") public OpenMetadataRootElementsResponse getElementsSourcedFrom(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the elements linked via a "SourcedFrom" relationship to the requested element. The elements returned were created using the requested element as a template.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getScopes

      @PostMapping(path="/elements/{elementGUID}/scoped-by") public OpenMetadataRootElementsResponse getScopes(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getScopedElements

      @PostMapping(path="/elements/scoped-by/{scopeGUID}") public OpenMetadataRootElementsResponse getScopedElements(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String scopeGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      scopeGUID - unique identifier of the element that the returned elements are linked to
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getResourceList

      @PostMapping(path="/elements/{elementGUID}/resource-list") public OpenMetadataRootElementsResponse getResourceList(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getSupportedByResource

      @PostMapping(path="/elements/resource-list/{resourceGUID}") public OpenMetadataRootElementsResponse getSupportedByResource(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String resourceGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the elements linked via a "ResourceList" relationship to the requested resource.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      resourceGUID - unique identifier of the element that the returned elements are linked to
      requestBody - properties for relationship request
      Returns:
      linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getLicensedElements

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

    • getLicenses

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

    • geCertifiedElements

      @PostMapping(path="/elements/certifications/{certificationTypeGUID}") public OpenMetadataRootElementsResponse geCertifiedElements(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String certificationTypeGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Return information about the elements linked to a certification type.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      certificationTypeGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertifications

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

    • getMetadataElementByGUID

      @PostMapping(path="/elements/{elementGUID}") public OpenMetadataRootElementResponse getMetadataElementByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Retrieve the metadata element using its unique identifier.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      elementGUID - unique identifier for the metadata element
      requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
      Returns:
      metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store

    • getMetadataElementByUniqueName

      @PostMapping(path="/elements/by-unique-name") public OpenMetadataRootElementResponse getMetadataElementByUniqueName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FindPropertyNameProperties requestBody)
      Retrieve the metadata element using its unique name (typically the qualified name).
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - unique name for the metadata element
      Returns:
      metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store

    • getMetadataElementGUIDByUniqueName

      @PostMapping(path="/elements/guid-by-unique-name") public GUIDResponse getMetadataElementGUIDByUniqueName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody FindPropertyNameProperties requestBody)
      Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - unique name for the metadata element
      Returns:
      metadata element unique identifier (guid) or InvalidParameterException the unique identifier is null or not known or UserNotAuthorizedException the governance action service is not able to access the element or PropertyServerException there is a problem accessing the metadata store

    • getElements

      @PostMapping(path="/elements/by-type") public OpenMetadataRootElementsResponse getElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve elements of the requested type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findRootElements

      @PostMapping(path="/elements/by-complex-query") public OpenMetadataRootElementsResponse findRootElements(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FindRequestBody requestBody)
      Retrieve elements that match the complex query.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByPropertyValue

      @PostMapping(path="/elements/by-exact-property-value") public OpenMetadataRootElementsResponse getElementsByPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve elements by a value found in one of the properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findElementsByPropertyValue

      @PostMapping(path="/elements/by-property-value-search") public OpenMetadataRootElementsResponse findElementsByPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve elements by a value found in one of the properties specified. The value must only be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByClassification

      @PostMapping(path="/elements/by-classification/{classificationName}") public OpenMetadataRootElementsResponse getElementsByClassification(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String classificationName, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve elements with the requested classification name. It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of element may be returned.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      classificationName - name of classification
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByClassificationWithPropertyValue

      @PostMapping(path="/elements/by-classification/{classificationName}/with-exact-property-value") public OpenMetadataRootElementsResponse getElementsByClassificationWithPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String classificationName, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      classificationName - name of classification
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findElementsByClassificationWithPropertyValue

      @PostMapping(path="/elements/by-classification/{classificationName}/with-property-value-search") public OpenMetadataRootElementsResponse findElementsByClassificationWithPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String classificationName, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must only be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      classificationName - name of classification
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelatedElements

      @PostMapping(path="/elements/{elementGUID}/by-relationship") public OpenMetadataRootElementsResponse getRelatedElements(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve related elements of any type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the starting element
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelatedElements

      @PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}") public OpenMetadataRootElementsResponse getRelatedElements(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve related elements of the requested type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelatedElementsWithPropertyValue

      @PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}/with-exact-property-value") public OpenMetadataRootElementsResponse getRelatedElementsWithPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve elements linked via the requested relationship type name and with the requested value found in one of the relationship's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findRelatedElementsWithPropertyValue

      @PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}/with-property-value-search") public OpenMetadataRootElementsResponse findRelatedElementsWithPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve elements linked via the requested relationship type name and with the relationship's properties specified. The value must only be contained in the by a value found in one of the properties specified. The value must only be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelationships

      @PostMapping(path="/relationships") public MetadataRelationshipSummariesResponse getRelationships(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve relationships of the requested relationship type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelationships

      @PostMapping(path="/relationships/{relationshipTypeName}") public MetadataRelationshipSummariesResponse getRelationships(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationshipTypeName, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve relationships of the requested relationship type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelationshipsWithPropertyValue

      @PostMapping(path="/relationships/with-exact-property-value") public MetadataRelationshipSummariesResponse getRelationshipsWithPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must match exactly.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelationshipsWithPropertyValue

      @PostMapping(path="/relationships/{relationshipTypeName}/with-exact-property-value") public MetadataRelationshipSummariesResponse getRelationshipsWithPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationshipTypeName, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must match exactly.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      relationshipTypeName - name of relationship
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findRelationshipsWithPropertyValue

      @PostMapping(path="/relationships/with-property-value-search") public MetadataRelationshipSummariesResponse findRelationshipsWithPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must only be contained in the properties rather than needing to be an exact match.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findRelationshipsWithPropertyValue

      @PostMapping(path="/relationships/{relationshipTypeName}/with-property-value-search") public MetadataRelationshipSummariesResponse findRelationshipsWithPropertyValue(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationshipTypeName, @RequestBody(required=false) FindPropertyNamesProperties requestBody)
      Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must only be contained in the properties rather than needing to be an exact match.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      relationshipTypeName - name of relationship
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • retrieveInstanceForGUID

      @PostMapping(path="/guids/{guid}") public ElementHeaderResponse retrieveInstanceForGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String guid, @RequestBody(required=false) GetRequestBody requestBody)
      Retrieve the header for the instance identified by the supplied unique identifier. It may be an element (entity) or a relationship between elements.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      guid - identifier to use in the lookup
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByCategory

      @PostMapping(path="/elements/by-category") public OpenMetadataRootElementsResponse getElementsByCategory(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Return the list of search keywords containing the supplied string.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      requestBody - search string and effective time.
      Returns:
      list of search keyword objects 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.

    • findSearchKeywords

      @PostMapping(path="/search-keywords/by-search-string") public OpenMetadataRootElementsResponse findSearchKeywords(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Return the list of search keywords containing the supplied string.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      requestBody - search string and effective time.
      Returns:
      list of search keyword objects 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.

    • getSearchKeywordByKeyword

      @PostMapping(path="/search-keywords/by-keyword") public OpenMetadataRootElementsResponse getSearchKeywordByKeyword(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Return the list of search keywords containing the supplied keyword.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      requestBody - search string and effective time.
      Returns:
      list of search keyword objects 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.

    • getSearchKeywordByGUID

      @PostMapping(path="/search-keywords/{searchKeywordGUID}/retrieve") public OpenMetadataRootElementResponse getSearchKeywordByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String searchKeywordGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the requested searchKeyword.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      searchKeywordGUID - unique identifier for the search keyword object.
      requestBody - optional effective time
      Returns:
      search keyword 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.