Initiate a transaction (POST)

The POST command initiates a new transaction with the system. Initiating a transaction returns a transaction identifier (tid) that you must use for all subsequent transaction operations. To perform this procedure, you must have Operator-level access, or higher.

Command overview

Method — POST
Resource — Transaction

Parameters

Parameter	Description	Example
usr ¹	A valid system user name (case sensitive)	usr=myUsername
pwd ¹	The password that corresponds with the usr (user name) parameter (case sensitive)	pwd=myPassword
tto	The transaction timeout: the period of inactivity (in seconds) after which the system automatically terminates the transaction. It must be an integer between 5 and 300 (inclusive). Default: 30.	tto=30
autoterminate	The parameter specifies how the transaction terminates: true: The transaction automatically terminates after a successful commit. false: You must terminate the transaction manually. Default: false	autoterminate=false

^{1 This parameter is required.}

Sample request

https://10.0.0.1/rest/configurationapi/transactionapi/1.0/transaction?usr=jdoe&pwd=pa55w0rd!&tto=5&autoterminate=true

Sample successful response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<status result="success"></status>
<result>
<tid>643283</tid>
</result>
</response>

Sample unsuccessful response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<status result="failure">
<msg code="XXXXX" severity="ERROR">Execution Failure:
Error when creating transaction. Could not create
transaction configuration.</msg>
</status>
</response>