The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
To list transactions on the system use the following operation
GET https://<server_address>/api/tool/Transaction/
?hierarchy=[hierarchy]
&format=json
&summary=true
The following query parameter illustrates how a second page of 50 transactions in the transaction log is requested.
skip=50
&limit=50
&hierarchy=[hierarchy]
&format=json
&summary=true
&direction=desc
&order_by=submitted_time
For further information on the query parameters refer to API Parameters above.
The status of a specific transaction can be retrieved by using a GET call to /tool/Transaction for a specific transaction PKID. The PKID, also known as the transaction ID, or transaction_id is available in the synchronous response to an asynchronous mutator transaction.
For example, if the transaction_id in the response is [pkid], then the transaction can be polled with:
GET https://<server_address>/api/tool/Transaction/[pkid]
It is recommended to use asynchronous transaction call back mechanism described in “Asynchronous Mutator Transaction Status Callback”. If this can not be used, a consumer of the Cisco Unified Communications Domain Manager 10.6(x) 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" } }
Transactions that have failed can, under certain circumstances, be replayed. This means that the transaction is re-submitted with the original request parameters. This is done by specifying the PKID of the transaction
GET https://<server_address>/api/tool/Transaction/[pkid]/replay/
The transaction current operation replays the transaction and the result returns the list view of the transaction log.
Transactions can be edited and then replayed under certain circumstances. This means that the transaction is re-submitted with the updated request parameters. This is done by specifying the PKID of the transaction:
GET https://<server_address>/api/tool/Transaction/[pkid]/edit-replay/
The transaction current operation edit and then replays the transaction and the result returns the list view of the transaction log.
The sub-transactions of a transaction with PKID can be retrieved by submitting the following URI
GET https://<server_address>/api/tool/Transaction/[pkid]/sub_transaction/
The log messages of a transaction with PKID can be retrieved by submitting the following URI
GET https://<server_address>/api/tool/Transaction/[pkid]/log/