Class ClassificationManagerRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.classificationmanager.server.ClassificationManagerRESTServices
The ClassificationManagerRESTServices provides the implementation of the Classification ManagerOpen Metadata View Service (OMVS).
This interface provides view interfaces for infrastructure and ops users.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddGovernanceExpectations(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the governance expectations classification to an element.addGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the governance measurements for an element.addMoreInformationToElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody) Link a resource to an element using the MoreInformation relationship.addOrigin(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the DigitalResourceOrigin classification for an element.addOwnership(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the ownership classification for an element.addResourceListToElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody) Link a resource to an element using the ResourceList relationship.addScopeToElement(String serverName, String urlMarker, String elementGUID, String scopeGUID, NewRelationshipRequestBody requestBody) Link a scope to an element using the ScopedBy relationship.addSearchKeywordToElement(String serverName, String urlMarker, String elementGUID, NewAttachmentRequestBody requestBody) Adds a search keyword to the element.addSecurityTags(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the security tags for an element.addZoneMembership(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the zone membership classification for an element.assignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, NewRelationshipRequestBody requestBody) Assign an action to a new actor.clearConfidenceClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the confidence classification from the element.clearConfidentialityClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the confidence classification from the element.clearConsolidatedDuplicateClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the ConsolidatedDuplicate classification from the element.clearCriticalityClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the criticality classification from the element.clearGovernanceExpectations(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the governance expectations classification from an element.clearGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the governance measurements classification from an element.clearImpactClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the impact classification from the element.clearKnownDuplicateClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the KnownDuplicate classification from the element.clearOrigin(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the DigitalResourceOrigin classification from an element.clearOwnership(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the ownership classification from an element.clearRetentionClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the retention classification from the element.clearSecurityTags(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the security tags classification from an element.clearSemanticAssignment(String serverName, String urlMarker, String elementGUID, String glossaryTermGUID, DeleteRelationshipRequestBody requestBody) Remove a semantic assignment relationship between an element and its glossary term.clearZoneMembership(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the zone membership classification from an element.linkConsolidatedDuplicateToSourceElement(String serverName, String urlMarker, String elementGUID, String sourceElementGUID, NewRelationshipRequestBody requestBody) Create a ConsolidatedDuplicateLink relationship between an element and one of the source elements of its properties.linkElementsAsPeerDuplicates(String serverName, String urlMarker, String elementGUID, String peerDuplicateGUID, NewRelationshipRequestBody requestBody) Create a relationship between two elements that show they represent the same "thing".reassignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, UpdateRelationshipRequestBody requestBody) Assign an action to a new actor.removeMoreInformationFromElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, DeleteRelationshipRequestBody requestBody) Remove the MoreInformation relationship between a resource and an element.removeResourceListFromElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, DeleteRelationshipRequestBody requestBody) Remove the ResourceList relationship between a resource and an element.removeScopeFromElement(String serverName, String urlMarker, String elementGUID, String scopeGUID, DeleteRelationshipRequestBody requestBody) Remove the ScopedBy relationship between a scope and an element.removeSearchKeywordFromElement(String serverName, String urlMarker, String searchKeywordGUID, DeleteElementRequestBody requestBody) Removes a search keyword added to the element by this user.setConfidenceClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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 urlMarker, String elementGUID, NewClassificationRequestBody 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.setConsolidatedDuplicateClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Classify/reclassify the element with the ConsolidatedDuplicate classification.setCriticalityClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization.setImpactClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Classify/reclassify the element (typically a context event, to do or incident report) to indicate the level of impact that the event is expected to have on the organization The level of impact is expressed by the levelIdentifier property.setKnownDuplicateClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Classify/reclassify the element with the KnownDuplicate classificationsetRetentionClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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 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).unassignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, DeleteRelationshipRequestBody requestBody) Remove an action from an actor.unlinkConsolidatedDuplicateFromSourceElement(String serverName, String urlMarker, String elementGUID, String sourceElementGUID, DeleteRelationshipRequestBody requestBody) Remove a ConsolidatedDuplicateLink relationship between an element and one of its source elements.unlinkElementsAsPeerDuplicates(String serverName, String urlMarker, String elementGUID, String peerDuplicateGUID, DeleteRelationshipRequestBody requestBody) Remove the PeerDuplicateLink relationship between an element and its duplicate.updateGovernanceExpectations(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody) Update the governance expectations classification to an element.updateGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody) Update the governance measurements for an element.updateSearchKeyword(String serverName, String urlMarker, String searchKeywordGUID, UpdateElementRequestBody requestBody) Update an existing search keyword.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
Constructor Details
-
ClassificationManagerRESTServices
public ClassificationManagerRESTServices()Default constructor
-
-
Method Details
-
setImpactClassification
public VoidResponse setImpactClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Classify/reclassify the element (typically a context event, to do or incident report) to indicate the level of impact that the event is expected to have on the organization The level of impact is expressed by the levelIdentifier property.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to classifyrequestBody- 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
-
clearImpactClassification
public VoidResponse clearImpactClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the impact classification from the element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to declassifyrequestBody- 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
-
setConfidenceClassification
public VoidResponse setConfidenceClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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 tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to classifyrequestBody- 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
public VoidResponse clearConfidenceClassification(String serverName, String urlMarker, String elementGUID, 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 tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to declassifyrequestBody- 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
public VoidResponse setCriticalityClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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 tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to classifyrequestBody- 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
public VoidResponse clearCriticalityClassification(String serverName, String urlMarker, String elementGUID, 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 tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to declassifyrequestBody- 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
public VoidResponse setConfidentialityClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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 tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to classifyrequestBody- 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
public VoidResponse clearConfidentialityClassification(String serverName, String urlMarker, String elementGUID, 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 tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to declassifyrequestBody- 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
public VoidResponse setRetentionClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody 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 tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to classifyrequestBody- 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
public VoidResponse clearRetentionClassification(String serverName, String urlMarker, String elementGUID, 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 tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to declassifyrequestBody- 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
-
addGovernanceExpectations
public VoidResponse addGovernanceExpectations(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the governance expectations classification to an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of element to attach torequestBody- 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
-
updateGovernanceExpectations
public VoidResponse updateGovernanceExpectations(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody) Update the governance expectations classification to an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of element to attach torequestBody- 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
-
clearGovernanceExpectations
public VoidResponse clearGovernanceExpectations(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the governance expectations classification from an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of elementrequestBody- 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
-
addGovernanceMeasurements
public VoidResponse addGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the governance measurements for an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of element to attach torequestBody- 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
-
updateGovernanceMeasurements
public VoidResponse updateGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, UpdateClassificationRequestBody requestBody) Update the governance measurements for an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of element to attach torequestBody- 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
-
clearGovernanceMeasurements
public VoidResponse clearGovernanceMeasurements(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the governance measurements classification from an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of elementrequestBody- 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
public VoidResponse addSecurityTags(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the security tags for an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of element to attach torequestBody- 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
public VoidResponse clearSecurityTags(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the security tags classification from an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of elementrequestBody- 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
-
addOwnership
public VoidResponse addOwnership(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the ownership classification for an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- element to link it to - its type must inherit from Referenceable.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
public VoidResponse clearOwnership(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the ownership classification from an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- element where the classification needs to be cleared from.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
-
addOrigin
public VoidResponse addOrigin(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the DigitalResourceOrigin classification for an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- element to link it to - its type must inherit from Referenceable.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
-
clearOrigin
public VoidResponse clearOrigin(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the DigitalResourceOrigin classification from an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- element where the classification needs to be cleared from.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
-
addZoneMembership
public VoidResponse addZoneMembership(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Add the zone membership classification for an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- element to link it to - its type must inherit from Referenceable.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
-
clearZoneMembership
public VoidResponse clearZoneMembership(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the zone membership classification from an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- element where the classification needs to be cleared from.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
public 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). 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 tourlMarker- view service URL markerelementGUID- unique identifier of the element that is being assigned to the glossary termglossaryTermGUID- unique identifier of the glossary term that provides the meaningrequestBody- 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
public VoidResponse clearSemanticAssignment(String serverName, String urlMarker, String elementGUID, String glossaryTermGUID, DeleteRelationshipRequestBody requestBody) Remove a semantic assignment relationship between an element and its glossary term.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the element that is being assigned to the glossary termglossaryTermGUID- unique identifier of the glossary term that provides the meaningrequestBody- 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
-
addScopeToElement
public VoidResponse addScopeToElement(String serverName, String urlMarker, String elementGUID, String scopeGUID, NewRelationshipRequestBody requestBody) Link a scope to an element using the ScopedBy relationship.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to linkscopeGUID- identifier of the scope to linkrequestBody- 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
-
removeScopeFromElement
public VoidResponse removeScopeFromElement(String serverName, String urlMarker, String elementGUID, String scopeGUID, DeleteRelationshipRequestBody requestBody) Remove the ScopedBy relationship between a scope and an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to updatescopeGUID- identifier of the scope to linkrequestBody- 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
-
assignAction
public VoidResponse assignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, NewRelationshipRequestBody requestBody) Assign an action to a new actor.- Parameters:
serverName- name of the server instances for this requesturlMarker- view service URL markeractionGUID- unique identifier of the to doactorGUID- actor to assign the action torequestBody- null request body- Returns:
- void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call
-
reassignAction
public VoidResponse reassignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, UpdateRelationshipRequestBody requestBody) Assign an action to a new actor.- Parameters:
serverName- name of the server instances for this requesturlMarker- view service URL markeractionGUID- unique identifier of the to doactorGUID- actor to assign the action torequestBody- null request body- Returns:
- void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call
-
unassignAction
public VoidResponse unassignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, DeleteRelationshipRequestBody requestBody) Remove an action from an actor.- Parameters:
serverName- name of the server instances for this requesturlMarker- view service URL markeractionGUID- unique identifier of the to doactorGUID- actor to assign the action torequestBody- null request body- Returns:
- void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call
-
addResourceListToElement
public VoidResponse addResourceListToElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody) Link a resource to an element using the ResourceList relationship.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to linkresourceGUID- identifier of the resource to linkrequestBody- 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
-
removeResourceListFromElement
public VoidResponse removeResourceListFromElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, DeleteRelationshipRequestBody requestBody) Remove the ResourceList relationship between a resource and an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to updateresourceGUID- identifier of the resource to linkrequestBody- 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
-
addMoreInformationToElement
public VoidResponse addMoreInformationToElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody) Link a resource to an element using the MoreInformation relationship.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to linkresourceGUID- identifier of the resource to linkrequestBody- 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
-
removeMoreInformationFromElement
public VoidResponse removeMoreInformationFromElement(String serverName, String urlMarker, String elementGUID, String resourceGUID, DeleteRelationshipRequestBody requestBody) Remove the MoreInformation relationship between a resource and an element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to updateresourceGUID- identifier of the resource to linkrequestBody- 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
-
addSearchKeywordToElement
public GUIDResponse addSearchKeywordToElement(String serverName, String urlMarker, String elementGUID, NewAttachmentRequestBody requestBody) Adds a search keyword to the element.- Parameters:
serverName- name of the server instances for this requesturlMarker- view service URL markerelementGUID- String - unique id for the element.requestBody- containing type of search keyword enum and the text of the search keyword.- 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
public VoidResponse updateSearchKeyword(String serverName, String urlMarker, String searchKeywordGUID, UpdateElementRequestBody requestBody) Update an existing search keyword.- Parameters:
serverName- name of the server instances for this request.urlMarker- view service URL markersearchKeywordGUID- unique identifier for the search keyword to change.requestBody- containing type of search keyword enum and the text of the search keyword.- 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
public VoidResponse removeSearchKeywordFromElement(String serverName, String urlMarker, String searchKeywordGUID, DeleteElementRequestBody requestBody) Removes a search keyword added to the element by this user.- Parameters:
serverName- name of the server instances for this requesturlMarker- view service URL markersearchKeywordGUID- String - unique id for the search keyword objectrequestBody- optional effective time- Returns:
- void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
setKnownDuplicateClassification
public VoidResponse setKnownDuplicateClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Classify/reclassify the element with the KnownDuplicate classification- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to classifyrequestBody- 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
-
clearKnownDuplicateClassification
public VoidResponse clearKnownDuplicateClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the KnownDuplicate classification from the element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to declassifyrequestBody- 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
-
linkElementsAsPeerDuplicates
public 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". If the relationship already exists, the properties are updated.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to linkpeerDuplicateGUID- identifier of the duplicate to linkrequestBody- 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
-
unlinkElementsAsPeerDuplicates
public VoidResponse unlinkElementsAsPeerDuplicates(String serverName, String urlMarker, String elementGUID, String peerDuplicateGUID, DeleteRelationshipRequestBody requestBody) Remove the PeerDuplicateLink relationship between an element and its duplicate.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to updatepeerDuplicateGUID- identifier of the duplicate to linkrequestBody- 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
-
setConsolidatedDuplicateClassification
public VoidResponse setConsolidatedDuplicateClassification(String serverName, String urlMarker, String elementGUID, NewClassificationRequestBody requestBody) Classify/reclassify the element with the ConsolidatedDuplicate classification.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to classifyrequestBody- 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
-
clearConsolidatedDuplicateClassification
public VoidResponse clearConsolidatedDuplicateClassification(String serverName, String urlMarker, String elementGUID, DeleteClassificationRequestBody requestBody) Remove the ConsolidatedDuplicate classification from the element.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the metadata element to declassifyrequestBody- 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
-
linkConsolidatedDuplicateToSourceElement
public VoidResponse linkConsolidatedDuplicateToSourceElement(String serverName, String urlMarker, String elementGUID, String sourceElementGUID, NewRelationshipRequestBody requestBody) Create a ConsolidatedDuplicateLink relationship between an element and one of the source elements of its properties.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the element that was created with the values from a number of duplicate elementssourceElementGUID- unique identifier of one of the source elementsrequestBody- 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
-
unlinkConsolidatedDuplicateFromSourceElement
public VoidResponse unlinkConsolidatedDuplicateFromSourceElement(String serverName, String urlMarker, String elementGUID, String sourceElementGUID, DeleteRelationshipRequestBody requestBody) Remove a ConsolidatedDuplicateLink relationship between an element and one of its source elements.- Parameters:
serverName- name of the server instance to connect tourlMarker- view service URL markerelementGUID- unique identifier of the element that was created with the values from a number of duplicate elementssourceElementGUID- unique identifier of one of the source elementsrequestBody- 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
-