Conjuntos de propiedades (API)
Para obtener la documentación completa de la API, consulte la referencia de api de plataforma desde la interfaz web. Esta es una sección de destino para demostrar los conjuntos de propiedades de la API de manera similar a la interfaz web.
Los conjuntos de propiedades residen en http://aos-server:8888/api/property-sets y están referenciados por id.
{
"items": [
{
"label": "string",
"values": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"id": "string"
}
]
}
API: crear conjunto de propiedades
Para crear un conjunto de propiedades, POST para https://aos-server/api/property-sets con una estructura JSON válida que representa el conjunto de propiedades. Crear un conjunto de propiedades de esta manera solo permite que esté disponible para la asignación en la interfaz web; no es necesario en este método que la API de REST se asigne a un plano. Consulte la sección Asignar un conjunto de propiedades para obtener más información.
Un POST creará un nuevo conjunto de propiedades. Un PUT sobrescribirá un conjunto de propiedades existente. PUT requiere la DIRECCIÓN URL del conjunto de propiedades. 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"
La respuesta contendrá el ID del conjunto de propiedades recién creado {"id": "73223e81-a451-4e7f-91fb-fb476f4b9fc8"}
API: eliminar conjunto de propiedades
La eliminación de un conjunto de propiedades requiere un HTTP DELETE en la propiedad establecida por URL http://aos-server:8888/api/design/property-sets/{id}
curl -H "AuthToken: EXAMPLE" -X DELETE "http://aos-server:8888/api/design/property-sets/73223e81-a451-4e7f-91fb-fb476f4b9fc8"
Una eliminación correcta tiene una respuesta vacía {}
API: asignar conjunto de propiedades
La asignación de un conjunto de propiedades a un plano requiere un HTTP POST al plano por URL http://aos-server:8888/api/blueprints/{blueprint_ID}/property-sets
{
"id": "73223e81-a451-4e7f-91fb-fb476f4b9fc8"
}
La respuesta contendrá el ID de los conjuntos de propiedades asignados {"id": "73223e81-a451-4e7f-91fb-fb476f4b9fc8"}
Ejemplo de 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"
Respuesta
{"id": "73223e81-a451-4e7f-91fb-fb476f4b9fc8"}
API: conjunto de propiedades sin asignar
La eliminación de un conjunto de propiedades requiere un HTTP DELETE en la propiedad blueprint establecida por URL http://aos-server:8888/api/blueprints/{blueprint_ID}/property-sets{id}
curl "http://aos-server:8888/api/blueprints/e4068e99-813c-4290-b7cc-e145d85a98a8/property-sets/73223e81-a451-4e7f-91fb-fb476f4b9fc8" -X DELETE -H "AuthToken: EXAMPLE"
Una eliminación correcta tiene una respuesta vacía {}