How can we help?

Searching:

0 results found
backBack

ThingsTemplates/Get (List)

GET /odata/ThingsTemplates

Description

Gets a list of Things templates.

See the following for request and response details ‒

 

Request ‒ ThingsTemplates/Get

Property Type Description Mandatory Template Type
name String The free-text name of the template. Y Product

Group Template
description String The free text description of the Product. Product
icon String A link to the default icon to represent Devices of this Product type. Product
customIdDisplay Boolean The customID of a Device is the Device’s unique identifier in an external system. This enables the correlation of the Axonize Device ID with the external system’s Device ID.

The customIdDisplay specifies whether to show a field in the Axonize Portal that enables the entry of a customer ID when defining each Device of this Product.

Note ‒ customID is a property in the Devices/Post request of the Axonize REST API.

 Product
customIdRequired Boolean True ‒ If it is mandatory to enter the customIdDisplay field when defining a Device of this Product (described above) in the Axonize Portal. Product
serialNumberDisplay Boolean Specifies whether to show a field in the Axonize Portal that enables the entry of a serial number when defining each device of this Product.

serialNumber is a property in the Devices/Post request of the Axonize REST API.

 Product
serialNumberRequired Boolean True ‒ If it is mandatory to enter the serialNumberDisplay field when defining a Device of this Product (described above) in the Axonize Portal. Product
active Boolean Specifies whether the Product is active, meaning that it can be used – True/False. Product
keepAliveThreshold Integer Specifies how long the system waits for a message from a Device (in minutes) of this Product before determining that the Device is disconnected. These Devices are indicated in the Axonize Portal as Disconnected.

-1 ‒ Specifies that the Device should never be indicated in the Axonize Portal as Disconnected.

 Product
defaultVirtualDeviceEvents String This property specifies the virtual device manifest for devices of this Product. This property is only relevant for virtual devices. See Defining a Virtual Device Manifest for more information. Product
disconnectChildDevices Boolean True ‒ If all child Devices are marked as Disconnected in Axonize when the parent Device is determined to be disconnected. For example, for a parent Device, such as a device gateway or panel. Product
connectChildDevices Boolean True ‒ If all child Devices are marked as Connected in Axonize when the parent Device is determined to be disconnected. For example, for a parent Device, such as a device gateway or panel. Product
disconnectGroupDeviceOnAllChildrenDisconnect Boolean Specifies that if all of a Device’s children are disconnected, the Device’s parent is also disconnected. Product
connectGroupDeviceOnAnyChildrenConnect Boolean Specifies that if even one of a Device’s children is disconnected, the Device’s parent is also disconnected. Product
onConnectCommandIds String The list of command IDs to be automatically triggered when Devices of this Product connect to Axonize. Product
manufacturer String The free text manufacturer name of this Device type. Product
commandsProtocol String/Enum The command protocol, as follows –

  • Unidentified
  • HTTP
  • AMQP
  • Modbus
  • SNMP
 Product
commandsAddress String For Internal use. The remote address to where to send commands for this device type. This address acts as a device gateway. Product
autoDiscoveryCommand String Specifies one or more command IDs to be automatically activated on the Device itself, when a Device is created. Product
displayCommandsTab Boolean Specifies that the Axonize Portal shows the Commands tab for Devices of this Product. This tab enables you to automatically activate commands on Devices of this Product. Product
onDeleteCommands Array of Strings Specifies one or more command IDs to be automatically activated on the Device itself, just before a Device of this Product is deleted from the Axonize system. Product
onPatchCommands Array of Strings Specifies one or more command IDs to be automatically activated on the Device itself, just before the data on a Device of this Product is patched by the Axonize system. Product
dispayDeviceSDKDetails Boolean This option is for Axonize Device SDK developers.

True ‒ Specifies that additional information for developers is shown in the Axonize Portal.

 Product
commands Array Defines an array of one or more commands that the Axonize REST API can use for each Device of this Product type. These commands enable you to trigger actions on the device using the sendCommand endpoint.

The Axonize Device SDK should be activated on the device and set up accordingly to listen to this command. Alternatively, Axonize can set up its command gateway that can send commands to devices that are not using the Axonize Device SDK.

