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

Class LocalRepositoryServicesResource

java.lang.Object

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

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/repository-services/users/{userId}")
public class LocalRepositoryServicesResource
extends Object

LocalRepositoryServicesResource provides the server-side support for the OMRS Repository REST Services API that are directed to the local repository.

Constructor Summary

Constructors

Constructor	Description
LocalRepositoryServicesResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	addAttributeTypeDef(String serverName, String userId, AttributeTypeDef newAttributeTypeDef)	Create a definition of a new AttributeTypeDef.
EntityDetailResponse	addEntity(String serverName, String userId, EntityCreateRequest requestBody)	Create a new entity and put it in the requested state.
VoidResponse	addEntityProxy(String serverName, String userId, EntityProxy entityProxy)	Create an entity proxy in the metadata collection.
EntityDetailResponse	addExternalEntity(String serverName, String userId, EntityCreateRequest requestBody)	Save a new entity that is sourced from an external technology.
RelationshipResponse	addExternalRelationship(String serverName, String userId, RelationshipCreateRequest createRequestParameters)	Save a new relationship that is sourced from an external technology.
RelationshipResponse	addRelationship(String serverName, String userId, RelationshipCreateRequest createRequestParameters)	Add a new relationship between two entities to the metadata collection.
VoidResponse	addTypeDef(String serverName, String userId, TypeDef newTypeDef)	Create a definition of a new TypeDef.
VoidResponse	addTypeDefGallery(String serverName, String userId, TypeDefGallery newTypes)	Create a collection of related types.
EntityDetailResponse	classifyEntity(String serverName, String userId, String entityGUID, String classificationName, ClassificationRequest classificationRequestBody)	Add the requested classification to a specific entity.
EntityDetailResponse	classifyEntity(String serverName, String userId, String entityGUID, String classificationName, InstancePropertiesRequest propertiesRequestBody)	Add the requested classification to a specific entity.
ClassificationResponse	classifyEntity(String serverName, String userId, String classificationName, ClassificationProxyRequest requestBody)	Add the requested classification to a specific entity.
ClassificationResponse	classifyEntity(String serverName, String userId, String classificationName, ProxyClassificationRequest requestBody)	Add the requested classification to a specific entity.
EntityDetailResponse	declassifyEntity(String serverName, String userId, String entityGUID, String classificationName, OMRSAPIRequest requestBody)	Remove a specific classification from an entity.
ClassificationResponse	declassifyEntity(String serverName, String userId, String classificationName, EntityProxy requestBody)	Remove a specific classification from an entity.
VoidResponse	deleteAttributeTypeDef(String serverName, String userId, String guid, String name)	Delete an AttributeTypeDef.
EntityDetailResponse	deleteEntity(String serverName, String userId, String obsoleteEntityGUID, TypeDefValidationForRequest typeDefValidationForRequest)	Delete an entity.
VoidResponse	deleteEntityReferenceCopy(String serverName, String userId, EntityDetail entity)	Remove a reference copy of the entity from the local repository.
RelationshipResponse	deleteRelationship(String serverName, String userId, String obsoleteRelationshipGUID, TypeDefValidationForRequest typeDefValidationForRequest)	Delete a specific relationship.
VoidResponse	deleteRelationshipReferenceCopy(String serverName, String userId, Relationship relationship)	Remove the reference copy of the relationship from the local repository.
VoidResponse	deleteTypeDef(String serverName, String userId, String guid, String name)	Delete the TypeDef.
AttributeTypeDefListResponse	findAttributeTypeDefsByCategory(String serverName, String userId, AttributeTypeDefCategory category)	Returns all the AttributeTypeDefs for a specific category.
EntityListResponse	findEntities(String serverName, String userId, EntityFindRequest findRequestParameters)	Return a list of entities that match the supplied conditions.
EntityListResponse	findEntitiesByClassification(String serverName, String userId, String classificationName, PropertyMatchFindRequest findRequestParameters)	Return a list of entities that have the requested type of classification attached.
EntityListResponse	findEntitiesByClassificationHistory(String serverName, String userId, String classificationName, PropertyMatchHistoricalFindRequest findRequestParameters)	Return a list of entities that have the requested type of classification attached.
EntityListResponse	findEntitiesByHistory(String serverName, String userId, EntityHistoricalFindRequest findRequestParameters)	Return a list of entities that match the supplied conditions.
EntityListResponse	findEntitiesByProperty(String serverName, String userId, EntityPropertyFindRequest findRequestParameters)	Return a list of entities that match the supplied properties according to the match criteria.
EntityListResponse	findEntitiesByPropertyHistory(String serverName, String userId, EntityPropertyHistoricalFindRequest findRequestParameters)	Return a list of entities that match the supplied properties according to the match criteria.
EntityListResponse	findEntitiesByPropertyValue(String serverName, String userId, String searchCriteria, EntityPropertyFindRequest findRequestParameters)	Return a list of entities whose string based property values match the search criteria.
EntityListResponse	findEntitiesByPropertyValueHistory(String serverName, String userId, String searchCriteria, EntityPropertyHistoricalFindRequest findRequestParameters)	Return a list of entities whose string based property values match the search criteria.
RelationshipListResponse	findRelationships(String serverName, String userId, InstanceFindRequest findRequestParameters)	Return a list of relationships that match the requested conditions.
RelationshipListResponse	findRelationshipsByHistory(String serverName, String userId, InstanceHistoricalFindRequest findRequestParameters)	Return a list of relationships that match the requested conditions.
RelationshipListResponse	findRelationshipsByProperty(String serverName, String userId, PropertyMatchFindRequest findRequestParameters)	Return a list of relationships that match the requested properties by the matching criteria.
RelationshipListResponse	findRelationshipsByPropertyHistory(String serverName, String userId, PropertyMatchHistoricalFindRequest findRequestParameters)	Return a list of relationships that match the requested properties by the matching criteria.
RelationshipListResponse	findRelationshipsByPropertyValue(String serverName, String userId, String searchCriteria, TypeLimitedFindRequest findRequestParameters)	Return a list of relationships that match the search criteria.
RelationshipListResponse	findRelationshipsByPropertyValueHistory(String serverName, String userId, String searchCriteria, TypeLimitedHistoricalFindRequest findRequestParameters)	Return a list of relationships that match the search criteria.
TypeDefListResponse	findTypeDefsByCategory(String serverName, String userId, TypeDefCategory category)	Returns all the TypeDefs for a specific category.
TypeDefListResponse	findTypeDefsByProperty(String serverName, String userId, TypeDefProperties matchCriteria)	Return the TypeDefs that have the properties matching the supplied match criteria.
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.
TypeDefGalleryResponse	findTypesByName(String serverName, String userId, String name)	Returns a list of type definitions that have the specified name.
TypeDefGalleryResponse	getAllTypes(String serverName, String userId)	Returns the list of different types of metadata organized into two groups.
AttributeTypeDefResponse	getAttributeTypeDefByGUID(String serverName, String userId, String guid)	Return the AttributeTypeDef identified by the GUID.
AttributeTypeDefResponse	getAttributeTypeDefByName(String serverName, String userId, String name)	Return the AttributeTypeDef identified by the unique name.
EntityDetailResponse	getEntityDetail(String serverName, String userId, String guid)	Return the header, classifications and properties of a specific entity.
EntityDetailResponse	getEntityDetail(String serverName, String userId, String guid, HistoryRequest asOfTime)	Return a historical version of an entity includes the header, classifications and properties of the entity.
EntityListResponse	getEntityDetailHistory(String serverName, String userId, String guid, HistoryRangeRequest historyRangeRequest)	Return all historical versions of an entity within the bounds of the provided timestamps.
InstanceGraphResponse	getEntityNeighborhood(String serverName, String userId, String entityGUID, int level, EntityNeighborhoodFindRequest findRequestParameters)	Return the entities and relationships that radiate out from the supplied entity GUID.
InstanceGraphResponse	getEntityNeighborhoodHistory(String serverName, String userId, String entityGUID, int level, EntityNeighborhoodHistoricalFindRequest findRequestParameters)	Return the entities and relationships that radiate out from the supplied entity GUID.
EntitySummaryResponse	getEntitySummary(String serverName, String userId, String guid)	Return the header and classifications for a specific entity.
ClassificationListResponse	getHomeClassifications(String serverName, String userId, String entityGUID)	Retrieve any locally homed classifications assigned to the requested entity.
ClassificationListResponse	getHomeClassifications(String serverName, String userId, String entityGUID, HistoryRequest requestBody)	Retrieve any locally homed classifications assigned to the requested entity.
InstanceGraphResponse	getLinkingEntities(String serverName, String userId, String startEntityGUID, String endEntityGUID, OMRSAPIFindRequest findRequestParameters)	Return all the relationships and intermediate entities that connect the startEntity with the endEntity.
InstanceGraphResponse	getLinkingEntitiesHistory(String serverName, String userId, String startEntityGUID, String endEntityGUID, OMRSAPIHistoricalFindRequest findRequestParameters)	Return all the relationships and intermediate entities that connect the startEntity with the endEntity.
MetadataCollectionIdResponse	getMetadataCollectionId(String serverName, String userId)	Returns the identifier of the metadata repository.
EntityListResponse	getRelatedEntities(String serverName, String userId, String startEntityGUID, 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.
EntityListResponse	getRelatedEntitiesHistory(String serverName, String userId, String startEntityGUID, 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.
RelationshipResponse	getRelationship(String serverName, String userId, String guid)	Return a requested relationship.
RelationshipResponse	getRelationship(String serverName, String userId, String guid, HistoryRequest asOfTime)	Return a historical version of a relationship.
RelationshipListResponse	getRelationshipHistory(String serverName, String userId, String guid, HistoryRangeRequest historyRangeRequest)	Return all historical versions of a relationship within the bounds of the provided timestamps.
RelationshipListResponse	getRelationshipsForEntity(String serverName, String userId, String entityGUID, TypeLimitedFindRequest findRequestParameters)	Return the relationships for a specific entity.
RelationshipListResponse	getRelationshipsForEntityHistory(String serverName, String userId, String entityGUID, TypeLimitedHistoricalFindRequest findRequestParameters)	Return the relationships for a specific entity.
TypeDefResponse	getTypeDefByGUID(String serverName, String userId, String guid)	Return the TypeDef identified by the GUID.
TypeDefResponse	getTypeDefByName(String serverName, String userId, String name)	Return the TypeDef identified by the unique name.
EntityDetailResponse	isEntityKnown(String serverName, String userId, String guid)	Returns a boolean indicating if the entity is stored in the metadata collection.
RelationshipResponse	isRelationshipKnown(String serverName, String userId, String guid)	Returns a boolean indicating if the relationship is stored in the metadata collection.
VoidResponse	purgeClassificationReferenceCopy(String serverName, String userId, ClassificationWithEntityRequest requestBody)	Remove the reference copy of the classification from the local repository.
VoidResponse	purgeEntity(String serverName, String userId, String deletedEntityGUID, TypeDefValidationForRequest typeDefValidationForRequest)	Permanently removes a deleted entity from the metadata collection.
VoidResponse	purgeEntityReferenceCopy(String serverName, String userId, String entityGUID, String homeMetadataCollectionId, TypeDefValidationForRequest typeDefValidationForRequest)	Remove a reference copy of the entity from the local repository.
VoidResponse	purgeEntityReferenceCopy(String serverName, String userId, EntityDetail entity)	Remove a reference copy of the entity from the local repository.
VoidResponse	purgeRelationship(String serverName, String userId, String deletedRelationshipGUID, TypeDefValidationForRequest typeDefValidationForRequest)	Permanently delete the relationship from the repository.
VoidResponse	purgeRelationshipReferenceCopy(String serverName, String userId, String relationshipGUID, String homeMetadataCollectionId, TypeDefValidationForRequest typeDefValidationForRequest)	Remove the reference copy of the relationship from the local repository.
VoidResponse	purgeRelationshipReferenceCopy(String serverName, String userId, Relationship relationship)	Remove the reference copy of the relationship from the local repository.
VoidResponse	refreshEntityReferenceCopy(String serverName, String userId, String entityGUID, String homeMetadataCollectionId, TypeDefValidationForRequest typeDefValidationForRequest)	The local repository has requested that the repository that hosts the home metadata collection for the specified entity sends out the details of this entity so the local repository can create a reference copy.
VoidResponse	refreshRelationshipReferenceCopy(String serverName, String userId, String relationshipGUID, String homeMetadataCollectionId, TypeDefValidationForRequest typeDefValidationForRequest)	The local repository has requested that the repository that hosts the home metadata collection for the specified relationship sends out the details of this relationship so the local repository can create a reference copy.
EntityDetailResponse	reHomeEntity(String serverName, String userId, String entityGUID, String homeMetadataCollectionId, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName, TypeDefValidationForRequest typeDefValidationForRequest)	Change the home of an existing entity.
RelationshipResponse	reHomeRelationship(String serverName, String userId, String relationshipGUID, String homeMetadataCollectionId, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName, TypeDefValidationForRequest typeDefValidationForRequest)	Change the home of an existing relationship.
AttributeTypeDefResponse	reIdentifyAttributeTypeDef(String serverName, String userId, String originalAttributeTypeDefGUID, TypeDefReIdentifyRequest requestParameters)	Change the guid or name of an existing TypeDef to a new value.
EntityDetailResponse	reIdentifyEntity(String serverName, String userId, String entityGUID, String newEntityGUID, TypeDefValidationForRequest typeDefValidationForRequest)	Change the guid of an existing entity to a new value.
RelationshipResponse	reIdentifyRelationship(String serverName, String userId, String relationshipGUID, String newRelationshipGUID, TypeDefValidationForRequest typeDefValidationForRequest)	Change the guid of an existing relationship.
TypeDefResponse	reIdentifyTypeDef(String serverName, String userId, String originalTypeDefGUID, TypeDefReIdentifyRequest requestParameters)	Change the guid or name of an existing TypeDef to a new value.
EntityDetailResponse	restoreEntity(String serverName, String userId, String deletedEntityGUID)	Restore the requested entity to the state it was before it was deleted.
RelationshipResponse	restoreRelationship(String serverName, String userId, String deletedRelationshipGUID)	Restore a deleted relationship into the metadata collection.
EntityDetailResponse	reTypeEntity(String serverName, String userId, String entityGUID, TypeDefChangeRequest typeDefChangeRequest)	Change an existing entity's type.
RelationshipResponse	reTypeRelationship(String serverName, String userId, String relationshipGUID, TypeDefChangeRequest typeDefChangeRequest)	Change an existing relationship's type.
VoidResponse	saveClassificationReferenceCopy(String serverName, String userId, ClassificationWithEntityRequest requestBody)	Save the classification as a reference copy.
VoidResponse	saveEntityReferenceCopy(String serverName, String userId, EntityDetail entity)	Save the entity as a reference copy.
VoidResponse	saveInstanceReferenceCopies(String serverName, String userId, InstanceGraphRequest instances)	Save the entities and relationships supplied in the instance graph as a reference copies.
VoidResponse	saveRelationshipReferenceCopy(String serverName, String userId, Relationship relationship)	Save the relationship as a reference copy.
TypeDefListResponse	searchForTypeDefs(String serverName, String userId, String searchCriteria)	Return the TypeDefs that match the search criteria.
EntityDetailResponse	undoEntityUpdate(String serverName, String userId, String entityGUID)	Undo the last update to an entity and return the previous content.
RelationshipResponse	undoRelationshipUpdate(String serverName, String userId, String relationshipGUID)	Undo the latest change to a relationship (either a change of properties or status).
EntityDetailResponse	updateEntityClassification(String serverName, String userId, String entityGUID, String classificationName, InstancePropertiesRequest propertiesRequestBody)	Update one or more properties in one of an entity's classifications.
ClassificationResponse	updateEntityClassification(String serverName, String userId, String classificationName, ProxyClassificationRequest requestBody)	Update one or more properties in one of an entity's classifications.
EntityDetailResponse	updateEntityProperties(String serverName, String userId, String entityGUID, InstancePropertiesRequest propertiesRequestBody)	Update selected properties in an entity.
EntityDetailResponse	updateEntityStatus(String serverName, String userId, String entityGUID, InstanceStatus newStatus)	Update the status for a specific entity.
RelationshipResponse	updateRelationshipProperties(String serverName, String userId, String relationshipGUID, InstancePropertiesRequest propertiesRequestBody)	Update the properties of a specific relationship.
RelationshipResponse	updateRelationshipStatus(String serverName, String userId, String relationshipGUID, InstanceStatus newStatus)	Update the status of a specific relationship.
TypeDefResponse	updateTypeDef(String serverName, String userId, TypeDefPatch typeDefPatch)	Update one or more properties of the TypeDef.
BooleanResponse	verifyAttributeTypeDef(String serverName, String userId, AttributeTypeDef attributeTypeDef)	Verify that a definition of an AttributeTypeDef is either new or matches the definition already stored.
BooleanResponse	verifyTypeDef(String serverName, String userId, 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

LocalRepositoryServicesResource

public LocalRepositoryServicesResource()

Default constructor

Method Details

getMetadataCollectionId

@GetMapping(path="/metadata-collection-id")
public 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 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 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 TypeDefListResponse findTypeDefsByCategory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 AttributeTypeDefListResponse findAttributeTypeDefsByCategory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 TypeDefListResponse findTypeDefsByProperty(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 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 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 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 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 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 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.

addTypeDefGallery

@PostMapping(path="/types")
public VoidResponse addTypeDefGallery(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 TypeDefGallery newTypes)

Create a collection of related types.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

newTypes - TypeDefGalleryResponse structure describing the new AttributeTypeDefs and TypeDefs.

Returns:

VoidResponse: void or InvalidParameterException the new 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 TypeDefKnownException the TypeDef is already stored in the repository or TypeDefConflictException the new TypeDef conflicts with an existing TypeDef or InvalidTypeDefException the new TypeDef has invalid contents or FunctionNotSupportedException the repository does not support this call or UserNotAuthorizedException the userId is not permitted to perform this operation.

addTypeDef

@PostMapping(path="/types/typedef")
public VoidResponse addTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 TypeDef newTypeDef)

Create a definition of a new TypeDef.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

newTypeDef - TypeDef structure describing the new TypeDef.

Returns:

VoidResponse: void or InvalidParameterException the new 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 TypeDefKnownException the TypeDef is already stored in the repository or TypeDefConflictException the new TypeDef conflicts with an existing TypeDef or InvalidTypeDefException the new TypeDef has invalid contents or FunctionNotSupportedException the repository does not support this call or UserNotAuthorizedException the userId is not permitted to perform this operation.

addAttributeTypeDef

@PostMapping(path="/types/attribute-typedef")
public VoidResponse addAttributeTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 AttributeTypeDef newAttributeTypeDef)

Create a definition of a new AttributeTypeDef.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

newAttributeTypeDef - TypeDef structure describing the new TypeDef.

Returns:

VoidResponse: void or InvalidParameterException the new 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 TypeDefKnownException the TypeDef is already stored in the repository or TypeDefConflictException the new TypeDef conflicts with an existing TypeDef or InvalidTypeDefException the new TypeDef has invalid contents or FunctionNotSupportedException the repository does not support this call or UserNotAuthorizedException the userId is not permitted to perform this operation.

verifyTypeDef

@PostMapping(path="/types/typedef/compatibility")
public BooleanResponse verifyTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 BooleanResponse verifyAttributeTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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.

updateTypeDef

@PostMapping(path="/types/typedef/update")
public TypeDefResponse updateTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 TypeDefPatch typeDefPatch)

Update one or more properties of the TypeDef. The TypeDefPatch controls what types of updates are safe to make to the TypeDef.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

typeDefPatch - TypeDef patch describing change to TypeDef.

Returns:

TypeDefResponse: updated TypeDef or InvalidParameterException the TypeDefPatch 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 PatchErrorException the TypeDef can not be updated because the supplied patch is incompatible with the stored TypeDef or FunctionNotSupportedException the repository does not support this call or UserNotAuthorizedException the userId is not permitted to perform this operation.

deleteTypeDef

@PostMapping(path="/types/typedef/{guid}/delete")
public VoidResponse deleteTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String guid,
 @RequestParam
 String name)

