java.lang.Object

org.odpi.openmetadata.frameworkservices.gaf.server.spring.OpenMetadataStoreResource

@RestController @RequestMapping("/servers/{serverName}/open-metadata/framework-services/{serviceURLMarker}/open-metadata-store/users/{userId}") public class OpenMetadataStoreResource extends Object

OpenMetadataStoreResource supports the REST APIs for running Open Metadata Store Service

Constructor Summary

Constructors

Constructor

Description

OpenMetadataStoreResource()
Method Summary

Modifier and Type

Method

Description

VoidResponse

archiveMetadataElementInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, ArchiveRequestBody requestBody)

Archive a specific metadata element.

VoidResponse

classifyMetadataElementInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, String classificationName, NewClassificationRequestBody requestBody)

Add a new classification to the metadata element.

VoidResponse

clearTranslation(String serverName, String serviceURLMarker, String userId, String elementGUID, String language, String locale, NullRequestBody requestBody)

Remove the translation for a particular language/locale for a metadata element.

VoidResponse

clearValidMetadataMapName(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String preferredValue, NullRequestBody requestBody)

Remove a valid map name value for a property.

VoidResponse

clearValidMetadataMapValue(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String mapName, String preferredValue, NullRequestBody requestBody)

Remove a valid map name value for a property.

VoidResponse

clearValidMetadataValue(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String preferredValue, NullRequestBody requestBody)

Remove a valid value for a property.

GUIDResponse

createMetadataElementFromTemplate(String serverName, String serviceURLMarker, String userId, boolean allowRetrieve, TemplateRequestBody requestBody)

Create a new metadata element in the metadata store using a template.

GUIDResponse

createMetadataElementInStore(String serverName, String serviceURLMarker, String userId, NewOpenMetadataElementRequestBody requestBody)

Create a new metadata element in the metadata store.

GUIDResponse

createRelatedElementsInStore(String serverName, String serviceURLMarker, String userId, NewRelatedElementsRequestBody requestBody)

Create a relationship between two metadata elements.

VoidResponse

declassifyMetadataElementInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, String classificationName, UpdateRequestBody requestBody)

Remove the named classification from a specific metadata element.

VoidResponse

deleteMetadataElementInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, UpdateRequestBody requestBody)

Delete a specific metadata element.

VoidResponse

deleteRelatedElementsInStore(String serverName, String serviceURLMarker, String userId, String relationshipGUID, UpdateRequestBody requestBody)

Delete a relationship between two metadata elements.

OpenMetadataElementsResponse

findMetadataElements(String serverName, String serviceURLMarker, String userId, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, FindRequestBody requestBody)

Return a list of metadata elements that match the supplied criteria.

OpenMetadataElementsResponse

findMetadataElementsWithString(String serverName, String serviceURLMarker, String userId, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, SearchStringRequestBody requestBody)

Retrieve the metadata elements that contain the requested string.

OpenMetadataRelationshipListResponse

findRelationshipsBetweenMetadataElements(String serverName, String serviceURLMarker, String userId, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, FindRelationshipRequestBody requestBody)

Return a list of relationships that match the requested conditions.

TypeDefListResponse

findTypesByExternalId(String serverName, String serviceURLMarker, String userId, String standard, String organization, String identifier)

Return the types that are linked to the elements from the specified standard.

OpenMetadataRelationshipListResponse

getAllMetadataElementRelationships(String serverName, String serviceURLMarker, String userId, String metadataElementAtEnd1GUID, String metadataElementAtEnd2GUID, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, ResultsRequestBody requestBody)

Retrieve the relationships linking the supplied elements.

OpenMetadataRelationshipListResponse

getAllMetadataElementRelationships(String serverName, String serviceURLMarker, String userId, String metadataElementAtEnd1GUID, String metadataElementAtEnd2GUID, boolean forLineage, boolean forDuplicateProcessing, long effectiveTime, int startFrom, int pageSize)

Retrieve the relationships linking the supplied elements.

RelatedMetadataElementListResponse

getAllRelatedMetadataElements(String serverName, String serviceURLMarker, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, int startingAtEnd, int startFrom, int pageSize, ResultsRequestBody requestBody)

Retrieve the metadata elements connected to the supplied element.

RelatedMetadataElementListResponse

getAllRelatedMetadataElements(String serverName, String serviceURLMarker, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, long effectiveTime, int startingAtEnd, int startFrom, int pageSize)

Retrieve the metadata elements connected to the supplied element.

TypeDefGalleryResponse

getAllTypes(String serverName, String serviceURLMarker, String userId)

Returns the list of different types of metadata organized into two groups.

OpenMetadataGraphResponse

getAnchoredElementsGraph(String serverName, String serviceURLMarker, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, AnyTimeRequestBody requestBody)

Return all the elements that are anchored to an asset plus relationships between these elements and to other elements.

AttributeTypeDefResponse

getAttributeTypeDefByGUID(String serverName, String serviceURLMarker, String userId, String guid)

Return the AttributeTypeDef identified by the GUID.

AttributeTypeDefResponse

getAttributeTypeDefByName(String serverName, String serviceURLMarker, String userId, String name)

Return the AttributeTypeDef identified by the unique name.

TypeDefListResponse

getClassificationDefs(String serverName, String serviceURLMarker, String userId)

Returns all the classification type definitions.

ValidMetadataValueListResponse

getConsistentMetadataValues(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String mapName, String preferredValue, int startFrom, int pageSize)

Retrieve all the consistent valid values for the requested property.

TypeDefListResponse

getEntityDefs(String serverName, String serviceURLMarker, String userId)

Returns all the entity type definitions.

OpenMetadataElementResponse

getMetadataElementByGUID(String serverName, String serviceURLMarker, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, long effectiveTime)

Retrieve the metadata element using its unique identifier.

OpenMetadataElementResponse

getMetadataElementByGUID(String serverName, String serviceURLMarker, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, AnyTimeRequestBody requestBody)

