reverseSingleTxnAsync Method @beta

Reverse (undo) the most recent operation to this briefcase in the current session. By default, this method also abandons the locks that were acquired for that operation.

reverseSingleTxnAsync(args?: ReverseTxnArgs): Promise<void>

@note This method will also abandon locks associated with any later, reversed Txns, if they have not already been abandoned. For example, if a call to reverseTxns reverses Txn 2 without abandoning its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated with both Txn 1 and Txn 2.

@note If there are any outstanding uncommitted changes, they are reversed.

@note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via TxnManager.beginMultiTxnOperation. So, even though this method reverses only one operation, multiple Txns may be reversed if they were grouped together when they were made.

@note If there are no reversible operations, this method does nothing and returns Success.

@returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.

Parameter Type Description
args ReverseTxnArgs Optional arguments to control the behavior of the reverse operation, such as whether to retain locks.

Returns - Promise

A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.

Defined in

Last Updated: 22 April, 2026