プロパティセット(API)
APIの完全なドキュメントについては、WebインターフェイスからのプラットフォームAPIリファレンスを参照してください。これは、Web インターフェイスと同様にプロパティ セット API を示すターゲット セクションです。
プロパティ セットは http://aos-server:8888/api/property-sets で使用され、ID によって参照されます。
{ "items": [ { "label": "string", "values": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "id": "string" } ] }
API - プロパティ セットの作成
プロパティ セットを作成するには、POST を プロパティ セットを表す有効な JSON 構造で https://aos-server/api/property-sets します。この方法でプロパティセットを作成するだけで、Webインターフェイスでのアサイン設定に使用できます。REST APIがブループリントに割り当てるためには、このメソッドでは必要ありません。詳細については、「プロパティ セットの割り当て」セクションを参照してください。
POST を使用すると、新しいプロパティ セットが作成されます。PUT は既存のプロパティ セットを上書きします。PUT には、プロパティ セットの URL が必要です。 https://aos-server:8888/api/design/property-sets/{id}
curl -H "AuthToken: EXAMPLE" -d '{"values": {"NTP_SRV1": "192.168.1.1", "NTP_SRV1": "192.168.1.1"}, "label": "NTP-servers"}' -X POST "http://aos-server:8888/api/design/property-sets"
応答には、新しく作成されたプロパティ セットの ID が含まれます。 {"id": "73223e81-a451-4e7f-91fb-fb476f4b9fc8"}
API - プロパティ セットの削除
プロパティ セットを削除するには、URL http://aos-server:8888/api/design/property-sets/{id} によって設定されたプロパティに対する HTTP DELETE が必要です。
curl -H "AuthToken: EXAMPLE" -X DELETE "http://aos-server:8888/api/design/property-sets/73223e81-a451-4e7f-91fb-fb476f4b9fc8"
DELETE が成功すると、応答が空になります。 {}
API - プロパティ セットの割り当て
プロパティ セットをブループリントに割り当てるには、URL http://aos-server:8888/api/blueprints/{blueprint_ID}/プロパティセットによるブループリントへの HTTP POST が必要です。
{ "id": "73223e81-a451-4e7f-91fb-fb476f4b9fc8" }
応答には、割り当てられたプロパティ セットの ID が含まれます。 {"id": "73223e81-a451-4e7f-91fb-fb476f4b9fc8"}
CURLの例 - API HTTP PUT
curl "http://aos-server:8888/api/blueprints/e4068e99-813c-4290-b7cc-e145d85a98a8/property-sets/73223e81-a451-4e7f-91fb-fb476f4b9fc8" -X DELETE -H "AuthToken: EXAMPLE"
応答
{"id": "73223e81-a451-4e7f-91fb-fb476f4b9fc8"}
API - プロパティ セットの割り当て解除
プロパティ セットを削除するには、URL http://aos-server:8888/api/blueprints/{blueprint_ID}/property-set{id} によって設定されたブループリント プロパティへの HTTP DELETE が必要です。
curl "http://aos-server:8888/api/blueprints/e4068e99-813c-4290-b7cc-e145d85a98a8/property-sets/73223e81-a451-4e7f-91fb-fb476f4b9fc8" -X DELETE -H "AuthToken: EXAMPLE"
DELETE が成功すると、応答が空になります。 {}