Retrieve the metadata element using its unique identifier.

OpenMetadataElementResponse

getMetadataElementByUniqueName(String serverName, String serviceURLMarker, String userId, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody)

Retrieve the metadata element using its unique name (typically the qualified name).

GUIDResponse

getMetadataElementGUIDByUniqueName(String serverName, String serviceURLMarker, String userId, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody)

Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).

OpenMetadataElementsResponse

getMetadataElementHistory(String serverName, String serviceURLMarker, String userId, String elementGUID, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryRequestBody requestBody)

Retrieve all the versions of an element.

OpenMetadataRelationshipListResponse

getMetadataElementRelationships(String serverName, String serviceURLMarker, String userId, String metadataElementAtEnd1GUID, String relationshipTypeName, String metadataElementAtEnd2GUID, boolean forLineage, boolean forDuplicateProcessing, int startFrom, int pageSize, ResultsRequestBody requestBody)

Retrieve the relationships linking the supplied elements via a specific type of relationship.

OpenMetadataRelationshipListResponse

getMetadataElementRelationships(String serverName, String serviceURLMarker, String userId, String metadataElementAtEnd1GUID, String relationshipTypeName, String metadataElementAtEnd2GUID, boolean forLineage, boolean forDuplicateProcessing, long effectiveTime, int startFrom, int pageSize)

Retrieve the relationships linking the supplied elements via a specific type of relationship.

RelatedMetadataElementListResponse

getRelatedMetadataElements(String serverName, String serviceURLMarker, String userId, String elementGUID, String relationshipTypeName, boolean forLineage, boolean forDuplicateProcessing, int startingAtEnd, int startFrom, int pageSize, ResultsRequestBody requestBody)

Retrieve the metadata elements connected to the supplied element via a specific relationship type.

RelatedMetadataElementListResponse

getRelatedMetadataElements(String serverName, String serviceURLMarker, String userId, String elementGUID, String relationshipTypeName, boolean forLineage, boolean forDuplicateProcessing, long effectiveTime, int startingAtEnd, int startFrom, int pageSize)

Retrieve the metadata elements connected to the supplied element via a specific relationship type.

OpenMetadataRelationshipResponse

getRelationshipByGUID(String serverName, String serviceURLMarker, String userId, String relationshipGUID, boolean forLineage, boolean forDuplicateProcessing, long effectiveTime)

Retrieve the relationship using its unique identifier.

OpenMetadataRelationshipResponse

getRelationshipByGUID(String serverName, String serviceURLMarker, String userId, String relationshipGUID, boolean forLineage, boolean forDuplicateProcessing, AnyTimeRequestBody requestBody)

Deprecated.

TypeDefListResponse

getRelationshipDefs(String serverName, String serviceURLMarker, String userId)

Returns all the relationship type definitions.

OpenMetadataRelationshipListResponse

getRelationshipHistory(String serverName, String serviceURLMarker, String userId, String relationshipGUID, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryRequestBody requestBody)

Retrieve all the versions of a relationship.

TypeDefListResponse

getSubTypes(String serverName, String serviceURLMarker, String userId, String typeName)

Returns all the TypeDefs for a specific subtype.

TranslationDetailResponse

getTranslation(String serverName, String serviceURLMarker, String userId, String elementGUID, String language, String locale)

Retrieve the translation for the matching language/locale.

TranslationListResponse

getTranslations(String serverName, String serviceURLMarker, String userId, String elementGUID, int startFrom, int pageSize)

Retrieve all translations associated with a metadata element.

TypeDefResponse

getTypeDefByGUID(String serverName, String serviceURLMarker, String userId, String guid)

Return the TypeDef identified by the GUID.

TypeDefResponse

getTypeDefByName(String serverName, String serviceURLMarker, String userId, String name)

Return the TypeDef identified by the unique name.

ValidMetadataValueResponse

getValidMetadataMapName(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String preferredValue)

Retrieve details of a specific valid name for a map property.

ValidMetadataValueResponse

getValidMetadataMapValue(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String mapName, String preferredValue)

Retrieve details of a specific valid value for a map name.

ValidMetadataValueResponse

getValidMetadataValue(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String preferredValue)

Retrieve details of a specific valid value for a property.

ValidMetadataValueDetailListResponse

getValidMetadataValues(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, int startFrom, int pageSize)

Retrieve all the valid values for the requested property.

VoidResponse

logAssetAuditMessage(String serverName, String serviceURLMarker, String userId, String assetGUID, String callingService, String message)

Log an audit message about an asset.

VoidResponse

reclassifyMetadataElementInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, String classificationName, UpdatePropertiesRequestBody requestBody)

Update the properties of a classification that is currently attached to a specific metadata element.

VoidResponse

setConsistentMetadataValues(String serverName, String serviceURLMarker, String userId, String typeName1, String propertyName1, String mapName1, String preferredValue1, String typeName2, String propertyName2, String mapName2, String preferredValue2, NullRequestBody requestBody)

Set up consistent metadata values relationship between the two property values.

VoidResponse

setTranslation(String serverName, String serviceURLMarker, String userId, String elementGUID, TranslationDetail translationDetail)

Create or update the translation for a particular language/locale for a metadata element.

VoidResponse

setUpValidMetadataMapName(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, ValidMetadataValue validMetadataValue)

Create or update the valid value for a name that can be stored in a particular open metadata property name.

VoidResponse

setUpValidMetadataMapValue(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String mapName, ValidMetadataValue validMetadataValue)

Create or update the valid value for a name that can be stored in a particular open metadata property name.

VoidResponse

setUpValidMetadataValue(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, ValidMetadataValue validMetadataValue)

Create or update the valid value for a particular open metadata property name.

VoidResponse

updateClassificationEffectivityInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, String classificationName, UpdateEffectivityDatesRequestBody requestBody)

Update the effectivity dates of a specific classification attached to a metadata element.

