Skip to main content

Introduction

APIs and Models to manage your Enterprise Variables

API​

Here are the list of APIs existing under Enterprise Variables category.

APIDescription
CreateVariableAsyncThe API creates a new Enterprise Variable with provided details inside the connected Control Room.
DeleteVariableAsyncDeletes the specified Enterprise Variable from the connected Control Room.
GetAllEVariablesAsyncGets the list of all Enterprise Variables from the connected Control Room.
GetVariableByIdAsyncGets the specified Enterprise Variable from the connected Control Room.
GetVariableValueRetrieves the value of the specified Enterprise Variable from the connected Control Room.
UpdateVariableAsyncUpdates the specified Enterprise Variable details inside the connected Control Room.

Models​

Here are list of Models used in Enterprise Variables APIs.

ModelsDescription
EnterpriseVariableThe structure represents an instance of the EnterpriseVariable entity.
NewVariableThe structure represents an instance of the New Enterprise Variable entity.
VariableScopesThe VariableScopes object enumeration.
VariableTypesThe VariableTypes object enumeration.