Poll Transactions
-----------------


It is recommended to use asynchronous transaction call back mechanism described in 
"Asynchronous Mutator Transaction Status Callback".  If this can however not be used a consumer 
of the |VOSS Automate| API can also use this polling mechanism to poll the status of individual transactions 
using the poll action of the transaction tool.  A user interface that allows a user to monitor the 
progress of a given transaction can use the following method to retrieve the status of a given transaction:

::

   GET /api/tool/Transaction/[pkid]/poll/?format=json

The response contains essential status of the transaction, for example:

::

    {
        [pkid]: {
            status: "Success",
            href: "/api/tool/Transaction/[pkid]",
            description: "Name:RDP-auser1857 Description:RD for auser1857"
        }
    }


.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM