通过 API 更新、删除和执行
 |
本主题中的示例假定您非常熟悉在 web 开发环境或应用程序中执行 HTTP POST。
|
以下规则帮助您了解根据发出请求的类型所需的内容。
|
注解
|
示例 URL
|
HTTP 操作
|
内容类型
|
|||
|---|---|---|---|---|---|---|
|
UPDATE
|
更新还需要指定实体部件
|
http://host/Thingworx/Things/thing_name
|
PUT
|
应用程序/json 或文本 /xml
|
||
|
DELETE
|
删除还需要指定实体部件
|
http://host/Thingworx/Things/thing_name
|
DELETE
|
不适用
|
||
|
正在调用服务
|
调用服务需要指定完整的 URL，包括特定的特征
|
http://host/Thingworx/Things/MyThing/Services/myService
|
POST
|
应用程序/json
|
正在执行 HTTP 请求
执行 HTTP 请求时，请使用 UTF-8 编码并根据需要指定可选端口值。
 |
建议在生产中或网络完整性出现问题时使用 HTTPS。
|
处理 HTTP 响应代码
在大多数情况下，您应预期返回内容或状态代码 200，这是正常的。出现错误时，您将收到一条错误消息。
使用 HTTP 内容
如果您正在发送或接收任何 HTTP 内容 (JSON、XML、HTML (仅限于响应))，请根据您发送的 HTTP 内容将请求内容类型标题设置为适当的值。
|
方法
|
|
|---|---|
|
GET
|
检索一个值。
|
|
PUT
|
写入一个值，或创建新的事物或属性。
|
|
POST
|
执行服务。
|
|
DELETE
|
删除事物或属性。
|
|
接受标题值
|
|
|---|---|
|
JSON
|
应用程序/json
|
|
XML
|
文本/xml
|
|
HTML
|
文本/html (或忽略接受标题)
|
|
CSV
|
文本/csv
|
|
内容类型标题值
|
|
|---|---|
|
JSON
|
应用程序/json
|
|
XML
|
文本/xml
|
元数据
您可以显示您构建的任何特定事物、事物模板或事物形态的元数据，方法是：在 web 浏览器中转至以下 URL：NameoftheThing/Metadata
|
|
要查看此信息，必须显示为 JSON。
|
使用 REST API 调用传入身份验证
建议的最佳做法是使用应用程序密钥。在 ThingWorx 中生成应用程序密钥，然后可以 HTTP 标题形式将其与 REST 调用一起传递。
将“标题值”替换为适用于要连接的 ThingWorx 实例的应用程序密钥。
|
标题密钥
|
标题值示例
|
|---|---|
|
appKey
|
1x9256cf-9fe9-434e-adbe-9772c0c40261
|
ThingWorx REST API 支持两种其他身份验证方法：
• 通过基本身份验证，可使用用户和密码进行身份验证。
• 将应用程序密钥作为 URL 参数进行传递。出于安全原因，不建议使用此方法，未来将弃用该方法。
相关链接