After a command is created, Axonize returns a unique identifier (command ID) to be used with the Axonize REST API Command entity in order to send commands to a device.

 Product
commands/name String The free-text name of the command. Product
commands/arguments Array of Strings Defines an array of one or more arguments of a command to be sent to the Device. Product
commands/arguments/name tring The free-text name of the argument. Product
commands/arguments/value String The actual value of the command. This is the value that will affect the device. Product
commands/arguments/serviceProperty Array Defines an array of one or more properties of this Command’s argument.The serviceproperty helps you define the Command’s properties. Product
commands/arguments/serviceProperty/displayName String The free-text name to be displayed for this argument in the Axonize Portal. Product
commands/arguments/serviceProperty/Name String The name of this property of the argument. Product
commands/arguments/serviceProperty/dataType String The data type of this property of the argument. Valid values are –

  • Text
  • Integer
  • Decimal
  • Date
  • Boolean
  • Gps
 Product
commands/arguments/serviceProperty/allowedValueRange String The values allowed to be entered for this argument. You can enter one or more sets of allowed value ranges as described below.

If the data type (dataType described above) of the argument property is Number, then you can enter a minimum and maximum value, as well as set a Step for this value. For example, if the Minimum is 10, the Maximum is 20 and this Step is 2, then the following values can be entered ‒ 10, 12, 14, 16, 18, 20.

 Product
commands/arguments/defaultValue String The default value displayed in the Axonize Portal before you select/enter a value. Product
commands/arguments/unit String The unit of the value (described above). For example, Fahrenheit or Centigrade. Product
commands/arguments/uiType String/Enum The type of user interface controller for this argument, as follows –

  • Button
  • Radio Button
  • TextOneLine
  • TextMultiLine
  • IpV4
  • Number
  • OID
  • Toggl
 Product
commands/payload String The method that is sent to the Device. This is the command that the Device actually gets and executes. For example, to turn on a light or close a lock and so on. Product
commands/commandResponseType String/Enum The device structure returned by the command payload (described above). The values of this property are –

  • Open text string
  • JSON
 Product
events Array An Event/Reading is data received by the Axonize Server from a Device.

This array property enables you to define one or more events that the Device can send to the Axonize server.

Even though the Axonize Dashboard can show events that are not defined here, defining events here provides various customization options.

Defining events here enables you to configure how the values of this event are shown in the Dashboard. For example, the icon or color in which a 0 value is shown in the Dashboard.

The properties that appear below describe a single event.

 Product

Group Template
events/typeCode Integer The code of this event type as defined in the event manifest. See Defining a Device Event Manifest for more information.

The combination of the typeCode property and the name property (described below) represent a unique identifier for an event type.

 Product

Group Template
events/name String A free-text name of this event. This name does not appear in the Event Manifest. Product

Group Template
events/nameResourceKey String This is the unique identifier of this event for translating the event name property (described above). For example, this unique identifier could be used by Axonize’s localization service to translate the name property Temperature into French Température. Product

Group Template
events/valueRange String If the data type is Number, then you can enter a minimum and maximum value, as well as set a Step for this value. For example, if the Minimum is 10, the Maximum is 20 and this Step is 2, then the following values can be entered ‒ 10, 12, 14, 16, 18, 20. Product

Group Template
events/valueRange/allowedValues String/Enum The unique identifier of this event value to be used for converting how this value appears in the Axonize Portal.

If the data type is String, then you can specify the following ‒

  • Key ‒ A unique key is associated with each Value.
  • Value ‒ The value of a Key.
  • iconName ‒ For each value, you can specify the name of the icon to represent this value.

For example, this identifier could be used to convert the value 0 so that it appears as Closed in the Axonize Portal and the value 1 as Open.

 Product

Group Template
events/valueRange/allowedValues/iconName String The name of the icon to represent this event value in the Axonize Portal. Product

Group Template
events/valueRange/allowedValues/iconColor String The color of the icon to represent this event in the Axonize Portal. Product

Group Template
events/unit String The default unit of the event’s value. For example, Fahrenheit or Centigrade. This unit is used for the event when a Device does not specify the unit. Product

Group Template
events/isAccumulated Boolean Specifies whether the value of this event can be accumulated/counted. For example, money.

You may refer to the accumulated property for more information.

 Product

