ThingWorx REST Design
|
Term
|
Description
|
Optional
|
|---|---|---|
|
http action
|
GET, PUT, DELETE, POST
|
|
|
scheme
|
http, https
|
|
|
host
|
Machine name where ThingWorx is running
|
|
|
port
|
Port that the Web Server is listening for requests on
|
yes
|
|
entity collection
|
One of the built-in entity collection types. See table below.
|
|
|
entity
|
Name that identifies a specific characteristic
|
|
|
characteristic collection
|
Names such as PropertyDefinition, PropertiesVTQ, ThingName, and ServiceDefinition. See table below.
|
|
|
characteristic
|
||
|
accept header
|
Format of HTTP content being requested; must be application/json, text/xml, text/ html, or text/csv
|
yes
|
|
content type header
|
Format of HTTP content being provided; must be application/json, text/csv, text/
|
required
|
|
content
|
yes
|
|
|
query parameters
|
yes
|
Built—in Collection Values
ThingWorx has a finite list of entity collections. Each entity collection contains entities (for example, Things) of the respective type (for example, /Users contains all users).
Entity Collection Types
|
Entity Type
|
URL
|
||
|---|---|---|---|
|
Application Keys
|
/Thingworx/ApplicationKeys
|
||
|
Authenticators
|
/Thingworx/Authenticators
|
||
|
Dashboards
|
/Thingworx/Dashboards
|
||
|
Data Shapes
|
/Thingworx/DataShapes
|
||
|
Data Tags
|
/Thingworx/DataTags
|
||
|
Directory Services
|
/Thingworx/DirectoryServices
|
||
|
Localization Tables
|
/Thingworx/LocalizationTables
|
||
|
Logs
|
/Thingworx/Logs
|
||
|
Mashups
|
/Thingworx/Mashups
|
||
|
Menus
|
/Thingworx/Menus
|
||
|
Media
|
/Thingworx/MediaEntities
|
||
|
Model Tags
|
/Thingworx/ModelTags
|
||
|
Networks
|
/Thingworx/Networks
|
||
|
Notification Contents
|
/Thingworx/NotificationContents
|
||
|
Notification Definitions
|
/Thingworx/NotificationDefinitions
|
||
|
Organizations
|
/Thingworx/Organizations
|
||
|
Persistence Providers
|
/Thingworx/PersistenceProviders
|
||
|
Projects
|
/Thingworx/Projects
|
||
|
Resources
|
/Thingworx/Resources
|
||
|
Style Definitions
|
/Thingworx/StyleDefinitions
|
||
|
Style Themes
|
/Thingworx/StyleThemes
|
||
|
State Definitions
|
/Thingworx/StateDefinitions
|
||
|
Subsystems
|
/Thingworx/Subsystems
|
||
|
Things
|
/Thingworx/Things
|
||
|
Thing Groups
|
/Thingworx/ThingGroups
|
||
|
Thing Shapes
|
/Thingworx/ThingShapes
|
||
|
Thing Templates
|
/Thingworx/ThingTemplates
|
||
|
Users
|
/Thingworx/Users
|
||
|
User Groups
|
/Thingworx/Groups
|
Characteristic Collection
|
Characteristic Type
|
URL
|
|---|---|
|
Properties
|
/Thingworx/Things/ThingName/Properties
|
|
Property Definition
|
/Thingworx/Things/ThingName/PropertyDefinitions
|
|
PropertiesVTQ (ValueTimeQuality)
|
/Thingworx/Things/ThingName/PropertiesVTQ
|
|
Thing Name
|
/Thingworx/Things/ThingName
|
|
Service Definition
|
/Thingworx/Things/ThingName/ServiceDefinitions
|
Related Links