VoidResponse

updateMetadataElementEffectivityInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, UpdateEffectivityDatesRequestBody requestBody)

Update the effectivity dates control the visibility of the element through specific APIs.

VoidResponse

updateMetadataElementInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, UpdatePropertiesRequestBody requestBody)

Update the properties of a specific metadata element.

VoidResponse

updateMetadataElementStatusInStore(String serverName, String serviceURLMarker, String userId, String metadataElementGUID, UpdateStatusRequestBody requestBody)

Update the status of specific metadata element.

VoidResponse

updateRelatedElementsEffectivityInStore(String serverName, String serviceURLMarker, String userId, String relationshipGUID, UpdateEffectivityDatesRequestBody requestBody)

Update the effectivity dates of a specific relationship between metadata elements.

VoidResponse

updateRelatedElementsInStore(String serverName, String serviceURLMarker, String userId, String relationshipGUID, UpdatePropertiesRequestBody requestBody)

Update the properties associated with a relationship.

BooleanResponse

validateMetadataMapName(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String actualValue)

Validate whether the name found in an open metadata map property is valid.

BooleanResponse

validateMetadataMapValue(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String mapName, String actualValue)

Validate whether the name found in an open metadata map property is valid.

BooleanResponse

validateMetadataValue(String serverName, String serviceURLMarker, String userId, String typeName, String propertyName, String actualValue)

Validate whether the value found in an open metadata property is valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- OpenMetadataStoreResource
  
  public OpenMetadataStoreResource()
Method Details
- getAllTypes
  
  @GetMapping(path="/open-metadata-types") public TypeDefGalleryResponse getAllTypes(@PathVariable String serverName, @PathVariable String serviceURLMarker, @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 attributes in full type definitions. Full type definitions (TypeDefs) describe types for entities, relationships and classifications.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  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.
- getEntityDefs
  
  @GetMapping(path="/open-metadata-types/entity-defs") public TypeDefListResponse getEntityDefs(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId)
  
  Returns all the entity type definitions.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - unique identifier for requesting user.
  
  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.
- getRelationshipDefs
  
  @GetMapping(path="/open-metadata-types/relationship-defs") public TypeDefListResponse getRelationshipDefs(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId)
  
  Returns all the relationship type definitions.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - unique identifier for requesting user.
  
  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.
- getClassificationDefs
  
  @GetMapping(path="/open-metadata-types/classification-defs") public TypeDefListResponse getClassificationDefs(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId)
  
  Returns all the classification type definitions.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - unique identifier for requesting user.
  
  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.
- findTypesByExternalId
  
  @GetMapping(path="/open-metadata-types/external-id") public TypeDefListResponse findTypesByExternalId(@PathVariable String serverName, @PathVariable String serviceURLMarker, @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.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  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.
- getSubTypes
  
  @GetMapping(path="/open-metadata-types/sub-types") public TypeDefListResponse getSubTypes(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam String typeName)
  
  Returns all the TypeDefs for a specific subtype. If a null result is returned it means the type has no subtypes.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - unique identifier for requesting user.
  
  typeName - name of type to retrieve against.
  
  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.
- getTypeDefByGUID
  
  @GetMapping(path="/open-metadata-types/guid/{guid}") public TypeDefResponse getTypeDefByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
  
  Return the TypeDef identified by the GUID.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  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="/open-metadata-attribute-types/guid/{guid}") public AttributeTypeDefResponse getAttributeTypeDefByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
  
  Return the AttributeTypeDef identified by the GUID.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  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="/open-metadata-types/name/{name}") public TypeDefResponse getTypeDefByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String name)
  
  Return the TypeDef identified by the unique name.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  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="/open-metadata-attribute-types/name/{name}") public AttributeTypeDefResponse getAttributeTypeDefByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String name)
  
  Return the AttributeTypeDef identified by the unique name.
  
  Parameters:
  
  serverName - unique identifier for requested server.
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  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.
- getMetadataElementByGUID
  
  @GetMapping(path="/metadata-elements/{elementGUID}") public OpenMetadataElementResponse getMetadataElementByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") long effectiveTime)
  
  Retrieve the metadata element using its unique identifier.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier for the metadata element
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  Returns:
  
  metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- getMetadataElementByGUID
  
  @PostMapping(path="/metadata-elements/{elementGUID}") public OpenMetadataElementResponse getMetadataElementByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) AnyTimeRequestBody requestBody)
  
  Retrieve the metadata element using its unique identifier.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier for the metadata element
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  Returns:
  
  metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- getMetadataElementByUniqueName
  
  @PostMapping(path="/metadata-elements/by-unique-name") public OpenMetadataElementResponse getMetadataElementByUniqueName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody NameRequestBody requestBody)
  
  Retrieve the metadata element using its unique name (typically the qualified name).
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  requestBody - unique name for the metadata element
  
  Returns:
  
  metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- getMetadataElementGUIDByUniqueName
  
  @PostMapping(path="/metadata-elements/guid-by-unique-name") public GUIDResponse getMetadataElementGUIDByUniqueName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody NameRequestBody requestBody)
  
  Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  requestBody - unique name for the metadata element
  
  Returns:
  
  metadata element unique identifier (guid) or InvalidParameterException the unique identifier is null or not known or UserNotAuthorizedException the governance action service is not able to access the element or PropertyServerException there is a problem accessing the metadata store
- getMetadataElementHistory
  
  @PostMapping(path="/metadata-elements/{elementGUID}/history") public OpenMetadataElementsResponse getMetadataElementHistory(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean oldestFirst, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) HistoryRequestBody requestBody)
  
  Retrieve all the versions of an element.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - calling user
  
  elementGUID - unique identifier of object to retrieve
  
  startFrom - the starting element number of the historical versions to return. This is used when retrieving versions beyond the first page of results. Zero means start from the first element.
  
  pageSize - the maximum number of result versions that can be returned on this request. Zero means unrestricted return results size.
  
  oldestFirst - defining how the results should be ordered.
  
  forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
  
  forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
  
  requestBody - the time window required
  
  Returns:
  
  list of beans or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem removing the properties from the repositories. UserNotAuthorizedException the requesting user is not authorized to issue this request.