Delete the TypeDef. This is only possible if the TypeDef has never been used to create instances or any instances of this TypeDef have been purged from the metadata collection.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

guid - String unique identifier for the TypeDef.

name - String unique name for the TypeDef.

Returns:

VoidResponse: void or InvalidParameterException the one of TypeDef identifiers 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 TypeDefInUseException the TypeDef can not be deleted because there are instances of this type in the metadata collection. These instances need to be purged before the TypeDef can be deleted or FunctionNotSupportedException the repository does not support this call or UserNotAuthorizedException the userId is not permitted to perform this operation.

deleteAttributeTypeDef

@PostMapping(path="/types/attribute-typedef/{guid}/delete")
public VoidResponse deleteAttributeTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String guid,
 @RequestParam
 String name)

Delete an AttributeTypeDef. This is only possible if the AttributeTypeDef has never been used to create instances or any instances of this AttributeTypeDef have been purged from the metadata collection.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

guid - String unique identifier for the AttributeTypeDef.

name - String unique name for the AttributeTypeDef.

Returns:

VoidResponse: void or InvalidParameterException the one of AttributeTypeDef identifiers is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeDefNotKnownException the requested AttributeTypeDef is not found in the metadata collection. TypeDefInUseException the AttributeTypeDef can not be deleted because there are instances of this type in the metadata collection. These instances need to be purged before the AttributeTypeDef can be deleted or FunctionNotSupportedException the repository does not support this call or UserNotAuthorizedException the userId is not permitted to perform this operation.

