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

Class ClassificationExplorerResource

java.lang.Object

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

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class ClassificationExplorerResource
extends Object

The ClassificationExplorerResource provides the Spring API endpoints of the Classification Explorer Open Metadata View Service (OMVS).

Constructor Summary

Constructors

Constructor	Description
ClassificationExplorerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	addDataScope(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Add the data scope classification to an element.
VoidResponse	addDigitalResourceOrigin(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Add the digital resource origin classification for an element.
VoidResponse	addGovernanceExpectations(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Add the governance expectations classification to an element.
VoidResponse	addGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Add the governance measurements classification to an element.
VoidResponse	addMoreInformationToElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody)	Link a resource to an element using the MoreInformation relationship.
VoidResponse	addOwnership(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Add the ownership classification for an element.
VoidResponse	addResourceListToElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody)	Link a resource to an element using the ResourceList relationship.
VoidResponse	addScopeToElement(String serverName, String urlMarker, String elementGUID, String scopeGUID, NewRelationshipRequestBody requestBody)	Link a scope to an element using the ScopedBy relationship.
GUIDResponse	addSearchKeywordToElement(String serverName, String urlMarker, String elementGUID, NewAttachmentRequestBody requestBody)	Creates a search keyword and attaches it to an element.
VoidResponse	addSecurityTags(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Add the security tags for an element.
VoidResponse	addZoneMembership(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Add the zone membership classification for an element.
VoidResponse	assignActorToElement(String serverName, String urlMarker, String elementGUID, String actorGUID, NewRelationshipRequestBody requestBody)	Attach an actor to an element.
VoidResponse	clearConfidenceClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the confidence classification from the element.
VoidResponse	clearConfidentialityClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the confidence classification from the element.
VoidResponse	clearConsolidatedDuplicateClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the ConsolidatedDuplicate classification from the element.
VoidResponse	clearCriticalityClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the criticality classification from the element.
VoidResponse	clearDataScope(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the data scope classification from an element.
VoidResponse	clearDigitalResourceOrigin(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the digital resource origin classification for an element.
VoidResponse	clearGovernanceExpectations(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the governance expectations classification from an element.
VoidResponse	clearGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the governance measurements classification from an element.
VoidResponse	clearImpactClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the impact classification from the element.
VoidResponse	clearKnownDuplicateClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the KnownDuplicate classification from the element.
VoidResponse	clearOwnership(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the ownership classification from an element.
VoidResponse	clearRetentionClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the retention classification from the element.
VoidResponse	clearSecurityTags(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the security tags classification from an element.
VoidResponse	clearSemanticAssignment(String serverName, String urlMarker, String elementGUID, String glossaryTermGUID, DeleteRelationshipRequestBody requestBody)	Remove a semantic assignment relationship between an element and its glossary term.
VoidResponse	clearZoneMembership(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody)	Remove the ownership classification from an element.
OpenMetadataRootElementsResponse	findAuthoredElements(String serverName, String urlMarker, ContentStatusSearchString requestBody)	Returns the list of authored elements matching the search string and optional content status.
OpenMetadataRootElementsResponse	findElementsByClassificationWithPropertyValue(String serverName, String urlMarker, String classificationName, FindPropertyNamesProperties requestBody)	Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified.
OpenMetadataRootElementsResponse	findElementsByPropertyValue(String serverName, String urlMarker, FindPropertyNamesProperties requestBody)	Retrieve elements by a value found in one of the properties specified.
OpenMetadataRootElementsResponse	findRelatedElementsWithPropertyValue(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, FindPropertyNamesProperties requestBody)	Retrieve elements linked via the requested relationship type name and with the relationship's properties specified.
MetadataRelationshipSummariesResponse	findRelationshipsWithPropertyValue(String serverName, String urlMarker, String relationshipTypeName, FindPropertyNamesProperties requestBody)	Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified.
MetadataRelationshipSummariesResponse	findRelationshipsWithPropertyValue(String serverName, String urlMarker, FindPropertyNamesProperties requestBody)	Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified.
OpenMetadataRootElementsResponse	findRootElements(String serverName, String urlMarker, FindRequestBody requestBody)	Retrieve elements that match the complex query.
OpenMetadataRootElementsResponse	findSearchKeywords(String serverName, String urlMarker, SearchStringRequestBody requestBody)	Return the list of search keywords containing the supplied string.
OpenMetadataRootElementsResponse	geCertifiedElements(String serverName, String urlMarker, String certificationTypeGUID, ResultsRequestBody requestBody)	Return information about the elements linked to a certification type.
OpenMetadataRootElementsResponse	getAuthoredElementsByCategory(String serverName, String urlMarker, ContentStatusFilterRequestBody requestBody)	Returns the list of authored elements matching the category and optional content status.
OpenMetadataRootElementsResponse	getCertifications(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)	Return information about the certifications linked to an element.
OpenMetadataRootElementsResponse	getConfidenceClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)	Return information about the elements classified with the confidence classification.
OpenMetadataRootElementsResponse	getConfidentialityClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)	Return information about the elements classified with the confidentiality classification.
OpenMetadataRootElementsResponse	getCriticalityClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)	Return information about the elements classified with the criticality classification.
OpenMetadataRootElementsResponse	getElements(String serverName, String urlMarker, ResultsRequestBody requestBody)	Retrieve elements of the requested type name.
OpenMetadataRootElementsResponse	getElementsByCategory(String serverName, String urlMarker, FilterRequestBody requestBody)	Return the list of search keywords containing the supplied string.
OpenMetadataRootElementsResponse	getElementsByClassification(String serverName, String urlMarker, String classificationName, ResultsRequestBody requestBody)	Retrieve elements with the requested classification name.
OpenMetadataRootElementsResponse	getElementsByClassificationWithPropertyValue(String serverName, String urlMarker, String classificationName, FindPropertyNamesProperties requestBody)	Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified.
OpenMetadataRootElementsResponse	getElementsByOrigin(String serverName, String urlMarker, FindDigitalResourceOriginProperties requestBody)	Return information about the digital resources from a specific origin.
OpenMetadataRootElementsResponse	getElementsByPropertyValue(String serverName, String urlMarker, FindPropertyNamesProperties requestBody)	Retrieve elements by a value found in one of the properties specified.
OpenMetadataRootElementsResponse	getElementsSourcedFrom(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)	Retrieve the elements linked via a "SourcedFrom" relationship to the requested element.
OpenMetadataRootElementsResponse	getGovernedByDefinitions(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)	Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
OpenMetadataRootElementsResponse	getGovernedElements(String serverName, String urlMarker, String governanceDefinitionGUID, ResultsRequestBody requestBody)	Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
OpenMetadataRootElementsResponse	getImpactClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)	Return information about the elements classified with the impact classification.
OpenMetadataRootElementsResponse	getLicensedElements(String serverName, String urlMarker, String licenseTypeGUID, ResultsRequestBody requestBody)	Return information about the elements linked to a license type.
OpenMetadataRootElementsResponse	getLicenses(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)	Return information about the licenses linked to an element.
OpenMetadataRootElementsResponse	getMeanings(String serverName, String urlMarker, String elementGUID, SemanticAssignmentQueryProperties requestBody)	Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
OpenMetadataRootElementResponse	getMetadataElementByGUID(String serverName, String urlMarker, String elementGUID, GetRequestBody requestBody)	Retrieve the metadata element using its unique identifier.
OpenMetadataRootElementResponse	getMetadataElementByUniqueName(String serverName, String urlMarker, FindPropertyNameProperties requestBody)	Retrieve the metadata element using its unique name (typically the qualified name).
GUIDResponse	getMetadataElementGUIDByUniqueName(String serverName, String urlMarker, FindPropertyNameProperties requestBody)	Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
OpenMetadataRootElementsResponse	getOwnersElements(String serverName, String urlMarker, FilterRequestBody requestBody)	Return information about the elements classified with the ownership classification.
OpenMetadataRootElementsResponse	getRelatedElements(String serverName, String urlMarker, String elementGUID, int startingAtEnd, ResultsRequestBody requestBody)	Retrieve related elements of any type name.
OpenMetadataRootElementsResponse	getRelatedElements(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, ResultsRequestBody requestBody)	Retrieve related elements of the requested type name.
OpenMetadataRootElementsResponse	getRelatedElementsWithPropertyValue(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, FindPropertyNamesProperties requestBody)	Retrieve elements linked via the requested relationship type name and with the requested value found in one of the relationship's properties specified.
MetadataRelationshipSummariesResponse	getRelationships(String serverName, String urlMarker, String relationshipTypeName, ResultsRequestBody requestBody)	Retrieve relationships of the requested relationship type name.
MetadataRelationshipSummariesResponse	getRelationships(String serverName, String urlMarker, ResultsRequestBody requestBody)	Retrieve relationships of the requested relationship type name.
MetadataRelationshipSummariesResponse	getRelationshipsWithPropertyValue(String serverName, String urlMarker, String relationshipTypeName, FindPropertyNamesProperties requestBody)	Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified.
MetadataRelationshipSummariesResponse	getRelationshipsWithPropertyValue(String serverName, String urlMarker, FindPropertyNamesProperties requestBody)	Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified.
OpenMetadataRootElementsResponse	getResourceList(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)	Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.
OpenMetadataRootElementsResponse	getRetentionClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)	Return information about the elements classified with the retention classification.
OpenMetadataRootElementsResponse	getScopedElements(String serverName, String urlMarker, String scopeGUID, ResultsRequestBody requestBody)	Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.
OpenMetadataRootElementsResponse	getScopes(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)	Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.
OpenMetadataRootElementResponse	getSearchKeywordByGUID(String serverName, String urlMarker, String searchKeywordGUID, GetRequestBody requestBody)	Return the requested searchKeyword.
OpenMetadataRootElementsResponse	getSearchKeywordByKeyword(String serverName, String urlMarker, FilterRequestBody requestBody)	Return the list of search keywords containing the supplied keyword.
OpenMetadataRootElementsResponse	getSecurityTaggedElements(String serverName, String urlMarker, SecurityTagQueryProperties requestBody)	Return information about the elements classified with the security tags classification.
OpenMetadataRootElementsResponse	getSemanticAssignees(String serverName, String urlMarker, String glossaryTermGUID, SemanticAssignmentQueryProperties requestBody)	Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.
OpenMetadataRootElementsResponse	getSourceElements(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)	Retrieve the elements linked via a "SourceFrom" relationship to the requested element.
OpenMetadataRootElementsResponse	getSupportedByResource(String serverName, String urlMarker, String resourceGUID, ResultsRequestBody requestBody)	Retrieve the elements linked via a "ResourceList" relationship to the requested resource.
VoidResponse	linkConsolidatedDuplicateToSource(String serverName, String urlMarker, String elementGUID, String sourceElementGUID, NewRelationshipRequestBody requestBody)	Create a relationship between two elements that shows that one is a combination of a number of duplicates, and it should be used instead.
VoidResponse	linkElementsAsPeerDuplicates(String serverName, String urlMarker, String elementGUID, String peerDuplicateGUID, NewRelationshipRequestBody requestBody)	Create a relationship between two elements that show they represent the same "thing".
VoidResponse	removeMoreInformationFromElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, DeleteRelationshipRequestBody requestBody)	Remove the MoreInformation relationship between a resource and an element.
VoidResponse	removeResourceListFromElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, DeleteRelationshipRequestBody requestBody)	Remove the ResourceList relationship between a resource and an element.
VoidResponse	removeScopeFromElement(String serverName, String urlMarker, String elementGUID, String scopeGUID, DeleteRelationshipRequestBody requestBody)	Remove the ScopedBy relationship between a scope and an element.
VoidResponse	removeSearchKeywordFromElement(String serverName, String urlMarker, String searchKeywordGUID, DeleteElementRequestBody requestBody)	Removes a search keyword added to the element by this user.
ElementHeaderResponse	retrieveInstanceForGUID(String serverName, String urlMarker, String guid, GetRequestBody requestBody)	Retrieve the header for the instance identified by the supplied unique identifier.
VoidResponse	setConfidenceClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Classify the element (typically an asset) to indicate the level of confidence that the organization has that the data is complete, accurate and up-to-date.
VoidResponse	setConfidentialityClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Classify the element (typically a data field, schema attribute or glossary term) to indicate the level of confidentiality that any data associated with the element should be given.
VoidResponse	setConsolidatedDuplicateClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Classify the element to indicate that it is derived from one or more duplicates in the open metadata ecosystem.
VoidResponse	setCriticalityClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Classify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization.
VoidResponse	setImpactClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Classify the element to indicate the level of impact it is having or likely to have on the organization.
VoidResponse	setKnownDuplicateClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Classify the element to indicate that is has one or more duplicate in the open metadata ecosystem.
VoidResponse	setRetentionClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody)	Classify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization.
VoidResponse	setupSemanticAssignment(String serverName, String urlMarker, String elementGUID, String glossaryTermGUID, NewRelationshipRequestBody requestBody)	Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset).
VoidResponse	unassignActorFromElement(String serverName, String urlMarker, String elementGUID, String actorGUID, DeleteRelationshipRequestBody requestBody)	Detach an actor from an element.
VoidResponse	unlinkConsolidatedDuplicateFromSourceElement(String serverName, String urlMarker, String elementGUID, String sourceElementGUID, DeleteRelationshipRequestBody requestBody)	Remove the ConsolidatedDuplicateLink relationship between two elements that showed they represent the same "thing".
VoidResponse	unlinkElementsAsPeerDuplicates(String serverName, String urlMarker, String elementGUID, String peerDuplicateGUID, DeleteRelationshipRequestBody requestBody)	Remove the PeerDuplicateLink a relationship between two elements that showed they represent the same "thing".
VoidResponse	updateDataScope(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody)	Update the data scope classification for an element.
VoidResponse	updateGovernanceExpectations(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody)	Update the governance expectations classification for an element.
VoidResponse	updateGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody)	Update the governance measurements classification for an element.
BooleanResponse	updateSearchKeyword(String serverName, String urlMarker, String searchKeywordGUID, UpdateElementRequestBody requestBody)	Update an existing search keyword.