- findMetadataElementsWithString
  
  @PostMapping(path="/metadata-elements/by-search-string") public OpenMetadataElementsResponse findMetadataElementsWithString(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody SearchStringRequestBody requestBody)
  
  Retrieve the metadata elements that contain the requested string.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  requestBody - searchString to retrieve
  
  Returns:
  
  list of matching metadata elements (or null if no elements match the name) or InvalidParameterException the qualified name is null UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- getAllRelatedMetadataElements
  
  @GetMapping(path="/related-elements/{elementGUID}/any-type") public RelatedMetadataElementListResponse getAllRelatedMetadataElements(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") long effectiveTime, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize)
  
  Retrieve the metadata elements connected to the supplied element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier for the starting metadata element
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related elements InvalidParameterException the unique identifier is null or not known; the relationship type is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getRelatedMetadataElements
  
  @GetMapping(path="/related-elements/{elementGUID}/type/{relationshipTypeName}") public RelatedMetadataElementListResponse getRelatedMetadataElements(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") long effectiveTime, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize)
  
  Retrieve the metadata elements connected to the supplied element via a specific relationship type.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier for the starting metadata element
  
  relationshipTypeName - type name of relationships to follow (or null for all)
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related elements InvalidParameterException the unique identifier is null or not known; the relationship type is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getAllRelatedMetadataElements
  
  @PostMapping(path="/related-elements/{elementGUID}/any-type") public RelatedMetadataElementListResponse getAllRelatedMetadataElements(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) ResultsRequestBody requestBody)
  
  Retrieve the metadata elements connected to the supplied element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier for the starting metadata element
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related elements InvalidParameterException the unique identifier is null or not known; the relationship type is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getRelatedMetadataElements
  
  @PostMapping(path="/related-elements/{elementGUID}/type/{relationshipTypeName}") public RelatedMetadataElementListResponse getRelatedMetadataElements(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) ResultsRequestBody requestBody)
  
  Retrieve the metadata elements connected to the supplied element via a specific relationship type.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier for the starting metadata element
  
  relationshipTypeName - type name of relationships to follow (or null for all)
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related elements InvalidParameterException the unique identifier is null or not known; the relationship type is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getAllMetadataElementRelationships
  
  @GetMapping(path="/metadata-elements/{metadataElementAtEnd1GUID}/linked-by-any-type/to-elements/{metadataElementAtEnd2GUID}") public OpenMetadataRelationshipListResponse getAllMetadataElementRelationships(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementAtEnd1GUID, @PathVariable String metadataElementAtEnd2GUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") long effectiveTime, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize)
  
  Retrieve the relationships linking the supplied elements.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementAtEnd1GUID - unique identifier of the metadata element at end 1 of the relationship
  
  metadataElementAtEnd2GUID - unique identifier of the metadata element at end 2 of the relationship
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related elements InvalidParameterException the unique identifier is null or not known; the relationship type is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getMetadataElementRelationships
  
  @GetMapping(path="/metadata-elements/{metadataElementAtEnd1GUID}/linked-by-type/{relationshipTypeName}/to-elements/{metadataElementAtEnd2GUID}") public OpenMetadataRelationshipListResponse getMetadataElementRelationships(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementAtEnd1GUID, @PathVariable String relationshipTypeName, @PathVariable String metadataElementAtEnd2GUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") long effectiveTime, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize)
  
  Retrieve the relationships linking the supplied elements via a specific type of relationship.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementAtEnd1GUID - unique identifier of the metadata element at end 1 of the relationship
  
  metadataElementAtEnd2GUID - unique identifier of the metadata element at end 2 of the relationship
  
  relationshipTypeName - type name of relationships to follow (or null for all)
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related elements InvalidParameterException the unique identifier is null or not known; the relationship type is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getAllMetadataElementRelationships
  
  @PostMapping(path="/metadata-elements/{metadataElementAtEnd1GUID}/linked-by-any-type/to-elements/{metadataElementAtEnd2GUID}") public OpenMetadataRelationshipListResponse getAllMetadataElementRelationships(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementAtEnd1GUID, @PathVariable String metadataElementAtEnd2GUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) ResultsRequestBody requestBody)
  
  Retrieve the relationships linking the supplied elements.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementAtEnd1GUID - unique identifier of the metadata element at end 1 of the relationship
  
  metadataElementAtEnd2GUID - unique identifier of the metadata element at end 2 of the relationship
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related elements InvalidParameterException the unique identifier is null or not known; the relationship type is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getMetadataElementRelationships
  
  @PostMapping(path="/metadata-elements/{metadataElementAtEnd1GUID}/linked-by-type/{relationshipTypeName}/to-elements/{metadataElementAtEnd2GUID}") public OpenMetadataRelationshipListResponse getMetadataElementRelationships(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementAtEnd1GUID, @PathVariable String relationshipTypeName, @PathVariable String metadataElementAtEnd2GUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) ResultsRequestBody requestBody)
  
  Retrieve the relationships linking the supplied elements via a specific type of relationship.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementAtEnd1GUID - unique identifier of the metadata element at end 1 of the relationship
  
  metadataElementAtEnd2GUID - unique identifier of the metadata element at end 2 of the relationship
  
  relationshipTypeName - type name of relationships to follow (or null for all)
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related elements InvalidParameterException the unique identifier is null or not known; the relationship type is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- findMetadataElements
  
  @PostMapping(path="/metadata-elements/by-search-conditions") public OpenMetadataElementsResponse findMetadataElements(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FindRequestBody requestBody)
  
  Return a list of metadata elements that match the supplied criteria. The results can be returned over many pages.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  requestBody - properties defining the search criteria
  
  Returns:
  
  a list of elements matching the supplied criteria; null means no matching elements in the metadata store. InvalidParameterException one of the search parameters are is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getAnchoredElementsGraph
  
  @PostMapping(path="/metadata-elements/{elementGUID}/with-anchored-elements") public OpenMetadataGraphResponse getAnchoredElementsGraph(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) AnyTimeRequestBody requestBody)
  
  Return all the elements that are anchored to an asset plus relationships between these elements and to other elements.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - the userId of the requesting user
  
  elementGUID - unique identifier for the element
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved elements are for duplicate processing so do not combine results from known duplicates.
  
  startFrom - starting element (used in paging through large result sets)
  
  pageSize - maximum number of results to return
  
  requestBody - effective time and asOfTime
  
  Returns:
  
  graph of elements or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem retrieving the connected asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- findRelationshipsBetweenMetadataElements
  
  @PostMapping(path="/relationships/by-search-conditions") public OpenMetadataRelationshipListResponse findRelationshipsBetweenMetadataElements(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody FindRelationshipRequestBody requestBody)
  
  Return a list of relationships that match the requested conditions. The results can be received as a series of pages.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  requestBody - properties defining the search criteria
  
  Returns:
  
  a list of relationships - null means no matching relationships - or InvalidParameterException one of the search parameters are is invalid UserNotAuthorizedException the governance action service is not able to access the elements PropertyServerException there is a problem accessing the metadata store
