@RestController @RequestMapping(value="/open-metadata/repository-services") public class OMRSRepositoryResource extends Object
OMRSMetadataInstanceStore is the common interface for working with the contents of a metadata repository. Within a metadata collection are the type definitions (TypeDefs) and metadata instances (Entities and Relationships). OMRSMetadataCollectionBase provides empty implementation of the the abstract methods of OMRSMetadataInstanceStore. The methods on OMRSMetadataInstanceStore are in the following major groups:
| Constructor and Description |
|---|
OMRSRepositoryResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
VoidResponse |
addAttributeTypeDef(String userId,
AttributeTypeDef newAttributeTypeDef)
Create a definition of a new AttributeTypeDef.
|
EntityDetailResponse |
addEntity(String userId,
EntityCreateRequest requestBody)
Create a new entity and put it in the requested state.
|
VoidResponse |
addEntityProxy(String userId,
EntityProxy entityProxy)
Create an entity proxy in the metadata collection.
|
RelationshipResponse |
addRelationship(String userId,
RelationshipCreateRequest createRequestParameters)
Add a new relationship between two entities to the metadata collection.
|
VoidResponse |
addTypeDef(String userId,
TypeDef newTypeDef)
Create a definition of a new TypeDef.
|
VoidResponse |
addTypeDefGallery(String userId,
TypeDefGallery newTypes)
Create a collection of related types.
|
EntityDetailResponse |
classifyEntity(String userId,
String entityGUID,
String classificationName,
InstancePropertiesRequest propertiesRequestBody)
Add the requested classification to a specific entity.
|
EntityDetailResponse |
declassifyEntity(String userId,
String entityGUID,
String classificationName,
OMRSAPIRequest requestBody)
Remove a specific classification from an entity.
|
VoidResponse |
deleteAttributeTypeDef(String userId,
String guid,
String name)
Delete an AttributeTypeDef.
|
EntityDetailResponse |
deleteEntity(String userId,
String obsoleteEntityGUID,
TypeDefValidationForRequest typeDefValidationForRequest)
Delete an entity.
|
RelationshipResponse |
deleteRelationship(String userId,
String obsoleteRelationshipGUID,
TypeDefValidationForRequest typeDefValidationForRequest)
Delete a specific relationship.
|
VoidResponse |
deleteTypeDef(String userId,
String guid,
String name)
Delete the TypeDef.
|
AttributeTypeDefListResponse |
findAttributeTypeDefsByCategory(String userId,
AttributeTypeDefCategory category)
Returns all of the AttributeTypeDefs for a specific category.
|
EntityListResponse |
findEntitiesByClassification(String userId,
String classificationName,
PropertyMatchFindRequest findRequestParameters)
Return a list of entities that have the requested type of classification attached.
|
EntityListResponse |
findEntitiesByClassificationHistory(String userId,
String classificationName,
PropertyMatchHistoricalFindRequest findRequestParameters)
Return a list of entities that have the requested type of classification attached.
|
EntityListResponse |
findEntitiesByProperty(String userId,
EntityPropertyFindRequest findRequestParameters)
Return a list of entities that match the supplied properties according to the match criteria.
|
EntityListResponse |
findEntitiesByPropertyHistory(String userId,
EntityPropertyHistoricalFindRequest findRequestParameters)
Return a list of entities that match the supplied properties according to the match criteria.
|
EntityListResponse |
findEntitiesByPropertyValue(String userId,
String searchCriteria,
EntityPropertyFindRequest findRequestParameters)
Return a list of entities whose string based property values match the search criteria.
|
EntityListResponse |
findEntitiesByPropertyValueHistory(String userId,
String searchCriteria,
EntityPropertyHistoricalFindRequest findRequestParameters)
Return a list of entities whose string based property values match the search criteria.
|
RelationshipListResponse |
findRelationshipsByProperty(String userId,
PropertyMatchFindRequest findRequestParameters)
Return a list of relationships that match the requested properties by the matching criteria.
|
RelationshipListResponse |
findRelationshipsByPropertyHistory(String userId,
PropertyMatchHistoricalFindRequest findRequestParameters)
Return a list of relationships that match the requested properties by the matching criteria.
|
RelationshipListResponse |
findRelationshipsByPropertyValue(String userId,
String searchCriteria,
TypeLimitedFindRequest findRequestParameters)
Return a list of relationships that match the search criteria.
|
RelationshipListResponse |
findRelationshipsByPropertyValueHistory(String userId,
String searchCriteria,
TypeLimitedHistoricalFindRequest findRequestParameters)
Return a list of relationships that match the search criteria.
|
TypeDefListResponse |
findTypeDefsByCategory(String userId,
TypeDefCategory category)
Returns all of the TypeDefs for a specific category.
|
TypeDefListResponse |
findTypeDefsByProperty(String userId,
TypeDefProperties matchCriteria)
Return the TypeDefs that have the properties matching the supplied match criteria.
|
TypeDefListResponse |
findTypesByExternalID(String userId,
String standard,
String organization,
String identifier)
Return the types that are linked to the elements from the specified standard.
|
TypeDefGalleryResponse |
findTypesByName(String userId,
String name)
Returns a list of type definitions that have the specified name.
|
TypeDefGalleryResponse |
getAllTypes(String userId)
Returns the list of different types of metadata organized into two groups.
|
AttributeTypeDefResponse |
getAttributeTypeDefByGUID(String userId,
String guid)
Return the AttributeTypeDef identified by the GUID.
|
AttributeTypeDefResponse |
getAttributeTypeDefByName(String userId,
String name)
Return the AttributeTypeDef identified by the unique name.
|
EntityDetailResponse |
getEntityDetail(String guid)
Return the header, classifications and properties of a specific entity.
|
EntityDetailResponse |
getEntityDetail(String userId,
String guid)
Return the header, classifications and properties of a specific entity.
|
EntityDetailResponse |
getEntityDetail(String userId,
String guid,
Date asOfTime)
Return a historical version of an entity includes the header, classifications and properties of the entity.
|
InstanceGraphResponse |
getEntityNeighborhood(String userId,
String entityGUID,
int level,
EntityNeighborhoodFindRequest findRequestParameters)
Return the entities and relationships that radiate out from the supplied entity GUID.
|
InstanceGraphResponse |
getEntityNeighborhoodHistory(String userId,
String entityGUID,
int level,
EntityNeighborhoodHistoricalFindRequest findRequestParameters)
Return the entities and relationships that radiate out from the supplied entity GUID.
|
EntitySummaryResponse |
getEntitySummary(String userId,
String guid)
Return the header and classifications for a specific entity.
|
InstanceGraphResponse |
getLinkingEntities(String userId,
String startEntityGUID,
String endEntityGUID,
OMRSAPIFindRequest findRequestParameters)
Return all of the relationships and intermediate entities that connect the startEntity with the endEntity.
|
InstanceGraphResponse |
getLinkingEntitiesHistory(String userId,
String startEntityGUID,
String endEntityGUID,
OMRSAPIHistoricalFindRequest findRequestParameters)
Return all of the relationships and intermediate entities that connect the startEntity with the endEntity.
|
MetadataCollectionIdResponse |
getMetadataCollectionId()
Returns the identifier of the metadata repository.
|
EntityListResponse |
getRelatedEntities(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 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 guid)
Return a requested relationship.
|
RelationshipResponse |
getRelationship(String userId,
String guid)
Return a requested relationship.
|
RelationshipResponse |
getRelationship(String userId,
String guid,
Date asOfTime)
Return a historical version of a relationship.
|
RelationshipListResponse |
getRelationshipsForEntity(String userId,
String entityGUID,
TypeLimitedFindRequest findRequestParameters)
Return the relationships for a specific entity.
|
RelationshipListResponse |
getRelationshipsForEntityHistory(String userId,
String entityGUID,
TypeLimitedHistoricalFindRequest findRequestParameters)
Return the relationships for a specific entity.
|
TypeDefResponse |
getTypeDefByGUID(String userId,
String guid)
Return the TypeDef identified by the GUID.
|
TypeDefResponse |
getTypeDefByName(String userId,
String name)
Return the TypeDef identified by the unique name.
|
EntityDetailResponse |
isEntityKnown(String userId,
String guid)
Returns a boolean indicating if the entity is stored in the metadata collection.
|
RelationshipResponse |
isRelationshipKnown(String userId,
String guid)
Returns a boolean indicating if the relationship is stored in the metadata collection.
|
VoidResponse |
purgeEntity(String userId,
String deletedEntityGUID,
TypeDefValidationForRequest typeDefValidationForRequest)
Permanently removes a deleted entity from the metadata collection.
|
VoidResponse |
purgeEntityReferenceCopy(String userId,
String entityGUID,
String homeMetadataCollectionId,
TypeDefValidationForRequest typeDefValidationForRequest)
Remove a reference copy of the the entity from the local repository.
|
VoidResponse |
purgeRelationship(String userId,
String deletedRelationshipGUID,
TypeDefValidationForRequest typeDefValidationForRequest)
Permanently delete the relationship from the repository.
|
VoidResponse |
purgeRelationshipReferenceCopy(String userId,
String relationshipGUID,
String homeMetadataCollectionId,
TypeDefValidationForRequest typeDefValidationForRequest)
Remove the reference copy of the relationship from the local repository.
|
VoidResponse |
refreshEntityReferenceCopy(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 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 userId,
String entityGUID,
String homeMetadataCollectionId,
String newHomeMetadataCollectionId,
TypeDefValidationForRequest typeDefValidationForRequest)
Change the home of an existing entity.
|
RelationshipResponse |
reHomeRelationship(String userId,
String relationshipGUID,
String homeMetadataCollectionId,
String newHomeMetadataCollectionId,
TypeDefValidationForRequest typeDefValidationForRequest)
Change the home of an existing relationship.
|
AttributeTypeDefResponse |
reIdentifyAttributeTypeDef(String userId,
String originalAttributeTypeDefGUID,
TypeDefReIdentifyRequest requestParameters)
Change the guid or name of an existing TypeDef to a new value.
|
EntityDetailResponse |
reIdentifyEntity(String userId,
String entityGUID,
String newEntityGUID,
TypeDefValidationForRequest typeDefValidationForRequest)
Change the guid of an existing entity to a new value.
|
RelationshipResponse |
reIdentifyRelationship(String userId,
String relationshipGUID,
String newRelationshipGUID,
TypeDefValidationForRequest typeDefValidationForRequest)
Change the guid of an existing relationship.
|
TypeDefResponse |
reIdentifyTypeDef(String userId,
String originalTypeDefGUID,
TypeDefReIdentifyRequest requestParameters)
Change the guid or name of an existing TypeDef to a new value.
|
EntityDetailResponse |
restoreEntity(String userId,
String deletedEntityGUID)
Restore the requested entity to the state it was before it was deleted.
|
RelationshipResponse |
restoreRelationship(String userId,
String deletedRelationshipGUID)
Restore a deleted relationship into the metadata collection.
|
EntityDetailResponse |
reTypeEntity(String userId,
String entityGUID,
TypeDefChangeRequest typeDefChangeRequest)
Change the type of an existing entity.
|
RelationshipResponse |
reTypeRelationship(String userId,
String relationshipGUID,
TypeDefChangeRequest typeDefChangeRequest)
Change the type of an existing relationship.
|
VoidResponse |
saveEntityReferenceCopy(String userId,
EntityDetail entity)
Save the entity as a reference copy.
|
VoidResponse |
saveInstanceReferenceCopies(String userId,
InstanceGraphRequest instances)
Save the entities and relationships supplied in the instance graph as a reference copies.
|
VoidResponse |
saveRelationshipReferenceCopy(String userId,
Relationship relationship)
Save the relationship as a reference copy.
|
TypeDefListResponse |
searchForTypeDefs(String userId,
String searchCriteria)
Return the TypeDefs that match the search criteria.
|
EntityDetailResponse |
undoEntityUpdate(String userId,
String entityGUID)
Undo the last update to an entity and return the previous content.
|
RelationshipResponse |
undoRelationshipUpdate(String userId,
String relationshipGUID)
Undo the latest change to a relationship (either a change of properties or status).
|
EntityDetailResponse |
updateEntityClassification(String userId,
String entityGUID,
String classificationName,
InstancePropertiesRequest propertiesRequestBody)
Update one or more properties in one of an entity's classifications.
|
EntityDetailResponse |
updateEntityProperties(String userId,
String entityGUID,
InstancePropertiesRequest propertiesRequestBody)
Update selected properties in an entity.
|
EntityDetailResponse |
updateEntityStatus(String userId,
String entityGUID,
InstanceStatus newStatus)
Update the status for a specific entity.
|
RelationshipResponse |
updateRelationshipProperties(String userId,
String relationshipGUID,
InstancePropertiesRequest propertiesRequestBody)
Update the properties of a specific relationship.
|
RelationshipResponse |
updateRelationshipStatus(String userId,
String relationshipGUID,
InstanceStatus newStatus)
Update the status of a specific relationship.
|
TypeDefResponse |
updateTypeDef(String userId,
TypeDefPatch typeDefPatch)
Update one or more properties of the TypeDef.
|
BooleanResponse |
verifyAttributeTypeDef(String userId,
AttributeTypeDef attributeTypeDef)
Verify that a definition of an AttributeTypeDef is either new or matches the definition already stored.
|
BooleanResponse |
verifyTypeDef(String userId,
TypeDef typeDef)
Verify that a definition of a TypeDef is either new or matches the definition already stored.
|
@RequestMapping(method=GET,
path="/metadata-collection-id")
public MetadataCollectionIdResponse getMetadataCollectionId()
@RequestMapping(method=GET,
path="/users/{userId}/types/all")
public TypeDefGalleryResponse getAllTypes(@PathVariable
String userId)
userId - unique identifier for requesting user.@RequestMapping(method=GET,
path="/users/{userId}/types/by-name")
public TypeDefGalleryResponse findTypesByName(@PathVariable
String userId,
@RequestParam
String name)
userId - unique identifier for requesting user.name - name of the TypeDefs to return (including wildcard characters).@RequestMapping(method=POST,
path="/users/{userId}/types/typedefs/by-category")
public TypeDefListResponse findTypeDefsByCategory(@PathVariable
String userId,
@RequestBody
TypeDefCategory category)
userId - unique identifier for requesting user.category - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/types/attribute-typedefs/by-category")
public AttributeTypeDefListResponse findAttributeTypeDefsByCategory(@PathVariable
String userId,
@RequestBody
AttributeTypeDefCategory category)
userId - unique identifier for requesting user.category - find parameters used to limit the returned results.@RequestMapping(method=GET,
path="/users/{userId}/types/typedefs/by-property")
public TypeDefListResponse findTypeDefsByProperty(@PathVariable
String userId,
@RequestBody
TypeDefProperties matchCriteria)
userId - unique identifier for requesting user.matchCriteria - TypeDefProperties a list of property names.@RequestMapping(method=GET,
path="/users/{userId}/types/typedefs/by-external-id")
public TypeDefListResponse findTypesByExternalID(@PathVariable
String userId,
@RequestParam(required=false)
String standard,
@RequestParam(required=false)
String organization,
@RequestParam(required=false)
String identifier)
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.@RequestMapping(method=GET,
path="/users/{userId}/types/typedefs/by-property-value")
public TypeDefListResponse searchForTypeDefs(@PathVariable
String userId,
@RequestParam
String searchCriteria)
userId - unique identifier for requesting user.searchCriteria - String search criteria.@RequestMapping(method=GET,
path="/users/{userId}/types/typedef/{guid}")
public TypeDefResponse getTypeDefByGUID(@PathVariable
String userId,
@PathVariable
String guid)
userId - unique identifier for requesting user.guid - String unique id of the TypeDef.@RequestMapping(method=GET,
path="/users/{userId}/types/attribute-typedef/{guid}")
public AttributeTypeDefResponse getAttributeTypeDefByGUID(@PathVariable
String userId,
@PathVariable
String guid)
userId - unique identifier for requesting user.guid - String unique id of the TypeDef@RequestMapping(method=GET,
path="/users/{userId}/types/typedef/name/{name}")
public TypeDefResponse getTypeDefByName(@PathVariable
String userId,
@PathVariable
String name)
userId - unique identifier for requesting user.name - String name of the TypeDef.@RequestMapping(method=GET,
path="/users/{userId}/types/attribute-typedef/name/{name}")
public AttributeTypeDefResponse getAttributeTypeDefByName(@PathVariable
String userId,
@PathVariable
String name)
userId - unique identifier for requesting user.name - String name of the TypeDef.@RequestMapping(method=POST,
path="/users/{userId}/types")
public VoidResponse addTypeDefGallery(@PathVariable
String userId,
@RequestBody
TypeDefGallery newTypes)
userId - unique identifier for requesting user.newTypes - TypeDefGalleryResponse structure describing the new AttributeTypeDefs and TypeDefs.@RequestMapping(method=POST,
path="/users/{userId}/types/typedef")
public VoidResponse addTypeDef(@PathVariable
String userId,
@RequestBody
TypeDef newTypeDef)
userId - unique identifier for requesting user.newTypeDef - TypeDef structure describing the new TypeDef.@RequestMapping(method=POST,
path="/users/{userId}/types/attribute-typedef")
public VoidResponse addAttributeTypeDef(@PathVariable
String userId,
@RequestBody
AttributeTypeDef newAttributeTypeDef)
userId - unique identifier for requesting user.newAttributeTypeDef - TypeDef structure describing the new TypeDef.@RequestMapping(method=POST,
path="/users/{userId}/types/typedef/compatibility")
public BooleanResponse verifyTypeDef(@PathVariable
String userId,
@RequestBody
TypeDef typeDef)
userId - unique identifier for requesting user.typeDef - TypeDef structure describing the TypeDef to test.@RequestMapping(method=POST,
path="/users/{userId}/types/attribute-typedef/compatibility")
public BooleanResponse verifyAttributeTypeDef(@PathVariable
String userId,
@RequestBody
AttributeTypeDef attributeTypeDef)
userId - unique identifier for requesting user.attributeTypeDef - TypeDef structure describing the TypeDef to test.@RequestMapping(method=POST,
path="/users/{userId}/types/typedef/update")
public TypeDefResponse updateTypeDef(@PathVariable
String userId,
@RequestBody
TypeDefPatch typeDefPatch)
userId - unique identifier for requesting user.typeDefPatch - TypeDef patch describing change to TypeDef.@RequestMapping(method=POST,
path="/users/{userId}/types/typedef/{guid}")
public VoidResponse deleteTypeDef(@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam
String name)
userId - unique identifier for requesting user.guid - String unique identifier for the TypeDef.name - String unique name for the TypeDef.@RequestMapping(method=POST,
path="/users/{userId}/types/attribute-typedef/{guid}")
public VoidResponse deleteAttributeTypeDef(@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam
String name)
userId - unique identifier for requesting user.guid - String unique identifier for the AttributeTypeDef.name - String unique name for the AttributeTypeDef.@RequestMapping(method=POST,
path="/users/{userId}/types/typedef/{originalTypeDefGUID}/identifier")
public TypeDefResponse reIdentifyTypeDef(@PathVariable
String userId,
@PathVariable
String originalTypeDefGUID,
@RequestBody
TypeDefReIdentifyRequest requestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/types/attribute-typedef/{originalAttributeTypeDefGUID}/identifier")
public AttributeTypeDefResponse reIdentifyAttributeTypeDef(@PathVariable
String userId,
@PathVariable
String originalAttributeTypeDefGUID,
@RequestBody
TypeDefReIdentifyRequest requestParameters)
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.@RequestMapping(method=GET,
path="/users/{userId}/instances/entity/{guid}/existence")
public EntityDetailResponse isEntityKnown(@PathVariable
String userId,
@PathVariable
String guid)
userId - unique identifier for requesting user.guid - String unique identifier for the entity@RequestMapping(method=GET,
path="/users/{userId}/instances/entity/{guid}/summary")
public EntitySummaryResponse getEntitySummary(@PathVariable
String userId,
@PathVariable
String guid)
userId - unique identifier for requesting user.guid - String unique identifier for the entity@RequestMapping(method=GET,
path="/users/instances/entity/{guid}")
public EntityDetailResponse getEntityDetail(@PathVariable
String guid)
guid - String unique identifier for the entity.@RequestMapping(method=GET,
path="/users/{userId}/instances/entity/{guid}")
public EntityDetailResponse getEntityDetail(@PathVariable
String userId,
@PathVariable
String guid)
userId - unique identifier for requesting user.guid - String unique identifier for the entity.@RequestMapping(method=GET,
path="/users/{userId}/instances/entity/{guid}/history")
public EntityDetailResponse getEntityDetail(@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam
Date asOfTime)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/relationships")
public RelationshipListResponse getRelationshipsForEntity(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestBody
TypeLimitedFindRequest findRequestParameters)
userId - unique identifier for requesting user.entityGUID - String unique identifier for the entity.findRequestParameters - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/relationships/history")
public RelationshipListResponse getRelationshipsForEntityHistory(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestBody
TypeLimitedHistoricalFindRequest findRequestParameters)
userId - unique identifier for requesting user.entityGUID - String unique identifier for the entity.findRequestParameters - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/by-property")
public EntityListResponse findEntitiesByProperty(@PathVariable
String userId,
@RequestBody
EntityPropertyFindRequest findRequestParameters)
userId - unique identifier for requesting user.findRequestParameters - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/by-property/history")
public EntityListResponse findEntitiesByPropertyHistory(@PathVariable
String userId,
@RequestBody
EntityPropertyHistoricalFindRequest findRequestParameters)
userId - unique identifier for requesting user.findRequestParameters - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/by-classification/{classificationName}")
public EntityListResponse findEntitiesByClassification(@PathVariable
String userId,
@PathVariable
String classificationName,
@RequestBody
PropertyMatchFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/by-classification/{classificationName}/history")
public EntityListResponse findEntitiesByClassificationHistory(@PathVariable
String userId,
@PathVariable
String classificationName,
@RequestBody
PropertyMatchHistoricalFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/by-property-value")
public EntityListResponse findEntitiesByPropertyValue(@PathVariable
String userId,
@RequestParam
String searchCriteria,
@RequestBody
EntityPropertyFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/by-property-value/history")
public EntityListResponse findEntitiesByPropertyValueHistory(@PathVariable
String userId,
@RequestParam
String searchCriteria,
@RequestBody
EntityPropertyHistoricalFindRequest findRequestParameters)
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.@RequestMapping(method=GET,
path="/users/{userId}/instances/relationship/{guid}/existence")
public RelationshipResponse isRelationshipKnown(@PathVariable
String userId,
@PathVariable
String guid)
userId - unique identifier for requesting user.guid - String unique identifier for the relationship.@RequestMapping(method=GET,
path="/users/instances/relationship/{guid}")
public RelationshipResponse getRelationship(@PathVariable
String guid)
guid - String unique identifier for the relationship.@RequestMapping(method=GET,
path="/users/{userId}/instances/relationship/{guid}")
public RelationshipResponse getRelationship(@PathVariable
String userId,
@PathVariable
String guid)
userId - unique identifier for requesting user.guid - String unique identifier for the relationship.@RequestMapping(method=GET,
path="/users/{userId}/instances/relationship/{guid}/history")
public RelationshipResponse getRelationship(@PathVariable
String userId,
@PathVariable
String guid,
@RequestParam
Date asOfTime)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationships/by-property")
public RelationshipListResponse findRelationshipsByProperty(@PathVariable
String userId,
@RequestBody
PropertyMatchFindRequest findRequestParameters)
userId - unique identifier for requesting userfindRequestParameters - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationships/by-property/history")
public RelationshipListResponse findRelationshipsByPropertyHistory(@PathVariable
String userId,
@RequestBody
PropertyMatchHistoricalFindRequest findRequestParameters)
userId - unique identifier for requesting userfindRequestParameters - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationships/by-property-value")
public RelationshipListResponse findRelationshipsByPropertyValue(@PathVariable
String userId,
@RequestParam
String searchCriteria,
@RequestBody
TypeLimitedFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationships/by-property-value/history")
public RelationshipListResponse findRelationshipsByPropertyValueHistory(@PathVariable
String userId,
@RequestParam
String searchCriteria,
@RequestBody
TypeLimitedHistoricalFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/from-entity/{startEntityGUID}/by-linkage")
public InstanceGraphResponse getLinkingEntities(@PathVariable
String userId,
@PathVariable
String startEntityGUID,
@RequestParam
String endEntityGUID,
@RequestBody
OMRSAPIFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/from-entity/{startEntityGUID}/by-linkage/history")
public InstanceGraphResponse getLinkingEntitiesHistory(@PathVariable
String userId,
@PathVariable
String startEntityGUID,
@RequestParam
String endEntityGUID,
@RequestBody
OMRSAPIHistoricalFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/from-entity/{entityGUID}/by-neighborhood")
public InstanceGraphResponse getEntityNeighborhood(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestParam
int level,
@RequestBody
EntityNeighborhoodFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/from-entity/{entityGUID}/by-neighborhood/history")
public InstanceGraphResponse getEntityNeighborhoodHistory(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestParam
int level,
@RequestBody
EntityNeighborhoodHistoricalFindRequest findRequestParameters)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/from-entity/{startEntityGUID}/by-relationship")
public EntityListResponse getRelatedEntities(@PathVariable
String userId,
@PathVariable
String startEntityGUID,
@RequestBody
RelatedEntitiesFindRequest findRequestParameters)
userId - unique identifier for requesting user.startEntityGUID - unique identifier of the starting entity.findRequestParameters - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/from-entity/{startEntityGUID}/by-relationship/history")
public EntityListResponse getRelatedEntitiesHistory(@PathVariable
String userId,
@PathVariable
String startEntityGUID,
@RequestBody
RelatedEntitiesHistoricalFindRequest findRequestParameters)
userId - unique identifier for requesting user.startEntityGUID - unique identifier of the starting entity.findRequestParameters - find parameters used to limit the returned results.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity")
public EntityDetailResponse addEntity(@PathVariable
String userId,
@RequestBody
EntityCreateRequest requestBody)
userId - unique identifier for requesting user.requestBody - parameters for the new entity@RequestMapping(method=POST,
path="/users/{userId}/instances/entity-proxy")
public VoidResponse addEntityProxy(@PathVariable
String userId,
@RequestBody
EntityProxy entityProxy)
userId - unique identifier for requesting user.entityProxy - details of entity to add.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/status")
public EntityDetailResponse updateEntityStatus(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestBody
InstanceStatus newStatus)
userId - unique identifier for requesting user.entityGUID - unique identifier (guid) for the requested entity.newStatus - new InstanceStatus for the entity.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/properties")
public EntityDetailResponse updateEntityProperties(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestBody
InstancePropertiesRequest propertiesRequestBody)
userId - unique identifier for requesting user.entityGUID - String unique identifier (guid) for the entity.propertiesRequestBody - a list of properties to change.@RequestMapping(method=GET,
path="/users/{userId}/instances/entity/{entityGUID}/previous")
public EntityDetailResponse undoEntityUpdate(@PathVariable
String userId,
@PathVariable
String entityGUID)
userId - unique identifier for requesting user.entityGUID - String unique identifier (guid) for the entity.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{obsoleteEntityGUID}/delete")
public EntityDetailResponse deleteEntity(@PathVariable
String userId,
@PathVariable
String obsoleteEntityGUID,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{deletedEntityGUID}/purge")
public VoidResponse purgeEntity(@PathVariable
String userId,
@PathVariable
String deletedEntityGUID,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=GET,
path="/users/{userId}/instances/entity/{deletedEntityGUID}/restore")
public EntityDetailResponse restoreEntity(@PathVariable
String userId,
@PathVariable
String deletedEntityGUID)
userId - unique identifier for requesting user.deletedEntityGUID - String unique identifier (guid) for the entity.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/classification/{classificationName}")
public EntityDetailResponse classifyEntity(@PathVariable
String userId,
@PathVariable
String entityGUID,
@PathVariable
String classificationName,
@RequestBody
InstancePropertiesRequest propertiesRequestBody)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/classification/{classificationName}/delete")
public EntityDetailResponse declassifyEntity(@PathVariable
String userId,
@PathVariable
String entityGUID,
@PathVariable
String classificationName,
@RequestBody
OMRSAPIRequest requestBody)
userId - unique identifier for requesting user.entityGUID - String unique identifier (guid) for the entity.classificationName - String name for the classification.requestBody - empty request body@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/classification/{classificationName}/properties")
public EntityDetailResponse updateEntityClassification(@PathVariable
String userId,
@PathVariable
String entityGUID,
@PathVariable
String classificationName,
@RequestBody
InstancePropertiesRequest propertiesRequestBody)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationship")
public RelationshipResponse addRelationship(@PathVariable
String userId,
@RequestBody
RelationshipCreateRequest createRequestParameters)
userId - unique identifier for requesting user.createRequestParameters - parameters used to fill out the new relationship@RequestMapping(method=POST,
path="/users/{userId}/instances/relationship/{relationshipGUID}/status")
public RelationshipResponse updateRelationshipStatus(@PathVariable
String userId,
@PathVariable
String relationshipGUID,
@RequestBody
InstanceStatus newStatus)
userId - unique identifier for requesting user.relationshipGUID - String unique identifier (guid) for the relationship.newStatus - new InstanceStatus for the relationship.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationship/{relationshipGUID}/properties")
public RelationshipResponse updateRelationshipProperties(@PathVariable
String userId,
@PathVariable
String relationshipGUID,
@RequestBody
InstancePropertiesRequest propertiesRequestBody)
userId - unique identifier for requesting user.relationshipGUID - String unique identifier (guid) for the relationship.propertiesRequestBody - list of the properties to update.@RequestMapping(method=GET,
path="/users/{userId}/instances/relationship/{relationshipGUID}/previous")
public RelationshipResponse undoRelationshipUpdate(@PathVariable
String userId,
@PathVariable
String relationshipGUID)
userId - unique identifier for requesting user.relationshipGUID - String unique identifier (guid) for the relationship.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationship/{obsoleteRelationshipGUID}/delete")
public RelationshipResponse deleteRelationship(@PathVariable
String userId,
@PathVariable
String obsoleteRelationshipGUID,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationship/{deletedRelationshipGUID}/purge")
public VoidResponse purgeRelationship(@PathVariable
String userId,
@PathVariable
String deletedRelationshipGUID,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=GET,
path="/users/{userId}/instances/relationship/{deletedRelationshipGUID}/restore")
public RelationshipResponse restoreRelationship(@PathVariable
String userId,
@PathVariable
String deletedRelationshipGUID)
userId - unique identifier for requesting user.deletedRelationshipGUID - String unique identifier (guid) for the relationship.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/identity")
public EntityDetailResponse reIdentifyEntity(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestParam
String newEntityGUID,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/type")
public EntityDetailResponse reTypeEntity(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestBody
TypeDefChangeRequest typeDefChangeRequest)
userId - unique identifier for requesting user.entityGUID - the unique identifier for the entity to change.typeDefChangeRequest - the details of the current and new type.@RequestMapping(method=POST,
path="/users/{userId}/instances/entity/{entityGUID}/home/{homeMetadataCollectionId}")
public EntityDetailResponse reHomeEntity(@PathVariable
String userId,
@PathVariable
String entityGUID,
@PathVariable
String homeMetadataCollectionId,
@RequestParam
String newHomeMetadataCollectionId,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.typeDefValidationForRequest - information about the type used to confirm the right instance is specified.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationship/{relationshipGUID}/identity")
public RelationshipResponse reIdentifyRelationship(@PathVariable
String userId,
@PathVariable
String relationshipGUID,
@RequestParam
String newRelationshipGUID,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationship/{relationshipGUID}/type")
public RelationshipResponse reTypeRelationship(@PathVariable
String userId,
@PathVariable
String relationshipGUID,
@RequestBody
TypeDefChangeRequest typeDefChangeRequest)
userId - unique identifier for requesting user.relationshipGUID - the unique identifier for the relationship.typeDefChangeRequest - the details of the current and new type.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationship/{relationshipGUID}/home")
public RelationshipResponse reHomeRelationship(@PathVariable
String userId,
@PathVariable
String relationshipGUID,
@RequestParam
String homeMetadataCollectionId,
@RequestParam
String newHomeMetadataCollectionId,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.typeDefValidationForRequest - information about the type used to confirm the right instance is specified.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/reference-copy")
public VoidResponse saveEntityReferenceCopy(@PathVariable
String userId,
@RequestBody
EntityDetail entity)
userId - unique identifier for requesting user.entity - details of the entity to save.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/reference-copy/{entityGUID}/purge")
public VoidResponse purgeEntityReferenceCopy(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestParam
String homeMetadataCollectionId,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/entities/reference-copy/{entityGUID}/refresh")
public VoidResponse refreshEntityReferenceCopy(@PathVariable
String userId,
@PathVariable
String entityGUID,
@RequestParam
String homeMetadataCollectionId,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationships/reference-copy")
public VoidResponse saveRelationshipReferenceCopy(@PathVariable
String userId,
@RequestBody
Relationship relationship)
userId - unique identifier for requesting userId.relationship - relationship to save.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationships/reference-copy/{relationshipGUID}/purge")
public VoidResponse purgeRelationshipReferenceCopy(@PathVariable
String userId,
@PathVariable
String relationshipGUID,
@RequestParam
String homeMetadataCollectionId,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances/relationships/reference-copy/{relationshipGUID}/refresh")
public VoidResponse refreshRelationshipReferenceCopy(@PathVariable
String userId,
@PathVariable
String relationshipGUID,
@RequestParam
String homeMetadataCollectionId,
@RequestBody
TypeDefValidationForRequest typeDefValidationForRequest)
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.@RequestMapping(method=POST,
path="/users/{userId}/instances")
public VoidResponse saveInstanceReferenceCopies(@PathVariable
String userId,
@RequestBody
InstanceGraphRequest instances)
userId - unique identifier for requesting server.instances - instances to save 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.Copyright © 2018 ODPi. All rights reserved.