Methods inherited from class java.lang.Object

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

Constructor Details

ClassificationExplorerResource

public ClassificationExplorerResource()

Default constructor

Method Details

setImpactClassification

@PostMapping(path="/elements/{elementGUID}/impact")
public VoidResponse setImpactClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify the element to indicate the level of impact it is having or likely to have on the organization. The level of impact is expressed by the levelIdentifier property.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to classify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearImpactClassification

@PostMapping(path="/elements/{elementGUID}/impact/remove")
public VoidResponse clearImpactClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the impact classification from the element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to declassify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

setConfidenceClassification

@PostMapping(path="/elements/{elementGUID}/confidence")
public VoidResponse setConfidenceClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify the element (typically an asset) to indicate the level of confidence that the organization has that the data is complete, accurate and up-to-date. The level of confidence is expressed by the levelIdentifier property.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to classify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearConfidenceClassification

@PostMapping(path="/elements/{elementGUID}/confidence/remove")
public VoidResponse clearConfidenceClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidence to assign to the element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to declassify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

setCriticalityClassification

@PostMapping(path="/elements/{elementGUID}/criticality")
public VoidResponse setCriticalityClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization. The level of criticality is expressed by the levelIdentifier property.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to classify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearCriticalityClassification

@PostMapping(path="/elements/{elementGUID}/criticality/remove")
public VoidResponse clearCriticalityClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the criticality classification from the element. This normally occurs when the organization has lost track of the level of criticality to assign to the element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to declassify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

