Use this API to keep control over a transaction throughout the process of site modification. Control over the transaction is extended by 30 seconds every time when one of the following operations is sent:

Create/delete site

Add/replace/delete devices from site

Send heartbeat call

If none of the above calls are made after 30 seconds, the transaction would be in the unlocked state. In the unlocked state, if another user opens a new transaction, your transaction would be discarded, and the new user will have control over modifying the site.

Resource Information

Method

URL

Required authentication

POST

/V1/CMDB/Sites/Transactions/Heartbeat

Yes

Parameters

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

Response

Parameter

Type

Description

Example

statusCode

integer

The returned status code of executing the API.

{
  "statusCode"790200,
  "statusDescription""success"
}

statusDescription

string

The explanation of the status code.