Class ClassificationManagerResource
java.lang.Object
org.odpi.openmetadata.viewservices.classificationmanager.server.spring.ClassificationManagerResource
@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/classification-manager")
public class ClassificationManagerResource
extends Object
The ClassificationManagerResource provides the Spring API endpoints of the Classification Manager Open Metadata View Service (OMVS).
This interface provides a service for Egeria UIs.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddElementToSubjectArea
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the element to assert that the definitions it represents are part of a subject area definition.addGovernanceDefinitionToElement
(String serverName, String definitionGUID, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Link a governance definition to an element using the GovernedBy relationship.addOwnership
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Add or replace the ownership classification for an element.addSecurityTags
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Add or replace the security tags for an element.clearConfidenceClassification
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeRequestBody requestBody) Remove the confidence classification from the element.clearConfidentialityClassification
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeRequestBody requestBody) Remove the confidence classification from the element.clearCriticalityClassification
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeRequestBody requestBody) Remove the criticality classification from the element.clearOwnership
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the ownership classification from an element.clearRetentionClassification
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeRequestBody requestBody) Remove the retention classification from the element.clearSecurityTags
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the security tags classification from an element.clearSemanticAssignment
(String serverName, String elementGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a semantic assignment relationship between an element and its glossary term.findElementsByClassificationWithPropertyValue
(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindPropertyNamesProperties requestBody) Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified.findElementsByPropertyValue
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindPropertyNamesProperties requestBody) Retrieve elements by a value found in one of the properties specified.findRelatedElementsWithPropertyValue
(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindPropertyNamesProperties requestBody) Retrieve elements linked via the requested relationship type name and with the relationship's properties specified.findRelationshipsWithPropertyValue
(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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.getElements
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindProperties requestBody) Retrieve elements of the requested type name.getElementsByClassification
(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindProperties requestBody) Retrieve elements with the requested classification name.getElementsByClassificationWithPropertyValue
(String serverName, String classificationName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindPropertyNamesProperties requestBody) Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified.getElementsByPropertyValue
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindPropertyNamesProperties requestBody) Retrieve elements by a value found in one of the properties specified.getMetadataElementByGUID
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the metadata element using its unique identifier.getMetadataElementByUniqueName
(String serverName, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the metadata element using its unique name (typically the qualified name).getMetadataElementGUIDByUniqueName
(String serverName, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).getRelatedElements
(String serverName, String elementGUID, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindProperties requestBody) Retrieve related elements of any type name.getRelatedElements
(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindProperties requestBody) Retrieve related elements of the requested type name.getRelatedElementsWithPropertyValue
(String serverName, String elementGUID, String relationshipTypeName, int startingAtEnd, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindPropertyNamesProperties requestBody) Retrieve elements linked via the requested relationship type name and with the requested a value found in one of the classification's properties specified.getRelationships
(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindProperties requestBody) Retrieve relationships of the requested relationship type name.getRelationshipsWithPropertyValue
(String serverName, String relationshipTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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.removeElementFromSubjectArea
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the subject area designation from the identified element.removeGovernanceDefinitionFromElement
(String serverName, String definitionGUID, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove the GovernedBy relationship between a governance definition and an element.retrieveInstanceForGUID
(String serverName, String guid, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeRequestBody requestBody) Retrieve the header for the instance identified by the supplied unique identifier.setConfidenceClassification
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify/reclassify 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.setConfidentialityClassification
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify/reclassify 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.setCriticalityClassification
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization.setRetentionClassification
(String serverName, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify/reclassify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization.setupSemanticAssignment
(String serverName, String elementGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset).
-
Constructor Details
-
ClassificationManagerResource
public ClassificationManagerResource()Default constructor
-
-
Method Details
-
setConfidenceClassification
@PostMapping(path="/elements/{elementGUID}/confidence") public VoidResponse setConfidenceClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Classify/reclassify 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 toelementGUID
- unique identifier of the metadata element to classifyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeRequestBody 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 toelementGUID
- unique identifier of the metadata element to declassifyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Classify/reclassify 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 toelementGUID
- unique identifier of the metadata element to classifyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeRequestBody 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 toelementGUID
- unique identifier of the metadata element to declassifyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Classify/reclassify 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 toelementGUID
- unique identifier of the metadata element to classifyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeRequestBody 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 toelementGUID
- unique identifier of the metadata element to declassifyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Classify/reclassify 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 toelementGUID
- unique identifier of the metadata element to classifyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeRequestBody 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 toelementGUID
- unique identifier of the metadata element to declassifyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Add or replace the security tags for an element.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of element to attach toforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- list of security labels and properties- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Remove the security tags classification from an element.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- null request body- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Add or replace the ownership classification for an element.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- element to link it to - its type must inherit from Referenceable.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for classification request- Returns:
- void or InvalidParameterException full path 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 elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Remove the ownership classification from an element.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- element where the classification needs to be removed.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for classification request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
addElementToSubjectArea
@PostMapping(path="/elements/{elementGUID}/subject-area-member") public VoidResponse addElementToSubjectArea(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Classify the element to assert that the definitions it represents are part of a subject area definition.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the metadata element to updateforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for classification request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
removeElementFromSubjectArea
@PostMapping(path="/elements/{elementGUID}/subject-area-member/remove") public VoidResponse removeElementFromSubjectArea(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ClassificationRequestBody requestBody) Remove the subject area designation from the identified element.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the metadata element to updateforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for classification request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
setupSemanticAssignment
@PostMapping(path="/elements/{elementGUID}/semantic-assignment/terms/{glossaryTermGUID}") public VoidResponse setupSemanticAssignment(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) RelationshipRequestBody 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 toelementGUID
- unique identifier of the element that is being assigned to the glossary termglossaryTermGUID
- unique identifier of the glossary term that provides the meaningforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
clearSemanticAssignment
@PostMapping(path="/elements/{elementGUID}/semantic-assignment/terms/{glossaryTermGUID}/remove") public VoidResponse clearSemanticAssignment(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody) Remove a semantic assignment relationship between an element and its glossary term.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the element that is being assigned to the glossary termglossaryTermGUID
- unique identifier of the glossary term that provides the meaningforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
addGovernanceDefinitionToElement
@PostMapping(path="/elements/{elementGUID}/governed-by/definition/{definitionGUID}") public VoidResponse addGovernanceDefinitionToElement(@PathVariable String serverName, @PathVariable String definitionGUID, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) RelationshipRequestBody requestBody) Link a governance definition to an element using the GovernedBy relationship.- Parameters:
serverName
- name of the server instance to connect todefinitionGUID
- identifier of the governance definition to linkelementGUID
- unique identifier of the metadata element to linkforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
removeGovernanceDefinitionFromElement
@PostMapping(path="/elements/{elementGUID}/governed-by/definition/{definitionGUID}/remove") public VoidResponse removeGovernanceDefinitionFromElement(@PathVariable String serverName, @PathVariable String definitionGUID, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody) Remove the GovernedBy relationship between a governance definition and an element.- Parameters:
serverName
- name of the server instance to connect todefinitionGUID
- identifier of the governance definition to linkelementGUID
- unique identifier of the metadata element to updateforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getMetadataElementByGUID
@PostMapping(path="/elements/{elementGUID}") public MetadataElementSummaryResponse getMetadataElementByGUID(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody) Retrieve the metadata element using its unique identifier.- Parameters:
serverName
- name of server instance to route request toelementGUID
- unique identifier for the metadata elementforLineage
- the retrieved element is for lineage processing so include archived elementsforDuplicateProcessing
- the retrieved element is for duplicate processing so do not combine results from known duplicates.requestBody
- only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.- Returns:
- metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store
-
getMetadataElementByUniqueName
@PostMapping(path="/elements/by-unique-name") public MetadataElementSummaryResponse getMetadataElementByUniqueName(@PathVariable String serverName, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) NameRequestBody requestBody) Retrieve the metadata element using its unique name (typically the qualified name).- Parameters:
serverName
- name of server instance to route request toforLineage
- the retrieved element is for lineage processing so include archived elementsforDuplicateProcessing
- the retrieved element is for duplicate processing so do not combine results from known duplicates.requestBody
- unique name for the metadata element- Returns:
- metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store
-
getMetadataElementGUIDByUniqueName
@PostMapping(path="/elements/guid-by-unique-name") public GUIDResponse getMetadataElementGUIDByUniqueName(@PathVariable String serverName, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) NameRequestBody requestBody) Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).- Parameters:
serverName
- name of server instance to route request toforLineage
- the retrieved element is for lineage processing so include archived elementsforDuplicateProcessing
- the retrieved element is for duplicate processing so do not combine results from known duplicates.requestBody
- unique name for the metadata element- Returns:
- metadata element unique identifier (guid) or InvalidParameterException the unique identifier is null or not known or UserNotAuthorizedException the governance action service is not able to access the element or PropertyServerException there is a problem accessing the metadata store
-
getElements
@PostMapping(path="/elements/by-type") public MetadataElementSummariesResponse getElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindProperties requestBody) Retrieve elements of the requested type name.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?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 there is a problem reported in the open metadata server(s)
-
getElementsByPropertyValue
@PostMapping(path="/elements/by-exact-property-value") public MetadataElementSummariesResponse getElementsByPropertyValue(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @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 torequestBody
- properties and optional open metadata type to search onstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findElementsByPropertyValue
@PostMapping(path="/elements/by-property-value-search") public MetadataElementSummariesResponse findElementsByPropertyValue(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @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 torequestBody
- properties and optional open metadata type to search onstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getElementsByClassification
@PostMapping(path="/elements/by-classification/{classificationName}") public MetadataElementSummariesResponse getElementsByClassification(@PathVariable String serverName, @PathVariable String classificationName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindProperties 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 toclassificationName
- name of classificationstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?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 there is a problem reported in the open metadata server(s)
-
getElementsByClassificationWithPropertyValue
@PostMapping(path="/elements/by-classification/{classificationName}/with-exact-property-value") public MetadataElementSummariesResponse getElementsByClassificationWithPropertyValue(@PathVariable String serverName, @PathVariable String classificationName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @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 toclassificationName
- name of classificationrequestBody
- properties and optional open metadata type to search onstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findElementsByClassificationWithPropertyValue
@PostMapping(path="/elements/by-classification/{classificationName}/with-property-value-search") public MetadataElementSummariesResponse findElementsByClassificationWithPropertyValue(@PathVariable String serverName, @PathVariable String classificationName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @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 toclassificationName
- name of classificationrequestBody
- properties and optional open metadata type to search onstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getRelatedElements
@PostMapping(path="/elements/{elementGUID}/by-relationship") public RelatedMetadataElementSummariesResponse getRelatedElements(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindProperties requestBody) Retrieve related elements of any type name.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the starting elementstartingAtEnd
- indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)startFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?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 there is a problem reported in the open metadata server(s)
-
getRelatedElements
@PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}") public RelatedMetadataElementSummariesResponse getRelatedElements(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindProperties requestBody) Retrieve related elements of the requested type name.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the starting elementrelationshipTypeName
- name of relationshipstartingAtEnd
- indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)startFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?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 there is a problem reported in the open metadata server(s)
-
getRelatedElementsWithPropertyValue
@PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}/with-exact-property-value") public RelatedMetadataElementSummariesResponse getRelatedElementsWithPropertyValue(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindPropertyNamesProperties requestBody) Retrieve elements linked via the requested relationship type 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 toelementGUID
- unique identifier of the starting elementrelationshipTypeName
- name of relationshipstartingAtEnd
- 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 onstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findRelatedElementsWithPropertyValue
@PostMapping(path="/elements/{elementGUID}/by-relationship/{relationshipTypeName}/with-property-value-search") public RelatedMetadataElementSummariesResponse findRelatedElementsWithPropertyValue(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startingAtEnd, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @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 toelementGUID
- unique identifier of the starting elementrelationshipTypeName
- name of relationshipstartingAtEnd
- 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 onstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getRelationships
@PostMapping(path="/relationships/{relationshipTypeName}") public MetadataRelationshipSummariesResponse getRelationships(@PathVariable String serverName, @PathVariable String relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindProperties requestBody) Retrieve relationships of the requested relationship type name.- Parameters:
serverName
- name of the server instance to connect torelationshipTypeName
- name of relationshipstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?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 there is 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 relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @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 torelationshipTypeName
- name of relationshiprequestBody
- properties and optional open metadata type to search onstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is 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 relationshipTypeName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @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 torelationshipTypeName
- name of relationshiprequestBody
- properties and optional open metadata type to search onstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
retrieveInstanceForGUID
@PostMapping(path="/guids/{guid}") public ElementHeaderResponse retrieveInstanceForGUID(@PathVariable String serverName, @PathVariable String guid, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeRequestBody 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 toguid
- identifier to use in the lookupforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- Returns:
- list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-