Group Template
events/logicalType String The logical type of this event. Valid values are –

  • Number
  • Text
  • Bool
 Product

Group Template
events/fieldsCount Number Not in use. Product

Group Template
events/precision Number The number of digits that show after the decimal point. Product

Group Template
additionalProperties Array The additionalProperties property enables you to extend the Axonize schema model by adding your own properties for each Device type. For example, you can add a property named Firmware Version that specifies the version of the Device’s firmware. Product

Group Template
additionalProperties/
displayName		 String The name to appear in the Axonize Portal for this additional property. Product

Group Template
additionalProperties/name String The internal logical name to be used for this property. This name must match the additional property’s name on the Device itself. Product

Group Template
additionalProperties/extra String A free-text description of the additional property. Product

Group Template
additionalProperties/
dataType		 String The data type of this property. Valid values are –

  • Number
  • Text
  • Bool
 Product

Group Template
additionalProperties/
allowedValueRange		 String If the data type (dataType described above) is Number, then you can enter a minimum and maximum value, as well as set a Step for this value. For example, if the Minimum is 10, the Maximum is 20 and this Step is 2, then the following values can be entered ‒ 10, 12, 14, 16, 18, 20. Product

Group Template
additionalProperties/allowedValueRange/allowedValues String The unique identifier of this event value to be used for converting how this value appears in the Axonize Portal.

If the data type is String, then you can specify the following ‒

  • Key ‒ A unique key is associated with each Value.
  • Value ‒ The value of a Key.
  • iconName ‒ For each value, you can specify the name of the icon to represent this value.

For example, this identifier could be used to convert the value 0 so that it appears as Closed in the Axonize Portal and the value 1 as Open.

 Product

Group Template
additionalProperties/
defaultValue		 String The default value of the additional property. Product

Group Template
additionalProperties/unit String The default unit of the additional property value. For example, Fahrenheit or Centigrade. Product

Group Template
additionalProperties/uiType String See commands/arguments/uiType. Product

Group Template
additionalProperties/required Boolean True ‒ If this additional property is mandatory. Product

Group Template
mediaSettings Object Specifies the media settings for Devices that stream media. Product
mediaSettings/
mediaProtocol		 String/Enum The type of media streaming protocol, as follows –

  • None
  • RTMP
 Product
mediaSettings/
mediaType		 String/Enum The media type, as follows –

  • Unknown
  • Video
  • Audio
  • Image
 Product
tooltip Array of Tooltip Elements A tooltip displayed in Axonize maps and diagrams when you hover over a device. It shows the device status, which can be an event or property, as described below – Product
tooltip/
type		 String Can be an event or property –

  • event – Is a tooltip showing the device reading value.
  • property – Is a tooltip showing the device property value.
 Product
tooltip/
value		 String If the type (described above) is event, the value contains the Event typeCode–name. The value is connected to two properties of the service event – typeCode and name, and is represented in the following format: typeCode–name. For example, 7-temperature.

If the type is property (described above), the value should be the property name to be displayed in the tooltip.

 Product
commands/arguments Array of Strings Defines an array of one or more arguments of a command to be sent to the Device. To use the com-mand in the UI Product
commands/arguments/name String The free-text name of the argument. To use the com-mand in the UI Product
commands/arguments/value String The actual value of the command. This is the value that will affect the device. Product
commands/arguments/defaultValue String The default value displayed in the Axonize Portal before you select/enter a value. Product
commands/arguments/unit String The unit of the value (described above). For example, Fahrenheit or Centigrade. Product
commands/arguments/uiType String/Enum The type of user interface controller for this argument, as follows –

  • Button
  • Radio Button
  • Slider
  • Select
  • TextOneLine
  • TextMultiLine
  • IpV4
  • Number
  • OID
  • Toggle
 To use the com-mand in the UI Product
thingType Enum 0 For device 1 for Group Product

Group Template

Example JSON ThingsTemplates/Get Request

curl –location –request GET ‘https://api.dev.axonize.com/odata/thingsTemplates/’ \

–header ‘Accept: application/json, text/plain, */*’ \

–header ‘appId: 4eec315a-58b1-4c53-98c9-aff93bec60cd’ \

–header ‘Accept-Encoding: gzip, deflate’