- getRelationshipByGUID
  
  @GetMapping(path="/relationships/by-guid/{relationshipGUID}") public OpenMetadataRelationshipResponse getRelationshipByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestParam(required=false,defaultValue="0") long effectiveTime)
  
  Retrieve the relationship using its unique identifier.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  relationshipGUID - unique identifier for the metadata element
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  Returns:
  
  metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- getRelationshipByGUID
  
  @PostMapping(path="/relationships/by-guid/{relationshipGUID}") @Deprecated public OpenMetadataRelationshipResponse getRelationshipByGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) AnyTimeRequestBody requestBody)
  
  Deprecated.
  
  Retrieve the relationship using its unique identifier.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  relationshipGUID - unique identifier for the metadata element
  
  forLineage - the retrieved element is for lineage processing so include archived elements
  
  forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
  
  requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
  
  Returns:
  
  metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- getRelationshipHistory
  
  @PostMapping(path="/relationships/{relationshipGUID}/history") public OpenMetadataRelationshipListResponse getRelationshipHistory(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean oldestFirst, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) HistoryRequestBody requestBody)
  
  Retrieve all the versions of a relationship.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - calling user
  
  relationshipGUID - unique identifier of object to retrieve
  
  startFrom - the starting element number of the historical versions to return. This is used when retrieving versions beyond the first page of results. Zero means start from the first element.
  
  pageSize - the maximum number of result versions that can be returned on this request. Zero means unrestricted return results size.
  
  oldestFirst - defining how the results should be ordered.
  
  forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
  
  forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
  
  requestBody - the time window required
  
  Returns:
  
  list of beans or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem removing the properties from the repositories. UserNotAuthorizedException the requesting user is not authorized to issue this request.
- createMetadataElementInStore
  
  @PostMapping(path="/metadata-elements") public GUIDResponse createMetadataElementInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody NewOpenMetadataElementRequestBody requestBody)
  
  Create a new metadata element in the metadata store. The type name comes from the open metadata types. The selected type also controls the names and types of the properties that are allowed. This version of the method allows access to advanced features such as multiple states and effectivity dates.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  requestBody - properties for the new element
  
  Returns:
  
  unique identifier of the new metadata element InvalidParameterException the type name, status or one of the properties is invalid UserNotAuthorizedException the governance action service is not authorized to create this type of element PropertyServerException there is a problem with the metadata store
- createMetadataElementFromTemplate
  
  @PostMapping(path="/metadata-elements/from-template") public GUIDResponse createMetadataElementFromTemplate(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false,defaultValue="false") boolean allowRetrieve, @RequestBody TemplateRequestBody requestBody)
  
  Create a new metadata element in the metadata store using a template. The type name comes from the open metadata types. The selected type also controls the names and types of the properties that are allowed.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  allowRetrieve - can an existing element be returned if it exists
  
  requestBody - properties for the new element
  
  Returns:
  
  unique identifier of the new metadata element InvalidParameterException the type name, status or one of the properties is invalid UserNotAuthorizedException the governance action service is not authorized to create this type of element PropertyServerException there is a problem with the metadata store
- updateMetadataElementInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/update-properties") public VoidResponse updateMetadataElementInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @RequestBody UpdatePropertiesRequestBody requestBody)
  
  Update the properties of a specific metadata element. The properties must match the type definition associated with the metadata element when it was created. However, it is possible to update a few properties, or replace all them by the value used in the replaceProperties flag.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  requestBody - new properties
  
  Returns:
  
  void or InvalidParameterException either the unique identifier or the properties are invalid in some way UserNotAuthorizedException the governance action service is not authorized to update this element PropertyServerException there is a problem with the metadata store
- updateMetadataElementStatusInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/update-status") public VoidResponse updateMetadataElementStatusInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @RequestBody UpdateStatusRequestBody requestBody)
  
  Update the status of specific metadata element. The new status must match a status value that is defined for the element's type assigned when it was created.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  requestBody - new status values - use null to leave as is
  
  Returns:
  
  void or InvalidParameterException either the unique identifier or the status are invalid in some way UserNotAuthorizedException the governance action service is not authorized to update this element PropertyServerException there is a problem with the metadata store
- updateMetadataElementEffectivityInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/update-effectivity") public VoidResponse updateMetadataElementEffectivityInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @RequestBody UpdateEffectivityDatesRequestBody requestBody)
  
  Update the effectivity dates control the visibility of the element through specific APIs.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  requestBody - new status values - use null to leave as is
  
  Returns:
  
  void or InvalidParameterException either the unique identifier or the status are invalid in some way UserNotAuthorizedException the governance action service is not authorized to update this element PropertyServerException there is a problem with the metadata store
- deleteMetadataElementInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/delete") public VoidResponse deleteMetadataElementInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @RequestBody(required=false) UpdateRequestBody requestBody)
  
  Delete a specific metadata element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the unique identifier is null or invalid in some way UserNotAuthorizedException the governance action service is not authorized to delete this element PropertyServerException there is a problem with the metadata store
- archiveMetadataElementInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/archive") public VoidResponse archiveMetadataElementInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @RequestBody(required=false) ArchiveRequestBody requestBody)
  
  Archive a specific metadata element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the unique identifier is null or invalid in some way UserNotAuthorizedException the governance action service is not authorized to archive this element PropertyServerException there is a problem with the metadata store
- classifyMetadataElementInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/classifications/{classificationName}") public VoidResponse classifyMetadataElementInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @PathVariable String classificationName, @RequestBody NewClassificationRequestBody requestBody)
  
  Add a new classification to the metadata element. Note that only one classification with the same name can be attached to a metadata element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  classificationName - name of the classification to add (if the classification is already present then use reclassify)
  
  requestBody - properties to store in the new classification. These must conform to the valid properties associated with the classification name
  
  Returns:
  
  void or InvalidParameterException the unique identifier or classification name is null or invalid in some way; properties do not match the valid properties associated with the classification's type definition UserNotAuthorizedException the governance action service is not authorized to update this element PropertyServerException there is a problem with the metadata store
- reclassifyMetadataElementInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/classifications/{classificationName}/update-properties") public VoidResponse reclassifyMetadataElementInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @PathVariable String classificationName, @RequestBody UpdatePropertiesRequestBody requestBody)
  
  Update the properties of a classification that is currently attached to a specific metadata element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  classificationName - unique name of the classification to update
  
  requestBody - new properties for the classification
  
  Returns:
  
  void or InvalidParameterException the unique identifier or classification name is null or invalid in some way; properties do not match the valid properties associated with the classification's type definition UserNotAuthorizedException the governance action service is not authorized to update this element/classification PropertyServerException there is a problem with the metadata store
- updateClassificationEffectivityInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/classifications/{classificationName}/update-effectivity") public VoidResponse updateClassificationEffectivityInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @PathVariable String classificationName, @RequestBody UpdateEffectivityDatesRequestBody requestBody)
  
  Update the effectivity dates of a specific classification attached to a metadata element. The effectivity dates control the visibility of the classification through specific APIs.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  classificationName - unique name of the classification to update
  
  requestBody - the dates when this element is active / inactive - null for no restriction
  
  Returns:
  
  void or InvalidParameterException either the unique identifier or the status are invalid in some way UserNotAuthorizedException the governance action service is not authorized to update this element PropertyServerException there is a problem with the metadata store
- declassifyMetadataElementInStore
  
  @PostMapping(path="/metadata-elements/{metadataElementGUID}/classifications/{classificationName}/delete") public VoidResponse declassifyMetadataElementInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String metadataElementGUID, @PathVariable String classificationName, @RequestBody UpdateRequestBody requestBody)
  
  Remove the named classification from a specific metadata element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  metadataElementGUID - unique identifier of the metadata element to update
  
  classificationName - unique name of the classification to remove
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the unique identifier or classification name is null or invalid in some way UserNotAuthorizedException the governance action service is not authorized to remove this classification PropertyServerException there is a problem with the metadata store
- createRelatedElementsInStore
  
  @PostMapping(path="/related-elements") public GUIDResponse createRelatedElementsInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody NewRelatedElementsRequestBody requestBody)
  
  Create a relationship between two metadata elements. It is important to put the right element at each end of the relationship according to the type definition since this will affect how the relationship is interpreted.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  requestBody - the properties of the relationship
  
  Returns:
  
  unique identifier of the new relationship or InvalidParameterException the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship UserNotAuthorizedException the governance action service is not authorized to create this type of relationship PropertyServerException there is a problem with the metadata store
- updateRelatedElementsInStore
  
  @PostMapping(path="/related-elements/{relationshipGUID}/update-properties") public VoidResponse updateRelatedElementsInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody UpdatePropertiesRequestBody requestBody)
  
  Update the properties associated with a relationship.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  relationshipGUID - unique identifier of the relationship to update
  
  requestBody - new properties for the relationship
  
  Returns:
  
  void or InvalidParameterException the unique identifier of the relationship is null or invalid in some way; the properties are not valid for this type of relationship UserNotAuthorizedException the governance action service is not authorized to update this relationship PropertyServerException there is a problem with the metadata store
- updateRelatedElementsEffectivityInStore
  
  @PostMapping(path="/related-elements/{relationshipGUID}/update-effectivity") public VoidResponse updateRelatedElementsEffectivityInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody UpdateEffectivityDatesRequestBody requestBody)
  
  Update the effectivity dates of a specific relationship between metadata elements. The effectivity dates control the visibility of the classification through specific APIs.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  relationshipGUID - unique identifier of the relationship to update
  
  requestBody - the dates when this element is active / inactive - null for no restriction
  
  Returns:
  
  void or InvalidParameterException either the unique identifier or the status are invalid in some way UserNotAuthorizedException the governance action service is not authorized to update this element PropertyServerException there is a problem with the metadata store
