The variable Web service exposes the following resources:

VariableObject — A collection of VariableObject types containing the following properties:

  • Url [string] — The dynamic API URL of the VariableObject. The Url property uniquely identifies the VariableObject.
  • Type [string] — The type of the VariableObject. The available types are "container" and "variable".
  • Name [string] — The name of the VariableObject.
  • Children [VariableObject []] — An array of VariableObjects representing the children of the current VariableObject. This property is deferred by default. Use the $expand parameter to represent this property inline.

Variable — Inherits VariableObject and adds the following properties:

  • Access [string] — The Access permission of the Variable. The available permissions are "Read", "Write", and "Read/Write".
  • DataType [string] — The data type of the Variable. The variable Web service supports primitive types and arrays of primitive types. For complex data types, use the serialized XML string or JSON string as the value of the Value property.
  • VariableValue [string] — The additional properties of the current Variable. This property is deferred by default. Use the $expand parameter to represent this property inline.

VariableValue — Contains the following additional Variable properties:

  • Url [string] — The dynamic API URL of the corresponding Variable. The Url property uniquely identifies the VariableValue.
  • Access [string] — The Access permission of the Variable. The available permissions are "Read", "Write", and "Read/Write".
  • Quality [int64] — The raw quality bits of the Variable.
  • ErrorStatus [int32] — The error status code of the Variable.
  • DataType [string] — The data type of the Variable. The variable Web service supports primitive types and arrays of primitive types. For complex data types, use the serialized XML string or JSON string as the value of the Value property.
  • Value [string] — The string version of the Value of the Variable.
  • Timestamp [string] — The string representation of the Variable timestamp in Date Time format.
    • JSON — A serialized string representing milliseconds after 1970/1/1 0:0:0, UTC time.
    • XML — A string formatted according to RFC 3339. For example, 2011-05-25T17:04:30

VariableValueGroup — Used to get variable updates and batch read variables, this user-created group contains the following properties:

  • Id [string] — The ID of the group. The Id property uniquely identifies the VariableValueGroup.
  • Timeout [int32] — The number of milliseconds of inactivity that closes the variable connection. The value of this property is -1, representing no timeout, by default.
  • VariableValues [VariableValue []] — The list of VariableValues included in the VariableValueGroup. This property is deferred by default. Use the $expand parameter to represent this property inline.