Skip to main content

delete

Used to rollback versions or delete items from the database

Syntax​

delete activevar (log string)?

Description​

In the standard form, it rolls back the version of an item from the database, the activevar item can be one of:

  • action
  • calendar
  • critical (future use)
  • curve
  • dashboard
  • data (curve, timeseries, matrix)
  • dataset (dataset, dataset_feed, dataset_delivery)
  • environment
  • event
  • expiry
  • extractor
  • index
  • object
  • policy
  • process
  • queue
  • reportconfig
  • report
  • script
  • secret
  • subscription
  • task
  • transformer
  • type
  • user
  • workflow

You can specify the version number to delete with the activevar syntax: ${service:"resource":version}

The version can also be *, in which case it will fully delete the item from the database

The optional log option allows you to specify a reason for the deletion which is added to the audit log

Examples​

// To rollback to the previous version
delete ${object:"TEST"}

// To rollback to the previous version, specifying an audit log message 
delete ${script:"Test Script"} log "Removed TEST object"

// To delete a specific version
delete ${object:"TEST":1}

// To delete all versions
delete ${object:"TEST":*}

bulk delete​

Bulk delete can remove multiple records from certain supported services

Syntax​

bulk delete avservice (log string)? (where condition)?

In bulk delete form, the following services are supported for delete and restore, which means once the records are deleted, they can be restored using the bulk restore command.

  • event
  • object
note

Both the current and archived versions of the items are deleted/restored.

The following services can be used to bulk delete only - no restore

  • alertrecord
  • audit
  • automationlog
  • batch
  • dataset_delivery
  • exec
  • queuelog
  • scriptlog

bulk restore​

Bulk restore is used to undo a bulk delete

Syntax​

bulk restore avservice (log string)? (where condition)?

The following services can use the bulk restore command:

  • event
  • object

Examples​


// To delete all object that are of type="MyType"
bulk delete ${object} where _type="MyType" 

// To restore objects of type="MyType"
bulk restore ${object} where _type="MyType" 

// To completely remove audit records prior to 1st June 2025
bulk delete ${audit} where timestamp < "2025-06-01"