listTransactions

The service returns a list of transactions from the transaction store that match the filter criteria. Regular expressions are supported to allow flexible filter criteria.

Input parameters
endDate
Optional. The last creation date of the transaction.
startDate
Optional. The earliest creation date of the transaction.
sender
Optional. The name of the sender of the transaction.
receiver
Optional. The name of the receiver of the transaction.
msgType
Optional. The name of the message type of the transaction.
state
Optional. The state of the transaction.
$tid
Optional. The TID of the transaction.
$sortKey
Optional. Specifies the sort key. The valid values for the parameter are:
  • noSort. Default.
  • $tid
  • sender
  • receiver
  • msgType
  • date
  • state
The resulting transaction list is sorted by the attribute.
$dir
Optional. Specifies the sort direction.
  • descending. Triggers a descending order.
  • Any value other than descending. Triggers ascending sort order.
Return values
transactions
Optional. A document list that contains one document with detail information for each transaction. The following keys are always included:
  • $tid
  • sender
  • receiver
  • msgType
  • date. Date/time, when the state of transactions was last changed, formatted in the usual Log Timestamp Format.
  • state
$sortKey
Optional. Specifies the sort key. Valid values are:
  • noSort. Default.
  • $tid
  • sender
  • receiver
  • msgType
  • date
  • state
The resulting transaction list is sorted by the attribute.
$dir
Optional. Specifies the sort direction.
  • descending. Triggers a descending order.
  • Any value other than descending.
Triggers ascending sort order.