Property Base Types
Property Base Types
The defined base type provides context around the data stored in the property. The following table lists the base types are available for all Thing entities:
 |
For property types not supported by ThingWorx, the property type is considered to be STRING.
|
|
Base Type
|
Description
|
||
|---|---|---|---|
|
BASETYPENAME
|
A valid base type name.
|
||
|
BLOB
|
A binary large object.
|
||
|
BOOLEAN
|
A true or false value.
|
||
|
DASHBOARDNAME
|
The name of a dashboard.
|
||
|
DATASHAPENAME
|
A reference to a data shape in the model. Uses special handling.
|
||
|
DATETIME
|
A formatted date and time. The platform's default (default) value for DATETIME (if a default was not explicitly set in the property definition) is the Unix epoch (1/1/1970) for persisted and non-persisted properties.
|
||
|
GUID
|
Globally unique identifier. The platform’s default (default) value for GUID is the Nil GUID (00000000-0000-0000-0000-000000000000) for persisted and non-persisted properties. When a GUID property is created, a GUID is automatically created if a default value or value is not set by the user. The following behaviors are followed for persistent and non-persistent GUID properties and are also applicable in a federation scenario:
• If the property is set as persistent or not persistent and a default value or value is not set by the user, a new GUID value is generated each time the Thing is initialized. If a system or Thing restarts, a new value is generated.
• If the property is persistent and a default value or value is set by the user, a new value is not generated when a Thing or system restarts.
|
||
|
GROUPNAME
|
A user group name.
|
||
|
HTML
|
HTML content.
|
||
|
HYPERLINK
|
A standard URL (such as www.ptc.com).
|
||
|
IMAGE
|
Binary data that can be rendered as an image.
|
||
|
IMAGELINK
|
A URL link to an image.
|
||
|
INFOTABLE
|
A standard representation of data in ThingWorx that is similar to a SQL result set. There are a number of built-in services for building, consuming, and parsing an infotable.
|
||
|
INTEGER
|
A number that can be written without a fractional component.
|
||
|
JSON
|
A JavaScript Object Notation (JSON) object.
|
||
|
LOCATION
|
Standard World Geodetic System (WGS) 84 coordinate, expressed as [longitude, latitude], elevation.
|
||
|
LONG
|
The LONG type should be used when a required range is longer than what the INTEGER base type provides.
|
||
|
MASHUPNAME
|
A reference to a ThingWorx mashup. Uses special handling.
|
||
|
MENUNAME
|
The name of a menu.
|
||
|
NUMBER(FLOAT)
|
A number.
|
||
|
PASSWORD
|
A masked password value.
|
||
|
QUERY
|
A JSON object that includes an array of filters. Each filter should include value, type, and fieldname.
|
||
|
SCHEDULE
|
A cron-based schedule configured using the Schedule Editor.
|
||
|
STRING
|
Any amount of alphanumeric characters.
|
||
|
TAGS
|
ThingWorx tag values.
|
||
|
TEXT
|
Any amount of alphanumeric characters. The difference with STRING is that TEXT is indexed.
|
||
|
THINGCODE
|
A numerical representation of a Thing containing a Domain ID and Instance ID. For example, 2:1.
|
||
|
THINGNAME
|
A reference to a Thing in the model. Uses special handling.
|
||
|
THINGSHAPENAME
|
A reference to a Thing Shape in the model. Uses special handling.
|
||
|
THINGTEMPLATENAME
|
The name of a Thing Template.
|
||
|
USERNAME
|
A reference to a ThingWorx user.
|
||
|
VEC2
|
A collection of two numbers. For example, 2D coordinates x and y.
|
||
|
VEC3
|
A collection of three numbers. For example, 3D coordinates x, y, and z.
|
||
|
VEC4
|
A collection of four numbers. For example, 4D coordinates x, y, z, and w.
|
||
|
XML
|
An XML snippet or document.
|
|
|
The values entered in the Min Value and Max Value fields are for information only. Actual values less than or greater than the specified values are accepted.
|
Property Base Type Changes in ThingWorx 9.4.0
|
OData Spec
|
Legacy Mapping
|
Latest Mapping
|
||
|---|---|---|---|---|
|
OData datatype
|
ThingWorx Datatype
x-twx-datatype
|
ThingWorx Data Format
|
ThingWorx Datatype
x-twx-datatype
|
ThingWorx Data Format
|
|
Edm. String
|
STRING
|
—
|
STRING
|
—
|
|
Edm.Guid
|
STRING
|
uuid
|
STRING
|
uuid
|
|
Edm.Boolean
|
BOOLEAN
|
—
|
BOOLEAN
|
—
|
|
Edm.Byte
|
STRING
|
byte
|
STRING
|
byte
|
|
Edm.Sbyte
|
INTEGER
|
—
|
INTEGER
|
—
|
|
Edm.lnt
|
INTEGER
|
—
|
INTEGER
|
—
|
|
Edm.lnt32
|
INTEGER
|
—
|
INTEGER
|
—
|
|
Edm.lnt64
|
LONG
|
int64
|
LONG
|
int64
|
|
Edm.Decimal
|
NUMBER
|
—
|
NUMBER
|
—
|
|
Edm.Single
|
NUMBER
|
float
|
NUMBER
|
float
|
|
Edm.Double
|
STRING
|
double
|
NUMBER
|
double
|
|
Edm.Date
|
STRING
|
date
|
DATETIME
|
date
|
|
Edm.DateTime
|
STRING
|
date-time
|
DATETIME
|
date-time
|
|
Edm.DateTimeOffset
|
STRING
|
date-time
|
DATETIME
|
date-time
|
|
Edm.Time
|
STRING
|
date-time
|
DATETIME
|
date-time
|
|
Edm.TimeOfDay
|
STRING
|
date-time
|
DATETIME
|
date-time
|