透過 API 更新、刪除和執行
 |
此主題中的範例假設您已熟悉在 Web 開發環境或應用程式中執行 HTTP POST。
|
下列規則可協助瞭解根據所發出請求類型需要哪些項目。
|
註記
|
範例 URL
|
HTTP 動作
|
內容類型
|
|||
|---|---|---|---|---|---|---|
|
UPDATE
|
更新需要同時指定實體部份
|
http://host/Thingworx/Things/thing_name
|
PUT
|
application/json 或 text/xml
|
||
|
DELETE
|
刪除需要同時指定實體部份
|
http://host/Thingworx/Things/thing_name
|
DELETE
|
n/a
|
||
|
INVOKING SERVICES
|
呼叫服務需要指定包括特定特性的完整 URL
|
http://host/Thingworx/Things/MyThing/Services/myService
|
POST
|
application/json
|
執行 HTTP 請求
執行 HTTP 請求時，請使用 UTF-8 編碼並視需要指定選用的埠值。
 |
建議在生產中或不確定網路健全與否的任何時候使用 HTTPS。
|
處理 HTTP 回應碼
在大多數情況下，預期應取回內容或狀況碼 200，這是正常情況下。若發生錯誤，您會收到一則錯誤訊息。
使用 HTTP 內容
如果您要傳送或接收任何 HTTP 內容 (JSON、XML、HTML (僅用於回應))，請根據您所傳送的 HTTP 內容將請求內容類型標題設定為適當的值。
|
方法
|
|
|---|---|
|
取得
|
擷取一個值。
|
|
PUT
|
寫入一個值，或是建立新物件或內容。
|
|
POST
|
執行一項服務。
|
|
DELETE
|
刪除物件或內容。
|
|
接受標題值
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
|
HTML
|
text/html (或省略接受標題)
|
|
CSV
|
text/csv
|
|
內容類型標題值
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
中繼資料
在 Web 瀏覽器中轉至以下 URL，即可顯示您所建構之任何特定物件、物範本或形式的中繼資料：NameoftheThing/Metadata
|
|
欲查看此資訊，它必須顯示為 JSON。
|
利用您的 REST API 呼叫傳入驗證
建議的最佳作法是使用應用程式金鑰。在 ThingWorx 中產生應用程式金鑰，然後您能夠以 HTTP 標題的形式將其與您的 REST 呼叫一起傳遞。
將標題值取代為您要連接的 ThingWorx 實例的有效應用程式金鑰。
|
標題金鑰
|
標題值範例
|
|---|---|
|
appKey
|
1x9256cf-9fe9-434e-adbe-9772c0c40261
|
ThingWorx REST API 支援其他兩種驗證方法：
• 「基本驗證」可讓您使用使用者與密碼進行驗證。
• 將應用程式金鑰作為 URL 參數傳遞。由於安全性原因，不建議採用此方法，未來將會予以取代。
相關連結