reIdentifyTypeDef

@PostMapping(path="/types/typedef/{originalTypeDefGUID}/identifier")
public TypeDefResponse reIdentifyTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String originalTypeDefGUID,
 @RequestBody
 TypeDefReIdentifyRequest requestParameters)

Change the guid or name of an existing TypeDef to a new value. This is used if two different TypeDefs are discovered to have the same guid. This is extremely unlikely but not impossible so the open metadata protocol has provision for this.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

originalTypeDefGUID - the original guid of the TypeDef.

requestParameters - the original name of the TypeDef, the new identifier for the TypeDef and the new name for this TypeDef.

Returns:

TypeDefResponse: typeDef: new values for this TypeDef, including the new guid/name 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 TypeDefNotKnownException the TypeDef identified by the original guid/name is not found in the metadata collection or FunctionNotSupportedException the repository does not support this call or UserNotAuthorizedException the userId is not permitted to perform this operation.

reIdentifyAttributeTypeDef

@PostMapping(path="/types/attribute-typedef/{originalAttributeTypeDefGUID}/identifier")
public AttributeTypeDefResponse reIdentifyAttributeTypeDef(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String originalAttributeTypeDefGUID,
 @RequestBody
 TypeDefReIdentifyRequest requestParameters)

Change the guid or name of an existing TypeDef to a new value. This is used if two different TypeDefs are discovered to have the same guid. This is extremely unlikely but not impossible so the open metadata protocol has provision for this.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

