プロパティセット(API)
完全なAPIドキュメントについては、WebインターフェイスからPlatform APIリファレンスを参照してください。これは、Web インターフェイスと同様にプロパティ セット API を示す対象セクションです。
プロパティ セットは http://aos-server:8888/api/property-sets に存在し、ID によって参照されます。
{
"items": [
{
"label": "string",
"values": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"id": "string"
}
]
}
API - プロパティセットの作成
プロパティセットを作成するには、プロパティセットを表す有効なJSON構造体を使用して https://aos-server/api/property-sets にPOSTします。この方法でプロパティ セットを作成すると、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}/property-sets によるブループリントへの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-sets{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が成功した場合、応答は空です {}