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
|
該当なし
|
||
|
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 コンテンツに基づいて、リクエストの content-type ヘッダーを適切な値に設定します。
|
メソッド
|
|
|---|---|
|
GET
|
値を取得します。
|
|
PUT
|
値を書き込むか、新しい Thing またはプロパティを作成します。
|
|
POST
|
サービスを実行します。
|
|
DELETE
|
Thing またはプロパティを削除します。
|
|
Accept Header の値
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
|
HTML
|
text/html (または Accept Header を省略)
|
|
CSV
|
text/csv
|
|
Content Type Header の値
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
メタデータ
Web ブラウザで NameoftheThing/Metadata という URL にアクセスすることによって、構築する特定の Thing、Thing Template、またはシェイプのメタデータを表示できます。
|
|
この情報を表示するには、JSON として表示する必要があります。
|
REST API 呼び出しで認証を渡す
推奨される最良事例は、アプリケーションキーを使用することです。ThingWorx でアプリケーションキーを生成すると、それは REST コールによって HTTP ヘッダーの形式で渡すことができます。
ヘッダーの値を、接続する ThingWorx インスタンスに対して有効なアプリケーションキーに置き換えます。
|
ヘッダーキー
|
ヘッダーの値の例
|
|---|---|
|
appKey
|
1x9256cf-9fe9-434e-adbe-9772c0c40261
|
ThingWorx REST API は、その他 2 つの認証方法をサポートしています。
• 基本認証では、ユーザーとパスワードを使用して認証できます。
• アプリケーションキーを URL パラメータとして渡します。セキュリティ上の理由からこの方法は推奨されないため、今後は廃止される予定です。
関連リンク