originalAttributeTypeDefGUID - the original guid of the AttributeTypeDef.

requestParameters - the original name of the AttributeTypeDef and the new identifier for the AttributeTypeDef and the new name for this AttributeTypeDef.

Returns:

AttributeTypeDefResponse: attributeTypeDef new values for this AttributeTypeDef, including the new guid/name 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 TypeDefNotKnownException the AttributeTypeDef identified by the original guid/name is not found in the metadata collection or FunctionNotSupportedException the repository does not support this call or UserNotAuthorizedException the userId is not permitted to perform this operation.

isEntityKnown

@GetMapping(path="/instances/entity/{guid}/existence")
public 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 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 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 EntityDetailResponse getEntityDetail(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String guid,
 @RequestBody
 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.

getEntityDetailHistory

@PostMapping(path="/instances/entity/{guid}/history/all")
public EntityListResponse getEntityDetailHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String guid,
 @RequestBody(required=false)
 HistoryRangeRequest historyRangeRequest)

Return all historical versions of an entity within the bounds of the provided timestamps. To retrieve all historical versions of an entity, set both the 'fromTime' and 'toTime' to null.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

guid - String unique identifier for the entity.

historyRangeRequest - detailing the range of times and paging for the results

Returns:

EntityList structure or InvalidParameterException the guid or date is null or fromTime is after the toTime 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 at the time requested. EntityProxyOnlyException the requested entity instance is only a proxy in the metadata collection. FunctionNotSupportedException the repository does not support history. UserNotAuthorizedException the userId is not permitted to perform this operation.

