ThingWorx REST API > ThingWorx REST Design
  
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
* 
The entity types listed below is only a partial list of the available entity types.
Entity Type
URL
Logs
/Thingworx/Logs
Users
/Thingworx/Users
Dashboards
/Thingworx/Dashboards
Groups
/Thingworx/Groups
Mashups
/Thingworx/Mashups
Menus
/Thingworx/Menus
Model Tags
/Thingworx/ModelTags
Networks
/Thingworx/Networks
Data Tags
/Thingworx/DataTags
Data Shapes
/Thingworx/DataShapes
Thing Shapes
/Thingworx/ThingShapes
Thing Templates
/Thingworx/ThingTemplates
Things
/Thingworx/Things
Resources
/Thingworx/Resources
Characteristic Collection
* 
The characteristic collection types listed below is only a partial list of the available characteristic collection types.
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
ThingWorx REST API
Updating, Deleting, and Executing Through the API
Updating the Request Method and Content Type Filtering for CSRF Protection