Package enomalism2 :: Package modules :: Package transactioncontrol :: Module rest
[hide private]

Module rest

Defines REST controllers for transaction control.


Requires:

Status: Stable

Functions [hide private]
Dictionary
rest_transaction(self, *args, **kw)
Create a new transaction.
Dictionary
rest_transaction_list(self, *args, **kw)
Return a list of all Enomalism transactions.
Dictionary
rest_tranasaction_UUID(self, *args, **kw)
Perform some action on the specified transaction.
Function Details [hide private]

rest_transaction(self, *args, **kw)

 

Create a new transaction.

URL Format:

   /rest/transaction/
Parameters:
  • self (enomalism2.REST.rest) - The method class.
  • data (String) - The data attribute of the transaction.
  • target (String) - The target attribute of the transaction.
  • message (String) - The message attribute of the transaction.
  • completion (Integer) - The completion attribute of the transaction.
  • lock (String) - The lock attribute of the transaction.
Returns: Dictionary
A dictionary containing the result of the action.
Decorators:
  • @register_extension("transaction", allowed_methods= ['PUT'])
Raises:
  • None - No exceptions are raised by this method.

Status: Stable

rest_transaction_list(self, *args, **kw)

 

Return a list of all Enomalism transactions.

URL Format:

   /rest/transaction/list/
Parameters:
Returns: Dictionary
A dictionary containing the result of the action.
Decorators:
  • @register_extension("transaction/list", allowed_methods= ['GET'])
Raises:
  • None - No exceptions are raised by this method.

rest_tranasaction_UUID(self, *args, **kw)

 

Perform some action on the specified transaction. GET will retrieve the transaction. DELETE will delete the transaction. POST will update the transaction using the given keyword parameters.

URL Format:

   /rest/transaction/<UUID>/
Parameters:
  • self (enomalism2.REST.rest) - The method class.
  • data (String) - The transaction data attribute.
  • target (String) - The transaction target attribute.
  • message (String) - The transaction message attribute.
  • completion (Integer) - The transaction completion attribute.
  • lock (String) - The transaction lock attribute.
Returns: Dictionary
A dictionary containing the result of the action.
Decorators:
  • @register_extension("transaction/*", allowed_methods= ['GET', 'POST', 'DELETE'])
Raises:
  • None - No exceptions are raised by this method.

Status: Stable