getRelationshipsForEntity

@PostMapping(path="/instances/entity/{entityGUID}/relationships")
public RelationshipListResponse getRelationshipsForEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestBody
 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 RelationshipListResponse getRelationshipsForEntityHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestBody
 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 EntityListResponse findEntities(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 EntityListResponse findEntitiesByHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 EntityListResponse findEntitiesByProperty(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 EntityListResponse findEntitiesByPropertyHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 EntityListResponse findEntitiesByClassification(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String classificationName,
 @RequestBody
 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 EntityListResponse findEntitiesByClassificationHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String classificationName,
 @RequestBody
 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 EntityListResponse findEntitiesByPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestParam
 String searchCriteria,
 @RequestBody
 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 EntityListResponse findEntitiesByPropertyValueHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestParam
 String searchCriteria,
 @RequestBody
 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 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 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 RelationshipResponse getRelationship(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String guid,
 @RequestBody
 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.

getRelationshipHistory

@PostMapping(path="/instances/relationship/{guid}/history/all")
public RelationshipListResponse getRelationshipHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String guid,
 @RequestBody(required=false)
 HistoryRangeRequest historyRangeRequest)

Return all historical versions of a relationship within the bounds of the provided timestamps. To retrieve all historical versions of a relationship, set both the 'fromTime' and 'toTime' to null.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

guid - String unique identifier for the relationship.

historyRangeRequest - detailing the range of times and paging for the results

Returns:

RelationshipList structure or InvalidParameterException the guid or date is null or fromTime is after the toTime RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored. RelationshipNotKnownException the requested relationship instance is not known in the metadata collection at the time requested. FunctionNotSupportedException the repository does not support history. UserNotAuthorizedException the userId is not permitted to perform this operation.

findRelationships

@PostMapping(path="/instances/relationships")
public RelationshipListResponse findRelationships(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 RelationshipListResponse findRelationshipsByHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 RelationshipListResponse findRelationshipsByProperty(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 RelationshipListResponse findRelationshipsByPropertyHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 RelationshipListResponse findRelationshipsByPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestParam
 String searchCriteria,
 @RequestBody
 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 RelationshipListResponse findRelationshipsByPropertyValueHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestParam
 String searchCriteria,
 @RequestBody
 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 InstanceGraphResponse getLinkingEntities(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String startEntityGUID,
 @RequestParam
 String endEntityGUID,
 @RequestBody
 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 InstanceGraphResponse getLinkingEntitiesHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String startEntityGUID,
 @RequestParam
 String endEntityGUID,
 @RequestBody
 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 InstanceGraphResponse getEntityNeighborhood(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestParam
 int level,
 @RequestBody
 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 InstanceGraphResponse getEntityNeighborhoodHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestParam
 int level,
 @RequestBody
 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 EntityListResponse getRelatedEntities(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String startEntityGUID,
 @RequestBody
 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 EntityListResponse getRelatedEntitiesHistory(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String startEntityGUID,
 @RequestBody
 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 EntityDetailResponse addEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 EntityDetailResponse addExternalEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 VoidResponse addEntityProxy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 EntityDetailResponse updateEntityStatus(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestBody
 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 EntityDetailResponse updateEntityProperties(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestBody
 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 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 EntityDetailResponse deleteEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String obsoleteEntityGUID,
 @RequestBody
 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 VoidResponse purgeEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String deletedEntityGUID,
 @RequestBody
 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 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 EntityDetailResponse classifyEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @PathVariable
 String classificationName,
 @RequestBody
 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 ClassificationResponse classifyEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String classificationName,
 @RequestBody
 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 EntityDetailResponse classifyEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @PathVariable
 String classificationName,
 @RequestBody
 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 ClassificationResponse classifyEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String classificationName,
 @RequestBody
 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 EntityDetailResponse declassifyEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @PathVariable
 String classificationName,
 @RequestBody(required=false)
 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 ClassificationResponse declassifyEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String classificationName,
 @RequestBody
 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 EntityDetailResponse updateEntityClassification(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @PathVariable
 String classificationName,
 @RequestBody
 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 ClassificationResponse updateEntityClassification(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String classificationName,
 @RequestBody
 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 RelationshipResponse addRelationship(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 RelationshipResponse addExternalRelationship(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 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 RelationshipResponse updateRelationshipStatus(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String relationshipGUID,
 @RequestBody
 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 RelationshipResponse updateRelationshipProperties(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String relationshipGUID,
 @RequestBody
 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 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 RelationshipResponse deleteRelationship(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String obsoleteRelationshipGUID,
 @RequestBody
 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 VoidResponse purgeRelationship(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String deletedRelationshipGUID,
 @RequestBody
 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 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.

reIdentifyEntity

@PostMapping(path="/instances/entity/{entityGUID}/identity")
public EntityDetailResponse reIdentifyEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestParam
 String newEntityGUID,
 @RequestBody
 TypeDefValidationForRequest typeDefValidationForRequest)

Change the guid of an existing entity to a new value. This is used if two different entities are discovered to have the same guid. This is extremely unlikely but not impossible so the open metadata protocol has provision for this.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

entityGUID - the existing identifier for the entity.

newEntityGUID - new unique identifier for the entity.

typeDefValidationForRequest - information about the type used to confirm the right instance is specified.

Returns:

EntityDetailResponse: entity: new values for this entity, including the new guid 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 repository does not support instance re-identification or UserNotAuthorizedException the userId is not permitted to perform this operation.

reTypeEntity

@PostMapping(path="/instances/entity/{entityGUID}/type")
public EntityDetailResponse reTypeEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestBody
 TypeDefChangeRequest typeDefChangeRequest)

Change an existing entity's type. Typically, this action is taken to move an entity's type to either a super type (so the subtype can be deleted) or a new subtype (so additional properties can be added.) However, the type can be changed to any compatible type and the properties adjusted.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

entityGUID - the unique identifier for the entity to change.

typeDefChangeRequest - the details of the current and new type.

Returns:

EntityDetailResponse: entity: new values for this entity, including the new type information 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 the instance's properties are not valid for the new type. ClassificationErrorException the instance's classifications are not valid for the new type. EntityNotKnownException the entity identified by the guid is not found in the metadata collection or FunctionNotSupportedException the repository does not support instance re-typing or UserNotAuthorizedException the userId is not permitted to perform this operation.

reHomeEntity

@PostMapping(path="/instances/entity/{entityGUID}/home/{homeMetadataCollectionId}")
public EntityDetailResponse reHomeEntity(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @PathVariable
 String homeMetadataCollectionId,
 @RequestParam
 String newHomeMetadataCollectionId,
 @RequestParam(required=false)
 String newHomeMetadataCollectionName,
 @RequestBody
 TypeDefValidationForRequest typeDefValidationForRequest)

Change the home of an existing entity. This action is taken for example, if the original home repository becomes permanently unavailable, or if the user community updating this entity move to working from a different repository in the open metadata repository cohort.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

entityGUID - the unique identifier for the entity to change.

homeMetadataCollectionId - the existing identifier for this entity's home.

newHomeMetadataCollectionId - unique identifier for the new home metadata collection/repository.

newHomeMetadataCollectionName - display name for the new home metadata collection/repository (optional).

typeDefValidationForRequest - information about the type used to confirm the right instance is specified.

Returns:

EntityDetailResponse: entity: new values for this entity, including the new home information 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 repository does not support instance re-homing or UserNotAuthorizedException the userId is not permitted to perform this operation.

reIdentifyRelationship

@PostMapping(path="/instances/relationship/{relationshipGUID}/identity")
public RelationshipResponse reIdentifyRelationship(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String relationshipGUID,
 @RequestParam
 String newRelationshipGUID,
 @RequestBody
 TypeDefValidationForRequest typeDefValidationForRequest)

Change the guid of an existing relationship. This is used if two different relationships are discovered to have the same guid. This is extremely unlikely but not impossible so the open metadata protocol has provision for this.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

relationshipGUID - the existing identifier for the relationship.

newRelationshipGUID - the new unique identifier for the relationship.

typeDefValidationForRequest - information about the type used to confirm the right instance is specified.

Returns:

RelationshipResponse: relationship: new values for this relationship, including the new guid 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 relationship identified by the guid is not found in the metadata collection or FunctionNotSupportedException the repository does not support instance re-identification or UserNotAuthorizedException the userId is not permitted to perform this operation.

reTypeRelationship

@PostMapping(path="/instances/relationship/{relationshipGUID}/type")
public RelationshipResponse reTypeRelationship(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String relationshipGUID,
 @RequestBody
 TypeDefChangeRequest typeDefChangeRequest)

Change an existing relationship's type. Typically, this action is taken to move a relationship's type to either a super type (so the subtype can be deleted) or a new subtype (so additional properties can be added.) However, the type can be changed to any compatible type.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

relationshipGUID - the unique identifier for the relationship.

typeDefChangeRequest - the details of the current and new type.

Returns:

RelationshipResponse: relationship: new values for this relationship, including the new type information 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 the instance's properties are not valid for th new type. RelationshipNotKnownException the relationship identified by the guid is not found in the metadata collection or FunctionNotSupportedException the repository does not support instance re-typing or UserNotAuthorizedException the userId is not permitted to perform this operation.

reHomeRelationship

@PostMapping(path="/instances/relationship/{relationshipGUID}/home/{homeMetadataCollectionId}")
public RelationshipResponse reHomeRelationship(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String relationshipGUID,
 @PathVariable
 String homeMetadataCollectionId,
 @RequestParam
 String newHomeMetadataCollectionId,
 @RequestParam(required=false)
 String newHomeMetadataCollectionName,
 @RequestBody
 TypeDefValidationForRequest typeDefValidationForRequest)

Change the home of an existing relationship. This action is taken for example, if the original home repository becomes permanently unavailable, or if the user community updating this relationship move to working from a different repository in the open metadata repository cohort.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

relationshipGUID - the unique identifier for the relationship.

homeMetadataCollectionId - the existing identifier for this relationship's home.

newHomeMetadataCollectionId - unique identifier for the new home metadata collection/repository.

newHomeMetadataCollectionName - unique name for the new home metadata collection/repository.

typeDefValidationForRequest - information about the type used to confirm the right instance is specified.

Returns:

RelationshipResponse: relationship: new values for this relationship, including the new home information 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 relationship identified by the guid is not found in the metadata collection or FunctionNotSupportedException the repository does not support instance re-homing or UserNotAuthorizedException the userId is not permitted to perform this operation.

saveEntityReferenceCopy

@PostMapping(path="/instances/entities/reference-copy")
public VoidResponse saveEntityReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 EntityDetail entity)

Save the entity as a reference copy. The id of the home metadata collection is already set up in the entity.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

entity - details of the entity to save.

Returns:

VoidResponse: void or InvalidParameterException the entity 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 HomeEntityException the entity belongs to the local repository so creating a reference copy would be invalid or EntityConflictException the new entity conflicts with an existing entity or InvalidEntityException the new entity has invalid contents or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

getHomeClassifications

@GetMapping(path="/instances/entity/{entityGUID}/home-classifications")
public ClassificationListResponse getHomeClassifications(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID)

Retrieve any locally homed classifications assigned to the requested entity. This method is implemented by repository connectors that are able to store classifications for entities that are homed in another repository.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

entityGUID - unique identifier of the entity with classifications to retrieve

Returns:

list of all the classifications for this entity that are homed in this repository or InvalidParameterException the entity is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity is not recognized by this repository or UserNotAuthorizedException to calling user is not authorized to retrieve this metadata or FunctionNotSupportedException this method is not supported

getHomeClassifications

@PostMapping(path="/instances/entity/{entityGUID}/home-classifications/history")
public ClassificationListResponse getHomeClassifications(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestBody
 HistoryRequest requestBody)

Retrieve any locally homed classifications assigned to the requested entity. This method is implemented by repository connectors that are able to store classifications for entities that are homed in another repository.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

entityGUID - unique identifier of the entity with classifications to retrieve

requestBody - the time used to determine which version of the entity that is desired.

Returns:

list of all the classifications for this entity that are homed in this repository or InvalidParameterException the entity is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the entity is not recognized by this repository or UserNotAuthorizedException to calling user is not authorized to retrieve this metadata or FunctionNotSupportedException this method is not supported

deleteEntityReferenceCopy

@PostMapping(path="/instances/entities/reference-copy/delete")
public VoidResponse deleteEntityReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 EntityDetail entity)

Remove a reference copy of the entity from the local repository. This method can be used to remove reference copies from the local cohort, repositories that have left the cohort, or entities that have come from open metadata archives.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

entity - the instance to purge.

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 HomeEntityException the entity belongs to the local repository so creating a reference copy would be invalid or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

purgeEntityReferenceCopy

@PostMapping(path="/instances/entities/reference-copy/purge")
public VoidResponse purgeEntityReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 EntityDetail entity)

Remove a reference copy of the entity from the local repository. This method can be used to remove reference copies from the local cohort, repositories that have left the cohort, or entities that have come from open metadata archives.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

entity - the instance to purge.

Returns:

VoidResponse: void or InvalidParameterException the entity 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 HomeEntityException the entity belongs to the local repository so creating a reference copy would be invalid or EntityConflictException the new entity conflicts with an existing entity or InvalidEntityException the new entity has invalid contents or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

purgeEntityReferenceCopy

@PostMapping(path="/instances/entities/reference-copy/{entityGUID}/purge")
public VoidResponse purgeEntityReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestParam
 String homeMetadataCollectionId,
 @RequestBody
 TypeDefValidationForRequest typeDefValidationForRequest)

Remove a reference copy of the entity from the local repository. This method can be used to remove reference copies from the local cohort, repositories that have left the cohort, or entities that have come from open metadata archives.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

entityGUID - the unique identifier for the entity.

homeMetadataCollectionId - identifier of the metadata collection that is the home to this 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 HomeEntityException the entity belongs to the local repository so creating a reference copy would be invalid or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

refreshEntityReferenceCopy

@PostMapping(path="/instances/entities/reference-copy/{entityGUID}/refresh")
public VoidResponse refreshEntityReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String entityGUID,
 @RequestParam
 String homeMetadataCollectionId,
 @RequestBody
 TypeDefValidationForRequest typeDefValidationForRequest)

The local repository has requested that the repository that hosts the home metadata collection for the specified entity sends out the details of this entity so the local repository can create a reference copy.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

entityGUID - unique identifier of requested entity.

homeMetadataCollectionId - identifier of the metadata collection that is the home to this 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 HomeEntityException the entity belongs to the local repository so creating a reference copy would be invalid or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

saveClassificationReferenceCopy

@PostMapping(path="instances/entities/classifications/reference-copy")
public VoidResponse saveClassificationReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 ClassificationWithEntityRequest requestBody)

Save the classification as a reference copy. The id of the home metadata collection is already set up in the classification. The entity may be either a locally homed entity or a reference copy.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

requestBody - entity that the classification is attached to and classification to save.

Returns:

void response or InvalidParameterException one of the parameters is invalid or null. RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored. PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this classification type. UserNotAuthorizedException the userId is not permitted to perform this operation. FunctionNotSupportedException the repository does not support maintenance of metadata. TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection. EntityConflictException the new entity conflicts with an existing entity. InvalidEntityException the new entity has invalid contents. FunctionNotSupportedException the repository does not support reference copies of instances. UserNotAuthorizedException the userId is not permitted to perform this operation.

purgeClassificationReferenceCopy

@PostMapping(path="instances/entities/classifications/reference-copy/purge")
public VoidResponse purgeClassificationReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 ClassificationWithEntityRequest requestBody)

Remove the reference copy of the classification from the local repository. This method can be used to remove reference copies from the local cohort, repositories that have left the cohort, or relationships that have come from open metadata archives.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting user.

requestBody - entity that the classification is attached to and classification to purge.

Returns:

void response or InvalidParameterException one of the parameters is invalid or null. PropertyErrorException one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this classification type. RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored. TypeErrorException the requested type is not known, or not supported in the metadata repository hosting the metadata collection. EntityConflictException the new entity conflicts with an existing entity. InvalidEntityException the new entity has invalid contents. UserNotAuthorizedException the userId is not permitted to perform this operation. FunctionNotSupportedException the repository does not support maintenance of metadata.

saveRelationshipReferenceCopy

@PostMapping(path="/instances/relationships/reference-copy")
public VoidResponse saveRelationshipReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 Relationship relationship)

Save the relationship as a reference copy. The id of the home metadata collection is already set up in the relationship.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting userId.

relationship - relationship to save.

Returns:

VoidResponse: void or InvalidParameterException the relationship 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 EntityNotKnownException one of the entities identified by the relationship is not found 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 HomeRelationshipException the relationship belongs to the local repository so creating a reference copy would be invalid or RelationshipConflictException the new relationship conflicts with an existing relationship. InvalidRelationshipException the new relationship has invalid contents or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

deleteRelationshipReferenceCopy

@PostMapping(path="/instances/relationships/reference-copy/delete")
public VoidResponse deleteRelationshipReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 Relationship relationship)

Remove the reference copy of the relationship from the local repository. This method can be used to remove reference copies from the local cohort, repositories that have left the cohort, or relationships that have come from open metadata archives.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

relationship - the instance to purge.

Returns:

VoidResponse: void or InvalidParameterException the relationship 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 EntityNotKnownException one of the entities identified by the relationship is not found 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 HomeRelationshipException the relationship belongs to the local repository so creating a reference copy would be invalid or RelationshipConflictException the new relationship conflicts with an existing relationship. InvalidRelationshipException the new relationship has invalid contents or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

purgeRelationshipReferenceCopy

@PostMapping(path="/instances/relationships/reference-copy/purge")
public VoidResponse purgeRelationshipReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 Relationship relationship)

Remove the reference copy of the relationship from the local repository. This method can be used to remove reference copies from the local cohort, repositories that have left the cohort, or relationships that have come from open metadata archives.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

relationship - the instance to purge.

Returns:

VoidResponse: void or InvalidParameterException the relationship 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 EntityNotKnownException one of the entities identified by the relationship is not found 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 HomeRelationshipException the relationship belongs to the local repository so creating a reference copy would be invalid or RelationshipConflictException the new relationship conflicts with an existing relationship. InvalidRelationshipException the new relationship has invalid contents or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

purgeRelationshipReferenceCopy

@PostMapping(path="/instances/relationships/reference-copy/{relationshipGUID}/purge")
public VoidResponse purgeRelationshipReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String relationshipGUID,
 @RequestParam
 String homeMetadataCollectionId,
 @RequestBody
 TypeDefValidationForRequest typeDefValidationForRequest)

Remove the reference copy of the relationship from the local repository. This method can be used to remove reference copies from the local cohort, repositories that have left the cohort, or relationships that have come from open metadata archives.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

relationshipGUID - the unique identifier for the relationship.

homeMetadataCollectionId - unique identifier for the home repository for this relationship.

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 RelationshipNotKnownException the relationship identifier is not recognized or HomeRelationshipException the relationship belongs to the local repository so creating a reference copy would be invalid or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

refreshRelationshipReferenceCopy

@PostMapping(path="/instances/relationships/reference-copy/{relationshipGUID}/refresh")
public VoidResponse refreshRelationshipReferenceCopy(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String relationshipGUID,
 @RequestParam
 String homeMetadataCollectionId,
 @RequestBody
 TypeDefValidationForRequest typeDefValidationForRequest)

The local repository has requested that the repository that hosts the home metadata collection for the specified relationship sends out the details of this relationship so the local repository can create a reference copy.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

relationshipGUID - unique identifier of the relationship.

homeMetadataCollectionId - unique identifier for the home repository for this relationship.

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 RelationshipNotKnownException the relationship identifier is not recognized or HomeRelationshipException the relationship belongs to the local repository so creating a reference copy would be invalid or FunctionNotSupportedException the repository does not support instance reference copies or UserNotAuthorizedException the userId is not permitted to perform this operation.

saveInstanceReferenceCopies

@PostMapping(path="/instances")
public VoidResponse saveInstanceReferenceCopies(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 InstanceGraphRequest instances)

Save the entities and relationships supplied in the instance graph as a reference copies. The id of the home metadata collection is already set up in the instances. Any instances from the home metadata collection are ignored.

Parameters:

serverName - unique identifier for requested server.

userId - unique identifier for requesting server.

instances - instances to save

Returns:

void response or InvalidParameterException the relationship 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 EntityNotKnownException one of the entities identified by the relationship is not found 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 EntityConflictException the new entity conflicts with an existing entity or InvalidEntityException the new entity has invalid contents or RelationshipConflictException the new relationship conflicts with an existing relationship or InvalidRelationshipException the new relationship has invalid contents or FunctionNotSupportedException the repository does not support reference copies of instances or UserNotAuthorizedException the userId is not permitted to perform this operation.