system.historian.deleteAnnotations

This function is used in Python Scripting.

Description

Deletes desired annotations from the specified historian.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.historian.deleteAnnotations(paths, storageIds)

Parameters

Type	Parameter	Description
List	paths	A list of historical paths associated with the annotations. See Path Syntax for more information on recommended syntax.
List	storageIds	A list of annotation storage IDs to be used for deleting.

Returns

List - A list of QualityCode objects. The quality code will indicate success or failure, and if successful, the storage ID of the annotation will have been deleted.

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Code Snippet

# Delete a previously stored annotation and log an info level formatted message.   

paths = ["histprov:MySQL:/sys:gw1:/prov:default:/tag:history_200"]
storageIds = ["1f001108-5689-4b2a-b995d360250a"]
result = system.historian.deleteAnnotations(paths, storageIds)

system.util.getLogger('HistorianTest: deleteAnnotations').info(str(result))