setConfidentialityClassification

@PostMapping(path="/elements/{elementGUID}/confidentiality")
public VoidResponse setConfidentialityClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify the element (typically a data field, schema attribute or glossary term) to indicate the level of confidentiality that any data associated with the element should be given. If the classification is attached to a glossary term, the level of confidentiality is a suggestion for any element linked to the glossary term via the SemanticAssignment classification. The level of confidence is expressed by the levelIdentifier property.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to classify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearConfidentialityClassification

@PostMapping(path="/elements/{elementGUID}/confidentiality/remove")
public VoidResponse clearConfidentialityClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidentiality to assign to the element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to declassify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

setRetentionClassification

@PostMapping(path="/elements/{elementGUID}/retention")
public VoidResponse setRetentionClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization. The policy to apply to the element/resource is captured by the retentionBasis property. The dates after which the element/resource is archived and then deleted are specified in the archiveAfter and deleteAfter properties respectively.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to classify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearRetentionClassification

@PostMapping(path="/elements/{elementGUID}/retention/remove")
public VoidResponse clearRetentionClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the retention classification from the element. This normally occurs when the organization has lost track of, or no longer needs to track the retention period to assign to the element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to declassify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addGovernanceExpectations

@PostMapping(path="/elements/{elementGUID}/governance-expectations")
public VoidResponse addGovernanceExpectations(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Add the governance expectations classification to an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element to attach to

requestBody - list of security labels and properties

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

updateGovernanceExpectations

@PostMapping(path="/elements/{elementGUID}/governance-expectations/update")
public VoidResponse updateGovernanceExpectations(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 UpdateClassificationRequestBody requestBody)

Update the governance expectations classification for an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element to attach to

requestBody - list of security labels and properties

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearGovernanceExpectations

@PostMapping(path="/elements/{elementGUID}/governance-expectations/remove")
public VoidResponse clearGovernanceExpectations(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the governance expectations classification from an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element

requestBody - null request body

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addGovernanceMeasurements

@PostMapping(path="/elements/{elementGUID}/governance-measurements")
public VoidResponse addGovernanceMeasurements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Add the governance measurements classification to an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element to attach to

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

updateGovernanceMeasurements

@PostMapping(path="/elements/{elementGUID}/governance-measurements/update")
public VoidResponse updateGovernanceMeasurements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 UpdateClassificationRequestBody requestBody)

Update the governance measurements classification for an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element to attach to

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearGovernanceMeasurements

@PostMapping(path="/elements/{elementGUID}/governance-measurements/remove")
public VoidResponse clearGovernanceMeasurements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the governance measurements classification from an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element

requestBody - null request body

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addDataScope

@PostMapping(path="/elements/{elementGUID}/data-scope")
public VoidResponse addDataScope(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Add the data scope classification to an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element to attach to

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

updateDataScope

@PostMapping(path="/elements/{elementGUID}/data-scope/update")
public VoidResponse updateDataScope(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 UpdateClassificationRequestBody requestBody)

Update the data scope classification for an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element to attach to

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearDataScope

@PostMapping(path="/elements/{elementGUID}/data-scope/remove")
public VoidResponse clearDataScope(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the data scope classification from an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element

requestBody - null request body

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSecurityTags

@PostMapping(path="/elements/{elementGUID}/security-tags")
public VoidResponse addSecurityTags(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Add the security tags for an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element to attach to

requestBody - list of security labels and properties

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearSecurityTags

@PostMapping(path="/elements/{elementGUID}/security-tags/remove")
public VoidResponse clearSecurityTags(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the security tags classification from an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of element

requestBody - null request body

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addOwnership

@PostMapping(path="/elements/{elementGUID}/ownership")
public VoidResponse addOwnership(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Add the ownership classification for an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - element to link it to - its type must inherit from Referenceable.

requestBody - properties for classification request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearOwnership

@PostMapping(path="/elements/{elementGUID}/ownership/remove")
public VoidResponse clearOwnership(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the ownership classification from an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - element where the classification needs to be removed.

requestBody - properties for classification request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addDigitalResourceOrigin

@PostMapping(path="/elements/{elementGUID}/digital-resource-origin")
public VoidResponse addDigitalResourceOrigin(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Add the digital resource origin classification for an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - element to link it to - its type must inherit from Referenceable.

requestBody - properties for classification request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearDigitalResourceOrigin

@PostMapping(path="/elements/{elementGUID}/digital-resource-origin/remove")
public VoidResponse clearDigitalResourceOrigin(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the digital resource origin classification for an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - element where the classification needs to be removed.

requestBody - properties for classification request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addZoneMembership

@PostMapping(path="/elements/{elementGUID}/zone-membership")
public VoidResponse addZoneMembership(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Add the zone membership classification for an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - element to link it to - its type must inherit from Referenceable.

requestBody - properties for classification request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearZoneMembership

@PostMapping(path="/elements/{elementGUID}/zone-membership/remove")
public VoidResponse clearZoneMembership(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the ownership classification from an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - element where the classification needs to be removed.

requestBody - properties for classification request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

setupSemanticAssignment

@PostMapping(path="/elements/{elementGUID}/semantic-assignment/terms/{glossaryTermGUID}/attach")
public VoidResponse setupSemanticAssignment(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String glossaryTermGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset). This relationship indicates that the data associated with the element meaning matches the description in the glossary term.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that is being assigned to the glossary term

glossaryTermGUID - unique identifier of the glossary term that provides the meaning

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearSemanticAssignment

@PostMapping(path="/elements/{elementGUID}/semantic-assignment/terms/{glossaryTermGUID}/detach")
public VoidResponse clearSemanticAssignment(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String glossaryTermGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove a semantic assignment relationship between an element and its glossary term.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that is being assigned to the glossary term

glossaryTermGUID - unique identifier of the glossary term that provides the meaning

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addScopeToElement

@PostMapping(path="/elements/{elementGUID}/scoped-by/{scopeGUID}/attach")
public VoidResponse addScopeToElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String scopeGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Link a scope to an element using the ScopedBy relationship.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to link

scopeGUID - identifier of the scope to link

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

removeScopeFromElement

@PostMapping(path="/elements/{elementGUID}/scoped-by/{scopeGUID}/detach")
public VoidResponse removeScopeFromElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String scopeGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove the ScopedBy relationship between a scope and an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to update

scopeGUID - identifier of the scope to link

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

assignActorToElement

@PostMapping(path="/elements/{elementGUID}/assigned-to-actor/{actorGUID}/attach")
public VoidResponse assignActorToElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String actorGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach an actor to an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element (project, product, etc.)

actorGUID - unique identifier of the actor

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

unassignActorFromElement

@PostMapping(path="/elements/{elementGUID}/assigned-to-actor/{actorGUID}/detach")
public VoidResponse unassignActorFromElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String actorGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach an actor from an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element (project, product, etc.)

actorGUID - unique identifier of the actor

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addResourceListToElement

@PostMapping(path="/elements/{elementGUID}/resource-list/{resourceGUID}/attach")
public VoidResponse addResourceListToElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String resourceGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Link a resource to an element using the ResourceList relationship.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to link

resourceGUID - identifier of the resource to link

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

removeResourceListFromElement

@PostMapping(path="/elements/{elementGUID}/resource-list/{resourceGUID}/detach")
public VoidResponse removeResourceListFromElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String resourceGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove the ResourceList relationship between a resource and an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to update

resourceGUID - identifier of the resource to link

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addMoreInformationToElement

@PostMapping(path="/elements/{elementGUID}/more-information/{resourceGUID}/attach")
public VoidResponse addMoreInformationToElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String resourceGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Link a resource to an element using the MoreInformation relationship.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to link

resourceGUID - identifier of the resource to link

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

removeMoreInformationFromElement

@PostMapping(path="/elements/{elementGUID}/more-information/{resourceGUID}/detach")
public VoidResponse removeMoreInformationFromElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String resourceGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove the MoreInformation relationship between a resource and an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to update

resourceGUID - identifier of the resource to link

requestBody - properties for relationship request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSearchKeywordToElement

@PostMapping(path="/elements/{elementGUID}/search-keywords")
public GUIDResponse addSearchKeywordToElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewAttachmentRequestBody requestBody)

Creates a search keyword and attaches it to an element.

Parameters:

serverName - name of the server instances for this request.

urlMarker - view service URL marker

elementGUID - String - unique id for the element.

requestBody - containing type of search keyword enum and the text of the searchKeyword.

Returns:

elementGUID for new search keyword object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

updateSearchKeyword

@PostMapping(path="/search-keywords/{searchKeywordGUID}/update")
public BooleanResponse updateSearchKeyword(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String searchKeywordGUID,
 @RequestBody(required=false)
 UpdateElementRequestBody requestBody)

Update an existing search keyword.

Parameters:

serverName - name of the server instances for this request.

urlMarker - view service URL marker

searchKeywordGUID - unique identifier for the search keyword to change.

requestBody - containing type of search keyword enum and the text of the searchKeyword.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

removeSearchKeywordFromElement

@PostMapping(path="/search-keywords/{searchKeywordGUID}/remove")
public VoidResponse removeSearchKeywordFromElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String searchKeywordGUID,
 @RequestBody(required=false)
 DeleteElementRequestBody requestBody)

Removes a search keyword added to the element by this user. This deletes the link to the search keyword and the search keyword itself.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

searchKeywordGUID - String - unique id for the search keyword object

requestBody - containing type of search keyword enum and the text of the searchKeyword.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the user does not have permission to perform this request.

linkElementsAsPeerDuplicates

@PostMapping(path="/related-elements/{elementGUID}/peer-duplicate/{peerDuplicateGUID}/attach")
public VoidResponse linkElementsAsPeerDuplicates(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String peerDuplicateGUID,
 @RequestBody
 NewRelationshipRequestBody requestBody)

Create a relationship between two elements that show they represent the same "thing". If the relationship already exists, the properties are updated.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to link

peerDuplicateGUID - identifier of the duplicate to link

requestBody - parameters for the relationship

Returns:

void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

unlinkElementsAsPeerDuplicates

@PostMapping(path="/related-elements/{elementGUID}/peer-duplicate/{peerDuplicateGUID}/detach")
public VoidResponse unlinkElementsAsPeerDuplicates(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String peerDuplicateGUID,
 @RequestBody
 DeleteRelationshipRequestBody requestBody)

Remove the PeerDuplicateLink a relationship between two elements that showed they represent the same "thing".

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to link

peerDuplicateGUID - identifier of the duplicate to link

requestBody - parameters for the relationship

Returns:

void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

setKnownDuplicateClassification

@PostMapping(path="/elements/{elementGUID}/known-duplicate")
public VoidResponse setKnownDuplicateClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify the element to indicate that is has one or more duplicate in the open metadata ecosystem.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to classify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearKnownDuplicateClassification

@PostMapping(path="/elements/{elementGUID}/known-duplicate/remove")
public VoidResponse clearKnownDuplicateClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the KnownDuplicate classification from the element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to declassify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

linkConsolidatedDuplicateToSource

@PostMapping(path="/related-elements/{elementGUID}/consolidated-duplicate-source/{sourceElementGUID}/attach")
public VoidResponse linkConsolidatedDuplicateToSource(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String sourceElementGUID,
 @RequestBody
 NewRelationshipRequestBody requestBody)

Create a relationship between two elements that shows that one is a combination of a number of duplicates, and it should be used instead.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to link

sourceElementGUID - identifier of the source to link

requestBody - parameters for the relationship

Returns:

void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

unlinkConsolidatedDuplicateFromSourceElement

@PostMapping(path="/related-elements/{elementGUID}/consolidated-duplicate-source/{sourceElementGUID}/detach")
public VoidResponse unlinkConsolidatedDuplicateFromSourceElement(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String sourceElementGUID,
 @RequestBody
 DeleteRelationshipRequestBody requestBody)

Remove the ConsolidatedDuplicateLink relationship between two elements that showed they represent the same "thing".

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to link

sourceElementGUID - identifier of the source to link

requestBody - parameters for the relationship

Returns:

void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

setConsolidatedDuplicateClassification

@PostMapping(path="/elements/{elementGUID}/consolidated-duplicate")
public VoidResponse setConsolidatedDuplicateClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify the element to indicate that it is derived from one or more duplicates in the open metadata ecosystem.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to classify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

clearConsolidatedDuplicateClassification

@PostMapping(path="/elements/{elementGUID}/consolidated-duplicate/remove")
public VoidResponse clearConsolidatedDuplicateClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the ConsolidatedDuplicate classification from the element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the metadata element to declassify

requestBody - properties for the request

Returns:

void or InvalidParameterException guid or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getImpactClassifiedElements

@PostMapping(path="/elements/by-impact")
public OpenMetadataRootElementsResponse getImpactClassifiedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 LevelIdentifierQueryProperties requestBody)

Return information about the elements classified with the impact classification.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties for the request

Returns:

classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getConfidenceClassifiedElements

@PostMapping(path="/elements/by-confidence")
public OpenMetadataRootElementsResponse getConfidenceClassifiedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 LevelIdentifierQueryProperties requestBody)

Return information about the elements classified with the confidence classification.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties for the request

Returns:

classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getCriticalityClassifiedElements

@PostMapping(path="/elements/by-criticality")
public OpenMetadataRootElementsResponse getCriticalityClassifiedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 LevelIdentifierQueryProperties requestBody)

Return information about the elements classified with the criticality classification.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties for the request

Returns:

classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getConfidentialityClassifiedElements

@PostMapping(path="/elements/by-confidentiality")
public OpenMetadataRootElementsResponse getConfidentialityClassifiedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 LevelIdentifierQueryProperties requestBody)

Return information about the elements classified with the confidentiality classification.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties for the request

Returns:

classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getRetentionClassifiedElements

@PostMapping(path="/elements/by-retention")
public OpenMetadataRootElementsResponse getRetentionClassifiedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 LevelIdentifierQueryProperties requestBody)

Return information about the elements classified with the retention classification.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties for the request

Returns:

classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getSecurityTaggedElements

@PostMapping(path="/elements/by-security-tags")
public OpenMetadataRootElementsResponse getSecurityTaggedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 SecurityTagQueryProperties requestBody)

Return information about the elements classified with the security tags classification.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties for the request

Returns:

classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getOwnersElements

@PostMapping(path="/elements/by-ownership")
public OpenMetadataRootElementsResponse getOwnersElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Return information about the elements classified with the ownership classification.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties for the request

Returns:

classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getElementsByOrigin

@PostMapping(path="/elements/by-digital-resource-origin")
public OpenMetadataRootElementsResponse getElementsByOrigin(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FindDigitalResourceOriginProperties requestBody)

Return information about the digital resources from a specific origin.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties for the request

Returns:

classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getMeanings

@PostMapping("/glossaries/terms/by-semantic-assignment/{elementGUID}")
public OpenMetadataRootElementsResponse getMeanings(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 SemanticAssignmentQueryProperties requestBody)

Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that is being assigned to the glossary term

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getSemanticAssignees

@PostMapping("/elements/by-semantic-assignment/{glossaryTermGUID}")
public OpenMetadataRootElementsResponse getSemanticAssignees(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String glossaryTermGUID,
 @RequestBody(required=false)
 SemanticAssignmentQueryProperties requestBody)

Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getGovernedElements

@PostMapping(path="/elements/governed-by/{governanceDefinitionGUID}")
public OpenMetadataRootElementsResponse getGovernedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String governanceDefinitionGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

governanceDefinitionGUID - unique identifier of the governance definition that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getGovernedByDefinitions

@PostMapping(path="/elements/{elementGUID}/governed-by")
public OpenMetadataRootElementsResponse getGovernedByDefinitions(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getSourceElements

@PostMapping(path="/elements/{elementGUID}/source")
public OpenMetadataRootElementsResponse getSourceElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were used to create the requested element. Typically only one element is returned.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getElementsSourcedFrom

@PostMapping(path="/elements/{elementGUID}/sourced-from")
public OpenMetadataRootElementsResponse getElementsSourcedFrom(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the elements linked via a "SourcedFrom" relationship to the requested element. The elements returned were created using the requested element as a template.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getScopes

@PostMapping(path="/elements/{elementGUID}/scoped-by")
public OpenMetadataRootElementsResponse getScopes(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getScopedElements

@PostMapping(path="/elements/scoped-by/{scopeGUID}")
public OpenMetadataRootElementsResponse getScopedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String scopeGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

scopeGUID - unique identifier of the element that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getResourceList

@PostMapping(path="/elements/{elementGUID}/resource-list")
public OpenMetadataRootElementsResponse getResourceList(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getSupportedByResource

@PostMapping(path="/elements/resource-list/{resourceGUID}")
public OpenMetadataRootElementsResponse getSupportedByResource(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String resourceGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the elements linked via a "ResourceList" relationship to the requested resource.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

resourceGUID - unique identifier of the element that the returned elements are linked to

requestBody - properties for relationship request

Returns:

linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getLicensedElements

@PostMapping(path="/elements/licenses/{licenseTypeGUID}")
public OpenMetadataRootElementsResponse getLicensedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String licenseTypeGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Return information about the elements linked to a license type.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

licenseTypeGUID - unique identifier for the license

requestBody - additional query parameters

Returns:

properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getLicenses

@PostMapping(path="/elements/{elementGUID}/licenses")
public OpenMetadataRootElementsResponse getLicenses(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Return information about the licenses linked to an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier for the license

requestBody - additional query parameters

Returns:

properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

geCertifiedElements

@PostMapping(path="/elements/certifications/{certificationTypeGUID}")
public OpenMetadataRootElementsResponse geCertifiedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String certificationTypeGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Return information about the elements linked to a certification type.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

certificationTypeGUID - unique identifier for the license

requestBody - additional query parameters

Returns:

properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getCertifications

@PostMapping(path="/elements/{elementGUID}/certifications")
public OpenMetadataRootElementsResponse getCertifications(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Return information about the certifications linked to an element.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier for the license

requestBody - additional query parameters

Returns:

properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getMetadataElementByGUID

@PostMapping(path="/elements/{elementGUID}")
public OpenMetadataRootElementResponse getMetadataElementByGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Retrieve the metadata element using its unique identifier.

Parameters:

serverName - name of server instance to route request to

urlMarker - view service URL marker

elementGUID - unique identifier for the metadata element

requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.

Returns:

metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException a problem accessing the metadata store

getMetadataElementByUniqueName

@PostMapping(path="/elements/by-unique-name")
public OpenMetadataRootElementResponse getMetadataElementByUniqueName(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FindPropertyNameProperties requestBody)

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

Parameters:

serverName - name of server instance to route request to

urlMarker - view service URL marker

requestBody - unique name for the metadata element

Returns:

metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException a problem accessing the metadata store

getMetadataElementGUIDByUniqueName

@PostMapping(path="/elements/guid-by-unique-name")
public GUIDResponse getMetadataElementGUIDByUniqueName(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody
 FindPropertyNameProperties requestBody)

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

Parameters:

serverName - name of server instance to route request to

urlMarker - view service URL marker

requestBody - unique name for the metadata element

Returns:

metadata element unique identifier (guid) or InvalidParameterException the unique identifier is null or not known or UserNotAuthorizedException the governance action service is not able to access the element or PropertyServerException a problem accessing the metadata store

getElements

@PostMapping(path="/elements/by-type")
public OpenMetadataRootElementsResponse getElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve elements of the requested type name.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findRootElements

@PostMapping(path="/elements/by-complex-query")
public OpenMetadataRootElementsResponse findRootElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FindRequestBody requestBody)

Retrieve elements that match the complex query.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getElementsByPropertyValue

@PostMapping(path="/elements/by-exact-property-value")
public OpenMetadataRootElementsResponse getElementsByPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve elements by a value found in one of the properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the results.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findElementsByPropertyValue

@PostMapping(path="/elements/by-property-value-search")
public OpenMetadataRootElementsResponse findElementsByPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve elements by a value found in one of the properties specified. The value must only be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findAuthoredElements

@PostMapping(path="/authored-elements/by-search-string")
public OpenMetadataRootElementsResponse findAuthoredElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ContentStatusSearchString requestBody)

Returns the list of authored elements matching the search string and optional content status.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

a list of authored elements InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

getAuthoredElementsByCategory

@PostMapping(path="/authored-elements/by-category")
public OpenMetadataRootElementsResponse getAuthoredElementsByCategory(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ContentStatusFilterRequestBody requestBody)

Returns the list of authored elements matching the category and optional content status.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

a list of authored elements InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

getElementsByClassification

@PostMapping(path="/elements/by-classification/{classificationName}")
public OpenMetadataRootElementsResponse getElementsByClassification(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String classificationName,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve elements with the requested classification name. It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of element may be returned.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

classificationName - name of classification

requestBody - open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getElementsByClassificationWithPropertyValue

@PostMapping(path="/elements/by-classification/{classificationName}/with-exact-property-value")
public OpenMetadataRootElementsResponse getElementsByClassificationWithPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String classificationName,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

classificationName - name of classification

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findElementsByClassificationWithPropertyValue

@PostMapping(path="/elements/by-classification/{classificationName}/with-property-value-search")
public OpenMetadataRootElementsResponse findElementsByClassificationWithPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String classificationName,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must only be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

classificationName - name of classification

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getRelatedElements

@PostMapping(path="/elements/{elementGUID}/by-relationship")
public OpenMetadataRootElementsResponse getRelatedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestParam(required=false,defaultValue="0")
 int startingAtEnd,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve related elements of any type name.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the starting element

startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)

requestBody - open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getRelatedElements

@PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}")
public OpenMetadataRootElementsResponse getRelatedElements(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String relationshipTypeName,
 @RequestParam(required=false,defaultValue="0")
 int startingAtEnd,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve related elements of the requested type name.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the starting element

relationshipTypeName - name of relationship

startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)

requestBody - open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getRelatedElementsWithPropertyValue

@PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}/with-exact-property-value")
public OpenMetadataRootElementsResponse getRelatedElementsWithPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String relationshipTypeName,
 @RequestParam(required=false,defaultValue="0")
 int startingAtEnd,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve elements linked via the requested relationship type name and with the requested value found in one of the relationship's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the starting element

relationshipTypeName - name of relationship

startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findRelatedElementsWithPropertyValue

@PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}/with-property-value-search")
public OpenMetadataRootElementsResponse findRelatedElementsWithPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String relationshipTypeName,
 @RequestParam(required=false,defaultValue="0")
 int startingAtEnd,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve elements linked via the requested relationship type name and with the relationship's properties specified. The value must only be contained in the by a value found in one of the properties specified. The value must only be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementGUID - unique identifier of the starting element

relationshipTypeName - name of relationship

startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getRelationships

@PostMapping(path="/relationships")
public MetadataRelationshipSummariesResponse getRelationships(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve relationships of the requested relationship type name.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getRelationships

@PostMapping(path="/relationships/{relationshipTypeName}")
public MetadataRelationshipSummariesResponse getRelationships(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String relationshipTypeName,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve relationships of the requested relationship type name.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getRelationshipsWithPropertyValue

@PostMapping(path="/relationships/with-exact-property-value")
public MetadataRelationshipSummariesResponse getRelationshipsWithPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must match exactly.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getRelationshipsWithPropertyValue

@PostMapping(path="/relationships/{relationshipTypeName}/with-exact-property-value")
public MetadataRelationshipSummariesResponse getRelationshipsWithPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String relationshipTypeName,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must match exactly.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

relationshipTypeName - name of relationship

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findRelationshipsWithPropertyValue

@PostMapping(path="/relationships/with-property-value-search")
public MetadataRelationshipSummariesResponse findRelationshipsWithPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must only be contained in the properties rather than needing to be an exact match.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findRelationshipsWithPropertyValue

@PostMapping(path="/relationships/{relationshipTypeName}/with-property-value-search")
public MetadataRelationshipSummariesResponse findRelationshipsWithPropertyValue(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String relationshipTypeName,
 @RequestBody(required=false)
 FindPropertyNamesProperties requestBody)

Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must only be contained in the properties rather than needing to be an exact match.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

relationshipTypeName - name of relationship

requestBody - properties and optional open metadata type to search on

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

retrieveInstanceForGUID

@PostMapping(path="/guids/{guid}")
public ElementHeaderResponse retrieveInstanceForGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String guid,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Retrieve the header for the instance identified by the supplied unique identifier. It may be an element (entity) or a relationship between elements.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

guid - identifier to use in the lookup

Returns:

list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getElementsByCategory

@PostMapping(path="/elements/by-category")
public OpenMetadataRootElementsResponse getElementsByCategory(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Return the list of search keywords containing the supplied string.

Parameters:

serverName - name of the server instances for this request.

urlMarker - view service URL marker

requestBody - search string and effective time.

Returns:

list of search keyword objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findSearchKeywords

@PostMapping(path="/search-keywords/by-search-string")
public OpenMetadataRootElementsResponse findSearchKeywords(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 SearchStringRequestBody requestBody)

Return the list of search keywords containing the supplied string.

Parameters:

serverName - name of the server instances for this request.

urlMarker - view service URL marker

requestBody - search string and effective time.

Returns:

list of search keyword objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getSearchKeywordByKeyword

@PostMapping(path="/search-keywords/by-keyword")
public OpenMetadataRootElementsResponse getSearchKeywordByKeyword(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Return the list of search keywords containing the supplied keyword.

Parameters:

serverName - name of the server instances for this request.

urlMarker - view service URL marker

requestBody - search string and effective time.

Returns:

list of search keyword objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getSearchKeywordByGUID

@PostMapping(path="/search-keywords/{searchKeywordGUID}/retrieve")
public OpenMetadataRootElementResponse getSearchKeywordByGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String searchKeywordGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Return the requested searchKeyword.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

searchKeywordGUID - unique identifier for the search keyword object.

requestBody - optional effective time

Returns:

search keyword properties or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.