- deleteRelatedElementsInStore
  
  @PostMapping(path="/related-elements/{relationshipGUID}/delete") public VoidResponse deleteRelatedElementsInStore(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody UpdateRequestBody requestBody)
  
  Delete a relationship between two metadata elements.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  relationshipGUID - unique identifier of the relationship to delete
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the unique identifier of the relationship is null or invalid in some way UserNotAuthorizedException the governance action service is not authorized to delete this relationship PropertyServerException there is a problem with the metadata store
- setTranslation
  
  @PostMapping(path="/multi-language/set-translation/{elementGUID}") public VoidResponse setTranslation(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestBody TranslationDetail translationDetail)
  
  Create or update the translation for a particular language/locale for a metadata element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier of the element that this translation is related to
  
  translationDetail - properties of the translation
  
  Returns:
  
  void or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- clearTranslation
  
  @PostMapping(path="/multi-language/clear-translation/{elementGUID}") public VoidResponse clearTranslation(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false) String language, @RequestParam(required=false) String locale, @RequestBody(required=false) NullRequestBody requestBody)
  
  Remove the translation for a particular language/locale for a metadata element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier of the element that this translation is related to
  
  language - language requested
  
  locale - optional locale to qualify which translation if there are multiple translations for the language
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the language is null or not known or not unique (add locale) UserNotAuthorizedException the service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- getTranslation
  
  @GetMapping(path="/multi-language/get-translation/{elementGUID}") public TranslationDetailResponse getTranslation(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false) String language, @RequestParam(required=false) String locale)
  
  Retrieve the translation for the matching language/locale.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier of the element that this translation is related to
  
  language - language requested
  
  locale - optional locale to qualify which translation if there are multiple translations for the language.
  
  Returns:
  
  the properties of the translation or null if there is none or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- getTranslations
  
  @GetMapping(path="/multi-language/get-translations/{elementGUID}") public TranslationListResponse getTranslations(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)
  
  Retrieve all translations associated with a metadata element.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  elementGUID - unique identifier of the element that this translation is related to
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return
  
  Returns:
  
  list of translation properties or null if there are none or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the service is not able to access the element PropertyServerException there is a problem accessing the metadata store
- setUpValidMetadataValue
  
  @PostMapping(path="/valid-metadata-values/setup-value/{propertyName}") public VoidResponse setUpValidMetadataValue(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestBody ValidMetadataValue validMetadataValue)
  
  Create or update the valid value for a particular open metadata property name. If the typeName is null, this valid value applies to properties of this name from all types. The valid value is stored in the preferredValue property. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  validMetadataValue - preferred value to use in the open metadata types plus additional descriptive values.
  
  Returns:
  
  void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- setUpValidMetadataMapName
  
  @PostMapping(path="/valid-metadata-values/setup-map-name/{propertyName}") public VoidResponse setUpValidMetadataMapName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestBody ValidMetadataValue validMetadataValue)
  
  Create or update the valid value for a name that can be stored in a particular open metadata property name. This property is of type map from name to string. The valid value is stored in the preferredValue property of validMetadataValue. If the typeName is null, this valid value applies to properties of this name from any open metadata type. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  validMetadataValue - preferred value to use in the open metadata types plus additional descriptive values.
  
  Returns:
  
  void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- setUpValidMetadataMapValue
  
  @PostMapping(path="/valid-metadata-values/setup-map-value/{propertyName}/{mapName}") public VoidResponse setUpValidMetadataMapValue(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @PathVariable String mapName, @RequestBody ValidMetadataValue validMetadataValue)
  
  Create or update the valid value for a name that can be stored in a particular open metadata property name. This property is of type map from name to string. The valid value is stored in the preferredValue property of validMetadataValue. If the typeName is null, this valid value applies to properties of this name from any open metadata type. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  mapName - name in the map that this valid value applies. If null then the value can be used for any name in the map.
  
  validMetadataValue - preferred value to use in the open metadata types plus additional descriptive values.
  
  Returns:
  
  void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- clearValidMetadataValue
  
  @PostMapping(path="/valid-metadata-values/clear-value/{propertyName}") public VoidResponse clearValidMetadataValue(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam(required=false) String preferredValue, @RequestBody(required=false) NullRequestBody requestBody)
  
  Remove a valid value for a property.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  preferredValue - specific valid value to remove
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- clearValidMetadataMapName
  
  @PostMapping(path="/valid-metadata-values/clear-map-name/{propertyName}") public VoidResponse clearValidMetadataMapName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam(required=false) String preferredValue, @RequestBody(required=false) NullRequestBody requestBody)
  
  Remove a valid map name value for a property. The match is done on preferred name.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  preferredValue - specific valid value to remove
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- clearValidMetadataMapValue
  
  @PostMapping(path="/valid-metadata-values/clear-map-value/{propertyName}/{mapName}") public VoidResponse clearValidMetadataMapValue(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @PathVariable String mapName, @RequestParam(required=false) String preferredValue, @RequestBody(required=false) NullRequestBody requestBody)
  
  Remove a valid map name value for a property. The match is done on preferred name.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  mapName - name in the map that this valid value applies. If null then the value can be used for any name in the map.
  
  preferredValue - specific valid value to remove
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- validateMetadataValue
  
  @GetMapping(path="/valid-metadata-values/validate-value/{propertyName}") public BooleanResponse validateMetadataValue(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam String actualValue)
  
  Validate whether the value found in an open metadata property is valid.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  actualValue - value stored in the property - if this is null, true is only returned if null is set up as a valid value.
  
  Returns:
  
  boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value) or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- validateMetadataMapName
  
  @GetMapping(path="/valid-metadata-values/validate-map-name/{propertyName}") public BooleanResponse validateMetadataMapName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam String actualValue)
  
  Validate whether the name found in an open metadata map property is valid.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  actualValue - value stored in the property - if this is null, true is only returned if null is set up as a valid value.
  
  Returns:
  
  boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value) or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- validateMetadataMapValue
  
  @GetMapping(path="/valid-metadata-values/validate-map-value/{propertyName}/{mapName}") public BooleanResponse validateMetadataMapValue(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @PathVariable String mapName, @RequestParam String actualValue)
  
  Validate whether the name found in an open metadata map property is valid.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  mapName - name in the map that this valid value applies. If null then the value can be used for any name in the map.
  
  actualValue - value stored in the property - if this is null, true is only returned if null is set up as a valid value.
  
  Returns:
  
  boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value) or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- getValidMetadataValue
  
  @GetMapping(path="/valid-metadata-values/get-value/{propertyName}") public ValidMetadataValueResponse getValidMetadataValue(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam String preferredValue)
  
  Retrieve details of a specific valid value for a property.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  preferredValue - valid value to match
  
  Returns:
  
  specific valid value definition or none if there is no definition stored or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- getValidMetadataMapName
  
  @GetMapping(path="/valid-metadata-values/get-map-name/{propertyName}") public ValidMetadataValueResponse getValidMetadataMapName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam String preferredValue)
  
  Retrieve details of a specific valid name for a map property.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  preferredValue - valid value to match
  
  Returns:
  
  specific valid value definition or none if there is no definition stored or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- getValidMetadataMapValue
  
  @GetMapping(path="/valid-metadata-values/get-map-value/{propertyName}/{mapName}") public ValidMetadataValueResponse getValidMetadataMapValue(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @PathVariable String mapName, @RequestParam String preferredValue)
  
  Retrieve details of a specific valid value for a map name.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  mapName - name in the map that this valid value applies. If null then the value can be used for any name in the map.
  
  preferredValue - valid value to match
  
  Returns:
  
  specific valid value definition or none if there is no definition stored or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- getValidMetadataValues
  
  @GetMapping(path="/valid-metadata-values/get-valid-metadata-values/{propertyName}") public ValidMetadataValueDetailListResponse getValidMetadataValues(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam int startFrom, @RequestParam int pageSize)
  
  Retrieve all the valid values for the requested property.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of valid values defined for the property or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- getConsistentMetadataValues
  
  @GetMapping(path="/valid-metadata-values/{propertyName}/consistent-metadata-values") public ValidMetadataValueListResponse getConsistentMetadataValues(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam(required=false) String mapName, @RequestParam String preferredValue, @RequestParam int startFrom, @RequestParam int pageSize)
  
  Retrieve all the consistent valid values for the requested property.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName - name of property that this valid value applies
  
  mapName - optional name of map key that this valid value applies
  
  preferredValue - the value to match against
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of valid values defined for the property or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- setConsistentMetadataValues
  
  @PostMapping(path="/valid-metadata-values/{propertyName1}/consistent-metadata-values/{propertyName2}") public VoidResponse setConsistentMetadataValues(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) String typeName1, @PathVariable String propertyName1, @RequestParam(required=false) String mapName1, @RequestParam String preferredValue1, @RequestParam(required=false) String typeName2, @PathVariable String propertyName2, @RequestParam(required=false) String mapName2, @RequestParam String preferredValue2, @RequestBody(required=false) NullRequestBody requestBody)
  
  Set up consistent metadata values relationship between the two property values.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - caller's userId
  
  typeName1 - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName1 - name of property that this valid value applies
  
  mapName1 - optional name of map key that this valid value applies
  
  preferredValue1 - the value to match against
  
  typeName2 - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types
  
  propertyName2 - name of property that this valid value applies
  
  mapName2 - optional name of map key that this valid value applies
  
  preferredValue2 - the value to match against
  
  requestBody - null request body
  
  Returns:
  
  void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
