Package org.odpi.openmetadata.repositoryservices.rest.server.spring

Class EnterpriseRepositoryServicesResource

java.lang.Object
org.odpi.openmetadata.repositoryservices.rest.server.spring.EnterpriseRepositoryServicesResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/repository-services/users/{userId}/enterprise") public class EnterpriseRepositoryServicesResource extends Object
EnterpriseRepositoryServicesResource provides the server-side support for the OMRS Repository REST Services API calls that are directed to an enterprise connector.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EnterpriseRepositoryServicesResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    addEntity(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.EntityCreateRequest requestBody)
    Create a new entity and put it in the requested state.
    org.odpi.openmetadata.repositoryservices.rest.properties.VoidResponse
    addEntityProxy(String serverName, String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityProxy)
    Create an entity proxy in the metadata collection.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    addExternalEntity(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.EntityCreateRequest requestBody)
    Save a new entity that is sourced from an external technology.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    addExternalRelationship(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipCreateRequest createRequestParameters)
    Save a new relationship that is sourced from an external technology.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    addRelationship(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipCreateRequest createRequestParameters)
    Add a new relationship between two entities to the metadata collection.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    classifyEntity(String serverName, String userId, String entityGUID, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationRequest classificationRequestBody)
    Add the requested classification to a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    classifyEntity(String serverName, String userId, String entityGUID, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.InstancePropertiesRequest propertiesRequestBody)
    Add the requested classification to a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationResponse
    classifyEntity(String serverName, String userId, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationProxyRequest requestBody)
    Add the requested classification to a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationResponse
    classifyEntity(String serverName, String userId, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.ProxyClassificationRequest requestBody)
    Add the requested classification to a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    declassifyEntity(String serverName, String userId, String entityGUID, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest requestBody)
    Remove a specific classification from an entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationResponse
    declassifyEntity(String serverName, String userId, String classificationName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy requestBody)
    Remove a specific classification from an entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    deleteEntity(String serverName, String userId, String obsoleteEntityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefValidationForRequest typeDefValidationForRequest)
    Delete an entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    deleteRelationship(String serverName, String userId, String obsoleteRelationshipGUID, org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefValidationForRequest typeDefValidationForRequest)
    Delete a specific relationship.
    org.odpi.openmetadata.repositoryservices.rest.properties.AttributeTypeDefListResponse
    findAttributeTypeDefsByCategory(String serverName, String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDefCategory category)
    Returns all the AttributeTypeDefs for a specific category.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    findEntities(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.EntityFindRequest findRequestParameters)
    Return a list of entities that match the supplied conditions.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    findEntitiesByClassification(String serverName, String userId, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.PropertyMatchFindRequest findRequestParameters)
    Return a list of entities that have the requested type of classification attached.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    findEntitiesByClassificationHistory(String serverName, String userId, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.PropertyMatchHistoricalFindRequest findRequestParameters)
    Return a list of entities that have the requested type of classification attached.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    findEntitiesByHistory(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.EntityHistoricalFindRequest findRequestParameters)
    Return a list of entities that match the supplied conditions.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    findEntitiesByProperty(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.EntityPropertyFindRequest findRequestParameters)
    Return a list of entities that match the supplied properties according to the match criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    findEntitiesByPropertyHistory(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.EntityPropertyHistoricalFindRequest findRequestParameters)
    Return a list of entities that match the supplied properties according to the match criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    findEntitiesByPropertyValue(String serverName, String userId, String searchCriteria, org.odpi.openmetadata.repositoryservices.rest.properties.EntityPropertyFindRequest findRequestParameters)
    Return a list of entities whose string based property values match the search criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    findEntitiesByPropertyValueHistory(String serverName, String userId, String searchCriteria, org.odpi.openmetadata.repositoryservices.rest.properties.EntityPropertyHistoricalFindRequest findRequestParameters)
    Return a list of entities whose string based property values match the search criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse
    findRelationships(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.InstanceFindRequest findRequestParameters)
    Return a list of relationships that match the requested conditions.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse
    findRelationshipsByHistory(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.InstanceHistoricalFindRequest findRequestParameters)
    Return a list of relationships that match the requested conditions.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse
    findRelationshipsByProperty(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.PropertyMatchFindRequest findRequestParameters)
    Return a list of relationships that match the requested properties by the matching criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse
    findRelationshipsByPropertyHistory(String serverName, String userId, org.odpi.openmetadata.repositoryservices.rest.properties.PropertyMatchHistoricalFindRequest findRequestParameters)
    Return a list of relationships that match the requested properties by the matching criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse
    findRelationshipsByPropertyValue(String serverName, String userId, String searchCriteria, org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedFindRequest findRequestParameters)
    Return a list of relationships that match the search criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse
    findRelationshipsByPropertyValueHistory(String serverName, String userId, String searchCriteria, org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedHistoricalFindRequest findRequestParameters)
    Return a list of relationships that match the search criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefListResponse
    findTypeDefsByCategory(String serverName, String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category)
    Returns all the TypeDefs for a specific category.
    org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefListResponse
    findTypeDefsByProperty(String serverName, String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefProperties matchCriteria)
    Return the TypeDefs that have the properties matching the supplied match criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefListResponse
    findTypesByExternalID(String serverName, String userId, String standard, String organization, String identifier)
    Return the types that are linked to the elements from the specified standard.
    org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefGalleryResponse
    findTypesByName(String serverName, String userId, String name)
    Returns a list of type definitions that have the specified name.
    org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefGalleryResponse
    getAllTypes(String serverName, String userId)
    Returns the list of different types of metadata organized into two groups.
    org.odpi.openmetadata.repositoryservices.rest.properties.AttributeTypeDefResponse
    getAttributeTypeDefByGUID(String serverName, String userId, String guid)
    Return the AttributeTypeDef identified by the GUID.
    org.odpi.openmetadata.repositoryservices.rest.properties.AttributeTypeDefResponse
    getAttributeTypeDefByName(String serverName, String userId, String name)
    Return the AttributeTypeDef identified by the unique name.
    org.odpi.openmetadata.repositoryservices.rest.properties.ConnectionResponse
    getEnterpriseOMRSTopicConnection(String serverName, String userId)
    Return the connection for remote access to the enterprise topic connector.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    getEntityDetail(String serverName, String userId, String guid)
    Return the header, classifications and properties of a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    getEntityDetail(String serverName, String userId, String guid, org.odpi.openmetadata.repositoryservices.rest.properties.HistoryRequest asOfTime)
    Return a historical version of an entity includes the header, classifications and properties of the entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.InstanceGraphResponse
    getEntityNeighborhood(String serverName, String userId, String entityGUID, int level, org.odpi.openmetadata.repositoryservices.rest.properties.EntityNeighborhoodFindRequest findRequestParameters)
    Return the entities and relationships that radiate out from the supplied entity GUID.
    org.odpi.openmetadata.repositoryservices.rest.properties.InstanceGraphResponse
    getEntityNeighborhoodHistory(String serverName, String userId, String entityGUID, int level, org.odpi.openmetadata.repositoryservices.rest.properties.EntityNeighborhoodHistoricalFindRequest findRequestParameters)
    Return the entities and relationships that radiate out from the supplied entity GUID.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntitySummaryResponse
    getEntitySummary(String serverName, String userId, String guid)
    Return the header and classifications for a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.InstanceGraphResponse
    getLinkingEntities(String serverName, String userId, String startEntityGUID, String endEntityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest findRequestParameters)
    Return all the relationships and intermediate entities that connect the startEntity with the endEntity.
    org.odpi.openmetadata.repositoryservices.rest.properties.InstanceGraphResponse
    getLinkingEntitiesHistory(String serverName, String userId, String startEntityGUID, String endEntityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIHistoricalFindRequest findRequestParameters)
    Return all the relationships and intermediate entities that connect the startEntity with the endEntity.
    org.odpi.openmetadata.repositoryservices.rest.properties.MetadataCollectionIdResponse
    getMetadataCollectionId(String serverName, String userId)
    Returns the identifier of the metadata repository.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    getRelatedEntities(String serverName, String userId, String startEntityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.RelatedEntitiesFindRequest findRequestParameters)
    Return the list of entities that are of the types listed in instanceTypes and are connected, either directly or indirectly to the entity identified by startEntityGUID.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse
    getRelatedEntitiesHistory(String serverName, String userId, String startEntityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.RelatedEntitiesHistoricalFindRequest findRequestParameters)
    Return the list of entities that are of the types listed in instanceTypes and are connected, either directly or indirectly to the entity identified by startEntityGUID.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    getRelationship(String serverName, String userId, String guid)
    Return a requested relationship.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    getRelationship(String serverName, String userId, String guid, org.odpi.openmetadata.repositoryservices.rest.properties.HistoryRequest asOfTime)
    Return a historical version of a relationship.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse
    getRelationshipsForEntity(String serverName, String userId, String entityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedFindRequest findRequestParameters)
    Return the relationships for a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse
    getRelationshipsForEntityHistory(String serverName, String userId, String entityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedHistoricalFindRequest findRequestParameters)
    Return the relationships for a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefResponse
    getTypeDefByGUID(String serverName, String userId, String guid)
    Return the TypeDef identified by the GUID.
    org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefResponse
    getTypeDefByName(String serverName, String userId, String name)
    Return the TypeDef identified by the unique name.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    isEntityKnown(String serverName, String userId, String guid)
    Returns a boolean indicating if the entity is stored in the metadata collection.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    isRelationshipKnown(String serverName, String userId, String guid)
    Returns a boolean indicating if the relationship is stored in the metadata collection.
    org.odpi.openmetadata.repositoryservices.rest.properties.VoidResponse
    purgeEntity(String serverName, String userId, String deletedEntityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefValidationForRequest typeDefValidationForRequest)
    Permanently removes a deleted entity from the metadata collection.
    org.odpi.openmetadata.repositoryservices.rest.properties.VoidResponse
    purgeRelationship(String serverName, String userId, String deletedRelationshipGUID, org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefValidationForRequest typeDefValidationForRequest)
    Permanently delete the relationship from the repository.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    restoreEntity(String serverName, String userId, String deletedEntityGUID)
    Restore the requested entity to the state it was before it was deleted.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    restoreRelationship(String serverName, String userId, String deletedRelationshipGUID)
    Restore a deleted relationship into the metadata collection.
    org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefListResponse
    searchForTypeDefs(String serverName, String userId, String searchCriteria)
    Return the TypeDefs that match the search criteria.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    undoEntityUpdate(String serverName, String userId, String entityGUID)
    Undo the last update to an entity and return the previous content.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    undoRelationshipUpdate(String serverName, String userId, String relationshipGUID)
    Undo the latest change to a relationship (either a change of properties or status).
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    updateEntityClassification(String serverName, String userId, String entityGUID, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.InstancePropertiesRequest propertiesRequestBody)
    Update one or more properties in one of an entity's classifications.
    org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationResponse
    updateEntityClassification(String serverName, String userId, String classificationName, org.odpi.openmetadata.repositoryservices.rest.properties.ProxyClassificationRequest requestBody)
    Update one or more properties in one of an entity's classifications.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    updateEntityProperties(String serverName, String userId, String entityGUID, org.odpi.openmetadata.repositoryservices.rest.properties.InstancePropertiesRequest propertiesRequestBody)
    Update selected properties in an entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse
    updateEntityStatus(String serverName, String userId, String entityGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus newStatus)
    Update the status for a specific entity.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    updateRelationshipProperties(String serverName, String userId, String relationshipGUID, org.odpi.openmetadata.repositoryservices.rest.properties.InstancePropertiesRequest propertiesRequestBody)
    Update the properties of a specific relationship.
    org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse
    updateRelationshipStatus(String serverName, String userId, String relationshipGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus newStatus)
    Update the status of a specific relationship.
    org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse
    verifyAttributeTypeDef(String serverName, String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
    Verify that a definition of an AttributeTypeDef is either new or matches the definition already stored.
    org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse
    verifyTypeDef(String serverName, String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
    Verify that a definition of a TypeDef is either new or matches the definition already stored.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • EnterpriseRepositoryServicesResource

      public EnterpriseRepositoryServicesResource()
      Default constructor

  • Method Details

    • getMetadataCollectionId

      @GetMapping(path="/metadata-collection-id") public org.odpi.openmetadata.repositoryservices.rest.properties.MetadataCollectionIdResponse getMetadataCollectionId(@PathVariable String serverName, @PathVariable String userId)
      Returns the identifier of the metadata repository. This is the identifier used to register the metadata repository with the metadata repository cohort. It is also the identifier used to identify the home repository of a metadata instance.
      Parameters:
      serverName - unique identifier for requested server.
      userId - calling user
      Returns:
      String metadata collection id or RepositoryErrorException if there is a problem communicating with the metadata repository.

    • getAllTypes

      @GetMapping(path="/types/all") public org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefGalleryResponse getAllTypes(@PathVariable String serverName, @PathVariable String userId)
      Returns the list of different types of metadata organized into two groups. The first are the attribute type definitions (AttributeTypeDefs). These provide types for properties in full type definitions. Full type definitions (TypeDefs) describe types for entities, relationships and classifications.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      Returns:
      TypeDefGalleryResponse: List of different categories of type definitions or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findTypesByName

      @GetMapping(path="/types/by-name") public org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefGalleryResponse findTypesByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam String name)
      Returns a list of type definitions that have the specified name. Type names should be unique. This method allows wildcard character to be included in the name. These are * (asterisk) for an arbitrary string of characters and ampersand for an arbitrary character.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      name - name of the TypeDefs to return (including wildcard characters).
      Returns:
      TypeDefGalleryResponse: List of different categories of type definitions or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation or InvalidParameterException the name of the TypeDef is null.

    • findTypeDefsByCategory

      @PostMapping(path="/types/typedefs/by-category") public org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefListResponse findTypeDefsByCategory(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category)
      Returns all the TypeDefs for a specific category.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      category - find parameters used to limit the returned results.
      Returns:
      TypeDefListResponse: TypeDefs list or InvalidParameterException the TypeDefCategory is null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findAttributeTypeDefsByCategory

      @PostMapping(path="/types/attribute-typedefs/by-category") public org.odpi.openmetadata.repositoryservices.rest.properties.AttributeTypeDefListResponse findAttributeTypeDefsByCategory(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDefCategory category)
      Returns all the AttributeTypeDefs for a specific category.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      category - find parameters used to limit the returned results.
      Returns:
      AttributeTypeDefListResponse: AttributeTypeDefs list or InvalidParameterException the TypeDefCategory is null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findTypeDefsByProperty

      @GetMapping(path="/types/typedefs/by-property") public org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefListResponse findTypeDefsByProperty(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefProperties matchCriteria)
      Return the TypeDefs that have the properties matching the supplied match criteria.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      matchCriteria - TypeDefProperties a list of property names.
      Returns:
      TypeDefListResponse: TypeDefs list or InvalidParameterException the matchCriteria is null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findTypesByExternalID

      @GetMapping(path="/types/typedefs/by-external-id") public org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefListResponse findTypesByExternalID(@PathVariable String serverName, @PathVariable String userId, @RequestParam(required=false) String standard, @RequestParam(required=false) String organization, @RequestParam(required=false) String identifier)
      Return the types that are linked to the elements from the specified standard.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      standard - name of the standard null means any.
      organization - name of the organization null means any.
      identifier - identifier of the element in the standard null means any.
      Returns:
      TypeDefsGalleryResponse: A list of types or InvalidParameterException all attributes of the external id are null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • searchForTypeDefs

      @GetMapping(path="/types/typedefs/by-property-value") public org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefListResponse searchForTypeDefs(@PathVariable String serverName, @PathVariable String userId, @RequestParam String searchCriteria)
      Return the TypeDefs that match the search criteria.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      searchCriteria - String search criteria.
      Returns:
      TypeDefListResponse: TypeDefs list or InvalidParameterException the searchCriteria is null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getTypeDefByGUID

      @GetMapping(path="/types/typedef/{guid}") public org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefResponse getTypeDefByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the TypeDef identified by the GUID.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique id of the TypeDef.
      Returns:
      TypeDefResponse: TypeDef structure describing its category and properties or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeDefNotKnownException The requested TypeDef is not known in the metadata collection or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getAttributeTypeDefByGUID

      @GetMapping(path="/types/attribute-typedef/{guid}") public org.odpi.openmetadata.repositoryservices.rest.properties.AttributeTypeDefResponse getAttributeTypeDefByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the AttributeTypeDef identified by the GUID.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique id of the TypeDef
      Returns:
      AttributeTypeDefResponse: TypeDef structure describing its category and properties or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeDefNotKnownException The requested TypeDef is not known in the metadata collection or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getTypeDefByName

      @GetMapping(path="/types/typedef/name/{name}") public org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefResponse getTypeDefByName(@PathVariable String serverName, @PathVariable String userId, @PathVariable String name)
      Return the TypeDef identified by the unique name.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      name - String name of the TypeDef.
      Returns:
      TypeDefResponse: TypeDef structure describing its category and properties or InvalidParameterException the name is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeDefNotKnownException the requested TypeDef is not found in the metadata collection or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getAttributeTypeDefByName

      @GetMapping(path="/types/attribute-typedef/name/{name}") public org.odpi.openmetadata.repositoryservices.rest.properties.AttributeTypeDefResponse getAttributeTypeDefByName(@PathVariable String serverName, @PathVariable String userId, @PathVariable String name)
      Return the AttributeTypeDef identified by the unique name.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      name - String name of the TypeDef.
      Returns:
      AttributeTypeDefResponse: AttributeTypeDef structure describing its category and properties or InvalidParameterException the name is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeDefNotKnownException the requested TypeDef is not found in the metadata collection or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • verifyTypeDef

      @PostMapping(path="/types/typedef/compatibility") public org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse verifyTypeDef(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
      Verify that a definition of a TypeDef is either new or matches the definition already stored.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      typeDef - TypeDef structure describing the TypeDef to test.
      Returns:
      BooleanResponse: boolean true means the TypeDef matches the local definition false means the TypeDef is not known or InvalidParameterException the TypeDef is null. RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored. TypeDefNotSupportedException the repository is not able to support this TypeDef. TypeDefConflictException the new TypeDef conflicts with an existing TypeDef. InvalidTypeDefException the new TypeDef has invalid contents. UserNotAuthorizedException the userId is not permitted to perform this operation.

    • verifyAttributeTypeDef

      @PostMapping(path="/types/attribute-typedef/compatibility") public org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse verifyAttributeTypeDef(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
      Verify that a definition of an AttributeTypeDef is either new or matches the definition already stored.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      attributeTypeDef - TypeDef structure describing the TypeDef to test.
      Returns:
      BooleanResponse: boolean true means the TypeDef matches the local definition false means the TypeDef is not known or InvalidParameterException the TypeDef is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeDefNotSupportedException the repository is not able to support this TypeDef or TypeDefConflictException the new TypeDef conflicts with an existing TypeDef or InvalidTypeDefException the new TypeDef has invalid contents or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • isEntityKnown

      @GetMapping(path="/instances/entity/{guid}/existence") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse isEntityKnown(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Returns a boolean indicating if the entity is stored in the metadata collection. This entity may be a full entity object, or an entity proxy.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique identifier for the entity
      Returns:
      the entity details if the entity is found in the metadata collection; otherwise return null InvalidParameterException the guid is null. RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored. UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getEntitySummary

      @GetMapping(path="/instances/entity/{guid}/summary") public org.odpi.openmetadata.repositoryservices.rest.properties.EntitySummaryResponse getEntitySummary(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the header and classifications for a specific entity. The returned entity summary may be from a full entity object or an entity proxy.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique identifier for the entity
      Returns:
      EntitySummary structure or InvalidParameterException the guid is null. RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored. EntityNotKnownException the requested entity instance is not known in the metadata collection. UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getEntityDetail

      @GetMapping(path="/instances/entity/{guid}") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse getEntityDetail(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the header, classifications and properties of a specific entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique identifier for the entity.
      Returns:
      EntityDetailResponse: EntityDetail structure or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the requested entity instance is not known in the metadata collection or EntityProxyOnlyException the requested entity instance is only a proxy in the metadata collection or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getEntityDetail

      @PostMapping(path="/instances/entity/{guid}/history") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse getEntityDetail(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.HistoryRequest asOfTime)
      Return a historical version of an entity includes the header, classifications and properties of the entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique identifier for the entity.
      asOfTime - the time used to determine which version of the entity that is desired.
      Returns:
      EntityDetailResponse: EntityDetail structure or InvalidParameterException the guid or date is null or the asOfTime property is for a future time or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the requested entity instance is not known in the metadata collection at the time requested or EntityProxyOnlyException the requested entity instance is only a proxy in the metadata collection or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getRelationshipsForEntity

      @PostMapping(path="/instances/entity/{entityGUID}/relationships") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse getRelationshipsForEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedFindRequest findRequestParameters)
      Return the relationships for a specific entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - String unique identifier for the entity.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      RelationshipListResponse: Relationships list. Null means no relationships associated with the entity or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the requested entity instance is not known in the metadata collection or PropertyErrorException the sequencing property is not valid for the attached classifications or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getRelationshipsForEntityHistory

      @PostMapping(path="/instances/entity/{entityGUID}/relationships/history") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse getRelationshipsForEntityHistory(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedHistoricalFindRequest findRequestParameters)
      Return the relationships for a specific entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - String unique identifier for the entity.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      RelationshipListResponse: Relationships list. Null means no relationships associated with the entity or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the requested entity instance is not known in the metadata collection or PropertyErrorException the sequencing property is not valid for the attached classifications or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findEntities

      @PostMapping(path="/instances/entities") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse findEntities(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityFindRequest findRequestParameters)
      Return a list of entities that match the supplied conditions. The results can be returned over many pages.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: a list of entities matching the supplied criteria null means no matching entities in the metadata collection or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the properties specified are not valid for any of the requested types of entity or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findEntitiesByHistory

      @PostMapping(path="/instances/entities/history") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse findEntitiesByHistory(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityHistoricalFindRequest findRequestParameters)
      Return a list of entities that match the supplied conditions. The results can be returned over many pages.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: a list of entities matching the supplied criteria null means no matching entities in the metadata collection or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the properties specified are not valid for any of the requested types of entity or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findEntitiesByProperty

      @PostMapping(path="/instances/entities/by-property") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse findEntitiesByProperty(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityPropertyFindRequest findRequestParameters)
      Return a list of entities that match the supplied properties according to the match criteria. The results can be returned over many pages.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: a list of entities matching the supplied criteria null means no matching entities in the metadata collection or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the properties specified are not valid for any of the requested types of entity or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findEntitiesByPropertyHistory

      @PostMapping(path="/instances/entities/by-property/history") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse findEntitiesByPropertyHistory(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityPropertyHistoricalFindRequest findRequestParameters)
      Return a list of entities that match the supplied properties according to the match criteria. The results can be returned over many pages.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: a list of entities matching the supplied criteria null means no matching entities in the metadata collection or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the properties specified are not valid for any of the requested types of entity or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findEntitiesByClassification

      @PostMapping(path="/instances/entities/by-classification/{classificationName}") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse findEntitiesByClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.PropertyMatchFindRequest findRequestParameters)
      Return a list of entities that have the requested type of classification attached.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      classificationName - name of the classification a null is not valid.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: a list of entities matching the supplied criteria, null means no matching entities in the metadata collection or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or ClassificationErrorException the classification request is not known to the metadata collection. PropertyErrorException the properties specified are not valid for the requested type of classification or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findEntitiesByClassificationHistory

      @PostMapping(path="/instances/entities/by-classification/{classificationName}/history") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse findEntitiesByClassificationHistory(@PathVariable String serverName, @PathVariable String userId, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.PropertyMatchHistoricalFindRequest findRequestParameters)
      Return a list of entities that have the requested type of classification attached.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      classificationName - name of the classification a null is not valid.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: a list of entities matching the supplied criteria, null means no matching entities in the metadata collection or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or ClassificationErrorException the classification request is not known to the metadata collection. PropertyErrorException the properties specified are not valid for the requested type of classification or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findEntitiesByPropertyValue

      @PostMapping(path="/instances/entities/by-property-value") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse findEntitiesByPropertyValue(@PathVariable String serverName, @PathVariable String userId, @RequestParam String searchCriteria, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityPropertyFindRequest findRequestParameters)
      Return a list of entities whose string based property values match the search criteria. The search criteria may include regex style wild cards.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      searchCriteria - String expression of the characteristics of the required relationships.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: a list of entities matching the supplied criteria, null means no matching entities in the metadata collection or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the sequencing property specified is not valid for any of the requested types of entity or PagingErrorException the paging/sequencing parameters are set up incorrectly. FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findEntitiesByPropertyValueHistory

      @PostMapping(path="/instances/entities/by-property-value/history") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse findEntitiesByPropertyValueHistory(@PathVariable String serverName, @PathVariable String userId, @RequestParam String searchCriteria, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityPropertyHistoricalFindRequest findRequestParameters)
      Return a list of entities whose string based property values match the search criteria. The search criteria may include regex style wild cards.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      searchCriteria - String expression of the characteristics of the required relationships.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: a list of entities matching the supplied criteria, null means no matching entities in the metadata collection or InvalidParameterException a parameter is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the sequencing property specified is not valid for any of the requested types of entity or PagingErrorException the paging/sequencing parameters are set up incorrectly. FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • isRelationshipKnown

      @GetMapping(path="/instances/relationship/{guid}/existence") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse isRelationshipKnown(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Returns a boolean indicating if the relationship is stored in the metadata collection.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique identifier for the relationship.
      Returns:
      RelationshipResponse: relationship details if the relationship is found in the metadata collection; otherwise return null or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getRelationship

      @GetMapping(path="/instances/relationship/{guid}") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse getRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return a requested relationship.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique identifier for the relationship.
      Returns:
      RelationshipResponse: a relationship structure or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the metadata collection does not have a relationship with the requested GUID stored or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getRelationship

      @PostMapping(path="/instances/relationship/{guid}/history") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse getRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.HistoryRequest asOfTime)
      Return a historical version of a relationship.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      guid - String unique identifier for the relationship.
      asOfTime - the time used to determine which version of the entity that is desired.
      Returns:
      RelationshipResponse: a relationship structure or InvalidParameterException the guid or date is null or the asOfTime property is for a future time or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the requested entity instance is not known in the metadata collection at the time requested or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findRelationships

      @PostMapping(path="/instances/relationships") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse findRelationships(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.InstanceFindRequest findRequestParameters)
      Return a list of relationships that match the requested conditions. The results can be broken into pages.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      RelationshipListResponse: a list of relationships. Null means no matching relationships or InvalidParameterException one of the parameters is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the properties specified are not valid for any of the requested types of relationships or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findRelationshipsByHistory

      @PostMapping(path="/instances/relationships/history") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse findRelationshipsByHistory(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.InstanceHistoricalFindRequest findRequestParameters)
      Return a list of relationships that match the requested conditions. The results can be broken into pages.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      RelationshipListResponse: a list of relationships. Null means no matching relationships or InvalidParameterException one of the parameters is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the properties specified are not valid for any of the requested types of relationships or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findRelationshipsByProperty

      @PostMapping(path="/instances/relationships/by-property") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse findRelationshipsByProperty(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.PropertyMatchFindRequest findRequestParameters)
      Return a list of relationships that match the requested properties by the matching criteria. The results can be broken into pages.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      RelationshipListResponse: a list of relationships. Null means no matching relationships or InvalidParameterException one of the parameters is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the properties specified are not valid for any of the requested types of relationships or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findRelationshipsByPropertyHistory

      @PostMapping(path="/instances/relationships/by-property/history") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse findRelationshipsByPropertyHistory(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.PropertyMatchHistoricalFindRequest findRequestParameters)
      Return a list of relationships that match the requested properties by the matching criteria. The results can be broken into pages.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      RelationshipListResponse: a list of relationships. Null means no matching relationships or InvalidParameterException one of the parameters is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException the properties specified are not valid for any of the requested types of relationships or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findRelationshipsByPropertyValue

      @PostMapping(path="/instances/relationships/by-property-value") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse findRelationshipsByPropertyValue(@PathVariable String serverName, @PathVariable String userId, @RequestParam String searchCriteria, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedFindRequest findRequestParameters)
      Return a list of relationships that match the search criteria. The results can be paged.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      searchCriteria - String expression of the characteristics of the required relationships.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      RelationshipListResponse: a list of relationships. Null means no matching relationships or InvalidParameterException one of the parameters is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException there is a problem with one of the other parameters or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • findRelationshipsByPropertyValueHistory

      @PostMapping(path="/instances/relationships/by-property-value/history") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse findRelationshipsByPropertyValueHistory(@PathVariable String serverName, @PathVariable String userId, @RequestParam String searchCriteria, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedHistoricalFindRequest findRequestParameters)
      Return a list of relationships that match the search criteria. The results can be paged.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      searchCriteria - String expression of the characteristics of the required relationships.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      RelationshipListResponse: a list of relationships. Null means no matching relationships or InvalidParameterException one of the parameters is invalid or null or TypeErrorException the type guid passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or PropertyErrorException there is a problem with one of the other parameters or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getLinkingEntities

      @PostMapping(path="/instances/entities/from-entity/{startEntityGUID}/by-linkage") public org.odpi.openmetadata.repositoryservices.rest.properties.InstanceGraphResponse getLinkingEntities(@PathVariable String serverName, @PathVariable String userId, @PathVariable String startEntityGUID, @RequestParam String endEntityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest findRequestParameters)
      Return all the relationships and intermediate entities that connect the startEntity with the endEntity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      startEntityGUID - The entity that is used to anchor the query.
      endEntityGUID - the other entity that defines the scope of the query.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      InstanceGraphResponse: the sub-graph that represents the returned linked entities and their relationships or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by either the startEntityGUID or the endEntityGUID is not found in the metadata collection or PropertyErrorException there is a problem with one of the other parameters or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getLinkingEntitiesHistory

      @PostMapping(path="/instances/entities/from-entity/{startEntityGUID}/by-linkage/history") public org.odpi.openmetadata.repositoryservices.rest.properties.InstanceGraphResponse getLinkingEntitiesHistory(@PathVariable String serverName, @PathVariable String userId, @PathVariable String startEntityGUID, @RequestParam String endEntityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIHistoricalFindRequest findRequestParameters)
      Return all the relationships and intermediate entities that connect the startEntity with the endEntity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      startEntityGUID - The entity that is used to anchor the query.
      endEntityGUID - the other entity that defines the scope of the query.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      InstanceGraphResponse: the sub-graph that represents the returned linked entities and their relationships or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by either the startEntityGUID or the endEntityGUID is not found in the metadata collection or PropertyErrorException there is a problem with one of the other parameters or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getEntityNeighborhood

      @PostMapping(path="/instances/entities/from-entity/{entityGUID}/by-neighborhood") public org.odpi.openmetadata.repositoryservices.rest.properties.InstanceGraphResponse getEntityNeighborhood(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @RequestParam int level, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityNeighborhoodFindRequest findRequestParameters)
      Return the entities and relationships that radiate out from the supplied entity GUID. The results are scoped both the instance type guids and the level.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - the starting point of the query.
      level - the number of the relationships out from the starting entity that the query will traverse to gather results.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      InstanceGraphResponse the sub-graph that represents the returned linked entities and their relationships or InvalidParameterException one of the parameters is invalid or null or TypeErrorException one of the type guids passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the entityGUID is not found in the metadata collection or PropertyErrorException there is a problem with one of the other parameters or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getEntityNeighborhoodHistory

      @PostMapping(path="/instances/entities/from-entity/{entityGUID}/by-neighborhood/history") public org.odpi.openmetadata.repositoryservices.rest.properties.InstanceGraphResponse getEntityNeighborhoodHistory(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @RequestParam int level, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityNeighborhoodHistoricalFindRequest findRequestParameters)
      Return the entities and relationships that radiate out from the supplied entity GUID. The results are scoped both the instance type guids and the level.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - the starting point of the query.
      level - the number of the relationships out from the starting entity that the query will traverse to gather results.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      InstanceGraphResponse the sub-graph that represents the returned linked entities and their relationships or InvalidParameterException one of the parameters is invalid or null or TypeErrorException one of the type guids passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the entityGUID is not found in the metadata collection or PropertyErrorException there is a problem with one of the other parameters or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getRelatedEntities

      @PostMapping(path="/instances/entities/from-entity/{startEntityGUID}/by-relationship") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse getRelatedEntities(@PathVariable String serverName, @PathVariable String userId, @PathVariable String startEntityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.RelatedEntitiesFindRequest findRequestParameters)
      Return the list of entities that are of the types listed in instanceTypes and are connected, either directly or indirectly to the entity identified by startEntityGUID.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      startEntityGUID - unique identifier of the starting entity.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: list of entities either directly or indirectly connected to the start entity or InvalidParameterException one of the parameters is invalid or null or TypeErrorException one of the type guids passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection or EntityNotKnownException the entity identified by the startEntityGUID is not found in the metadata collection or PropertyErrorException the sequencing property specified is not valid for any of the requested types of entity or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getRelatedEntitiesHistory

      @PostMapping(path="/instances/entities/from-entity/{startEntityGUID}/by-relationship/history") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityListResponse getRelatedEntitiesHistory(@PathVariable String serverName, @PathVariable String userId, @PathVariable String startEntityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.RelatedEntitiesHistoricalFindRequest findRequestParameters)
      Return the list of entities that are of the types listed in instanceTypes and are connected, either directly or indirectly to the entity identified by startEntityGUID.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      startEntityGUID - unique identifier of the starting entity.
      findRequestParameters - find parameters used to limit the returned results.
      Returns:
      EntityListResponse: list of entities either directly or indirectly connected to the start entity or InvalidParameterException one of the parameters is invalid or null or TypeErrorException one of the type guids passed on the request is not known by the metadata collection or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection or EntityNotKnownException the entity identified by the startEntityGUID is not found in the metadata collection or PropertyErrorException the sequencing property specified is not valid for any of the requested types of entity or PagingErrorException the paging/sequencing parameters are set up incorrectly or FunctionNotSupportedException the repository does not support asOfTime parameter or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • addEntity

      @PostMapping(path="/instances/entity") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse addEntity(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityCreateRequest requestBody)
      Create a new entity and put it in the requested state. The new entity is returned.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      requestBody - parameters for the new entity
      Returns:
      EntityDetailResponse: EntityDetail showing the new header plus the requested properties and classifications. The entity will not have any relationships at this stage or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this entity's type or ClassificationErrorException one or more of the requested classifications are either not known or not defined for this entity type or StatusNotSupportedException the metadata repository hosting the metadata collection does not support the requested status or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • addExternalEntity

      @PostMapping(path="/instances/entity/external") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse addExternalEntity(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.EntityCreateRequest requestBody)
      Save a new entity that is sourced from an external technology. The external technology is identified by a GUID and a name. These can be recorded in a Software Server Capability (guid and qualifiedName respectively). The new entity is assigned a new GUID and put in the requested state. The new entity is returned.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      requestBody - parameters for the new entity
      Returns:
      EntityDetailResponse: EntityDetail showing the new header plus the requested properties and classifications. The entity will not have any relationships at this stage or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this entity's type or ClassificationErrorException one or more of the requested classifications are either not known or not defined for this entity type or StatusNotSupportedException the metadata repository hosting the metadata collection does not support the requested status or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • addEntityProxy

      @PostMapping(path="/instances/entity-proxy") public org.odpi.openmetadata.repositoryservices.rest.properties.VoidResponse addEntityProxy(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityProxy)
      Create an entity proxy in the metadata collection. This is used to store relationships that span metadata repositories.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityProxy - details of entity to add.
      Returns:
      VoidResponse: void or InvalidParameterException the entity proxy is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this entity's type or ClassificationErrorException one or more of the requested classifications are either not known or not defined for this entity type or StatusNotSupportedException the metadata repository hosting the metadata collection does not support the requested status or FunctionNotSupportedException the repository does not support entity proxies as first class elements or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • updateEntityStatus

      @PostMapping(path="/instances/entity/{entityGUID}/status") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse updateEntityStatus(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus newStatus)
      Update the status for a specific entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - unique identifier (guid) for the requested entity.
      newStatus - new InstanceStatus for the entity.
      Returns:
      EntityDetailResponse: EntityDetail showing the current entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection. StatusNotSupportedException the metadata repository hosting the metadata collection does not support the requested status or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • updateEntityProperties

      @PostMapping(path="/instances/entity/{entityGUID}/properties") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse updateEntityProperties(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.InstancePropertiesRequest propertiesRequestBody)
      Update selected properties in an entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - String unique identifier (guid) for the entity.
      propertiesRequestBody - a list of properties to change.
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this entity's type or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • undoEntityUpdate

      @GetMapping(path="/instances/entity/{entityGUID}/previous") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse undoEntityUpdate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID)
      Undo the last update to an entity and return the previous content.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - String unique identifier (guid) for the entity.
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or FunctionNotSupportedException the repository does not support undo or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • deleteEntity

      @PostMapping(path="/instances/entity/{obsoleteEntityGUID}/delete") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse deleteEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String obsoleteEntityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefValidationForRequest typeDefValidationForRequest)
      Delete an entity. The entity is soft-deleted. This means it is still in the graph, but it is no longer returned on queries. All relationships to the entity are also soft-deleted and will no longer be usable. To completely eliminate the entity from the graph requires a call to the purgeEntity() method after the delete() call. The restoreEntity() method will switch an entity back to Active status to restore the entity to normal use.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      obsoleteEntityGUID - String unique identifier (guid) for the entity.
      typeDefValidationForRequest - information about the type used to confirm the right instance is specified.
      Returns:
      EntityDetailResponse details of the deleted entity or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or FunctionNotSupportedException the metadata repository hosting the metadata collection does not support soft-deletes (use purgeEntity() to remove the entity permanently) or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • purgeEntity

      @PostMapping(path="/instances/entity/{deletedEntityGUID}/purge") public org.odpi.openmetadata.repositoryservices.rest.properties.VoidResponse purgeEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String deletedEntityGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefValidationForRequest typeDefValidationForRequest)
      Permanently removes a deleted entity from the metadata collection. This request can not be undone.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      deletedEntityGUID - String unique identifier (guid) for the entity.
      typeDefValidationForRequest - information about the type used to confirm the right instance is specified.
      Returns:
      VoidResponse: void or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or EntityNotDeletedException the entity is not in DELETED status and so can not be purged or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • restoreEntity

      @GetMapping(path="/instances/entity/{deletedEntityGUID}/restore") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse restoreEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String deletedEntityGUID)
      Restore the requested entity to the state it was before it was deleted.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      deletedEntityGUID - String unique identifier (guid) for the entity.
      Returns:
      EntityDetailResponse: EntityDetail showing the restored entity header, properties and classifications or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or EntityNotDeletedException the entity is currently not in DELETED status and so it can not be restored or FunctionNotSupportedException the repository does not support soft-delete or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • classifyEntity

      @PostMapping(path="/instances/entity/{entityGUID}/classification/{classificationName}") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse classifyEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.InstancePropertiesRequest propertiesRequestBody)
      Add the requested classification to a specific entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - String unique identifier (guid) for the entity.
      classificationName - String name for the classification.
      propertiesRequestBody - list of properties to set in the classification.
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or ClassificationErrorException the requested classification is either not known or not valid for the entity or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this classification type or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • classifyEntity

      @PostMapping(path="/instances/entity/classification/{classificationName}") public org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationResponse classifyEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.ProxyClassificationRequest requestBody)
      Add the requested classification to a specific entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      classificationName - String name for the classification.
      requestBody - list of properties to set in the classification.
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or ClassificationErrorException the requested classification is either not known or not valid for the entity or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this classification type or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • classifyEntity

      @PostMapping(path="/instances/entity/{entityGUID}/classification/{classificationName}/detailed") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse classifyEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationRequest classificationRequestBody)
      Add the requested classification to a specific entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - String unique identifier (guid) for the entity.
      classificationName - String name for the classification.
      classificationRequestBody - values for the classification.
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or ClassificationErrorException the requested classification is either not known or not valid for the entity or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this classification type or FunctionNotSupportedException the repository does not support maintenance of metadata. UserNotAuthorizedException the userId is not permitted to perform this operation.

    • classifyEntity

      @PostMapping(path="/instances/entity/classification/{classificationName}/detailed") public org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationResponse classifyEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationProxyRequest requestBody)
      Add the requested classification to a specific entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      classificationName - String name for the classification.
      requestBody - values for the classification.
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or ClassificationErrorException the requested classification is either not known or not valid for the entity or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this classification type or FunctionNotSupportedException the repository does not support maintenance of metadata. UserNotAuthorizedException the userId is not permitted to perform this operation.

    • declassifyEntity

      @PostMapping(path="/instances/entity/{entityGUID}/classification/{classificationName}/delete") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse declassifyEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @PathVariable String classificationName, @RequestBody(required=false) org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest requestBody)
      Remove a specific classification from an entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - String unique identifier (guid) for the entity.
      classificationName - String name for the classification.
      requestBody - empty request body
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection ClassificationErrorException the requested classification is not set on the entity or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • declassifyEntity

      @PostMapping(path="/instances/entity/classification/{classificationName}/delete") public org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationResponse declassifyEntity(@PathVariable String serverName, @PathVariable String userId, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy requestBody)
      Remove a specific classification from an entity.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      classificationName - String name for the classification.
      requestBody - entity proxy request body
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection ClassificationErrorException the requested classification is not set on the entity or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • updateEntityClassification

      @PostMapping(path="/instances/entity/{entityGUID}/classification/{classificationName}/properties") public org.odpi.openmetadata.repositoryservices.rest.properties.EntityDetailResponse updateEntityClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String entityGUID, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.InstancePropertiesRequest propertiesRequestBody)
      Update one or more properties in one of an entity's classifications.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      entityGUID - String unique identifier (guid) for the entity.
      classificationName - String name for the classification.
      propertiesRequestBody - list of properties for the classification.
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or ClassificationErrorException the requested classification is not attached to the classification or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this classification type or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • updateEntityClassification

      @PostMapping(path="/instances/entity/classification/{classificationName}/properties") public org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationResponse updateEntityClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String classificationName, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.ProxyClassificationRequest requestBody)
      Update one or more properties in one of an entity's classifications.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      classificationName - String name for the classification.
      requestBody - list of properties for the classification.
      Returns:
      EntityDetailResponse: EntityDetail showing the resulting entity header, properties and classifications or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity identified by the guid is not found in the metadata collection or ClassificationErrorException the requested classification is not attached to the classification or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this classification type or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • addRelationship

      @PostMapping(path="/instances/relationship") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse addRelationship(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipCreateRequest createRequestParameters)
      Add a new relationship between two entities to the metadata collection.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      createRequestParameters - parameters used to fill out the new relationship
      Returns:
      RelationshipResponse: Relationship structure with the new header, requested entities and properties or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this relationship's type or EntityNotKnownException one of the requested entities is not known in the metadata collection or StatusNotSupportedException the metadata repository hosting the metadata collection does not support the requested status or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • addExternalRelationship

      @PostMapping(path="/instances/relationship/external") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse addExternalRelationship(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipCreateRequest createRequestParameters)
      Save a new relationship that is sourced from an external technology. The external technology is identified by a GUID and a name. These can be recorded in a Software Server Capability (guid and qualifiedName respectively). The new relationship is assigned a new GUID and put in the requested state. The new relationship is returned.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      createRequestParameters - parameters used to fill out the new relationship
      Returns:
      RelationshipResponse: Relationship structure with the new header, requested entities and properties or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this relationship's type or EntityNotKnownException one of the requested entities is not known in the metadata collection or StatusNotSupportedException the metadata repository hosting the metadata collection does not support the requested status or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • updateRelationshipStatus

      @PostMapping(path="/instances/relationship/{relationshipGUID}/status") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse updateRelationshipStatus(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus newStatus)
      Update the status of a specific relationship.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      relationshipGUID - String unique identifier (guid) for the relationship.
      newStatus - new InstanceStatus for the relationship.
      Returns:
      RelationshipResponse: Resulting relationship structure with the new status set or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the requested relationship is not known in the metadata collection or StatusNotSupportedException the metadata repository hosting the metadata collection does not support the requested status or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • updateRelationshipProperties

      @PostMapping(path="/instances/relationship/{relationshipGUID}/properties") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse updateRelationshipProperties(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.InstancePropertiesRequest propertiesRequestBody)
      Update the properties of a specific relationship.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      relationshipGUID - String unique identifier (guid) for the relationship.
      propertiesRequestBody - list of the properties to update.
      Returns:
      RelationshipResponse: Resulting relationship structure with the new properties set or InvalidParameterException one of the parameters is invalid or null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the requested relationship is not known in the metadata collection or PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this relationship's type or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • undoRelationshipUpdate

      @GetMapping(path="/instances/relationship/{relationshipGUID}/previous") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse undoRelationshipUpdate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipGUID)
      Undo the latest change to a relationship (either a change of properties or status).
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      relationshipGUID - String unique identifier (guid) for the relationship.
      Returns:
      RelationshipResponse: Relationship structure with the new current header, requested entities and properties or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the requested relationship is not known in the metadata collection or FunctionNotSupportedException the repository does not support undo or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • deleteRelationship

      @PostMapping(path="/instances/relationship/{obsoleteRelationshipGUID}/delete") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse deleteRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String obsoleteRelationshipGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefValidationForRequest typeDefValidationForRequest)
      Delete a specific relationship. This is a soft-delete which means the relationship's status is updated to DELETED, and it is no longer available for queries. To remove the relationship permanently from the metadata collection, use purgeRelationship().
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      obsoleteRelationshipGUID - String unique identifier (guid) for the relationship.
      typeDefValidationForRequest - information about the type used to confirm the right instance is specified.
      Returns:
      RelationshipResponse: Updated relationship or InvalidParameterException one of the parameters is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the requested relationship is not known in the metadata collection or FunctionNotSupportedException the metadata repository hosting the metadata collection does not support soft-deletes or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • purgeRelationship

      @PostMapping(path="/instances/relationship/{deletedRelationshipGUID}/purge") public org.odpi.openmetadata.repositoryservices.rest.properties.VoidResponse purgeRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String deletedRelationshipGUID, @RequestBody org.odpi.openmetadata.repositoryservices.rest.properties.TypeDefValidationForRequest typeDefValidationForRequest)
      Permanently delete the relationship from the repository. There is no means to undo this request.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      deletedRelationshipGUID - String unique identifier (guid) for the relationship.
      typeDefValidationForRequest - information about the type used to confirm the right instance is specified.
      Returns:
      VoidResponse: void or InvalidParameterException one of the parameters is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the requested relationship is not known in the metadata collection or RelationshipNotDeletedException the requested relationship is not in DELETED status or UserNotAuthorizedException the userId is not permitted to perform this operation.

    • restoreRelationship

      @GetMapping(path="/instances/relationship/{deletedRelationshipGUID}/restore") public org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipResponse restoreRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String deletedRelationshipGUID)
      Restore a deleted relationship into the metadata collection. The new status will be ACTIVE and the restored details of the relationship are returned to the caller.
      Parameters:
      serverName - unique identifier for requested server.
      userId - unique identifier for requesting user.
      deletedRelationshipGUID - String unique identifier (guid) for the relationship.
      Returns:
      RelationshipResponse: Relationship structure with the restored header, requested entities and properties or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the requested relationship is not known in the metadata collection or RelationshipNotDeletedException the requested relationship is not in DELETED status or FunctionNotSupportedException the repository does not support soft-deletes UserNotAuthorizedException the userId is not permitted to perform this operation.

    • getEnterpriseOMRSTopicConnection

      @GetMapping(path="/remote-topic-connection") public org.odpi.openmetadata.repositoryservices.rest.properties.ConnectionResponse getEnterpriseOMRSTopicConnection(@PathVariable String serverName, @PathVariable String userId)
      Return the connection for remote access to the enterprise topic connector. May be null if remote access to this topic is not configured in the OMAG Server.
      Parameters:
      serverName - unique identifier for requested server
      userId - unique identifier for requesting server
      Returns:
      null or connection object or InvalidParameterException unknown servername UserNotAuthorizedException unsupported userId RepositoryErrorException null local repository