- logAssetAuditMessage
  
  @PostMapping(path="/assets/{assetGUID}/log-records/{callingService}") public VoidResponse logAssetAuditMessage(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String callingService, @RequestBody String message)
  
  Log an audit message about an asset.
  
  Parameters:
  
  serverName - name of server instance to route request to
  
  serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
  
  userId - userId of user making request.
  
  assetGUID - unique identifier for asset.
  
  callingService - unique name for governance service.
  
  message - message to log
  
  Returns:
  
  void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem that occurred within the property server.

Class OpenMetadataStoreResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

OpenMetadataStoreResource

Method Details

getAllTypes

getEntityDefs

getRelationshipDefs

getClassificationDefs

findTypesByExternalId

getSubTypes

getTypeDefByGUID

getAttributeTypeDefByGUID

getTypeDefByName

getAttributeTypeDefByName

getMetadataElementByGUID

getMetadataElementByGUID

getMetadataElementByUniqueName

getMetadataElementGUIDByUniqueName

getMetadataElementHistory

findMetadataElementsWithString

getAllRelatedMetadataElements

getRelatedMetadataElements

getAllRelatedMetadataElements

getRelatedMetadataElements

getAllMetadataElementRelationships

getMetadataElementRelationships

getAllMetadataElementRelationships

getMetadataElementRelationships

findMetadataElements

getAnchoredElementsGraph

findRelationshipsBetweenMetadataElements

getRelationshipByGUID

getRelationshipByGUID

getRelationshipHistory

createMetadataElementInStore

createMetadataElementFromTemplate

updateMetadataElementInStore

updateMetadataElementStatusInStore

updateMetadataElementEffectivityInStore

deleteMetadataElementInStore

archiveMetadataElementInStore

classifyMetadataElementInStore

reclassifyMetadataElementInStore

updateClassificationEffectivityInStore

declassifyMetadataElementInStore

createRelatedElementsInStore

updateRelatedElementsInStore

updateRelatedElementsEffectivityInStore

deleteRelatedElementsInStore

setTranslation

clearTranslation

getTranslation

getTranslations

setUpValidMetadataValue

setUpValidMetadataMapName

setUpValidMetadataMapValue

clearValidMetadataValue

clearValidMetadataMapName

clearValidMetadataMapValue

validateMetadataValue

validateMetadataMapName

validateMetadataMapValue

getValidMetadataValue

getValidMetadataMapName

getValidMetadataMapValue

getValidMetadataValues

getConsistentMetadataValues

setConsistentMetadataValues

logAssetAuditMessage