From 45a62dc8d89933c856f16a76ea8496eabd40b7bf Mon Sep 17 00:00:00 2001 From: Pliable Pixels Date: Sat, 23 Jul 2016 08:03:15 -0400 Subject: [PATCH] Added example of configs API edit --- docs/api.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index 9546a279a..dc60c9203 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -272,7 +272,17 @@ This returns the full list of configuration parameters: Each configuration parameter has an Id, Name, Value and other fields. Chances are you are likely only going to focus on these 3. -(Example of changing config TBD) +The edit function of the Configs API is a little quirky at the Moment. Its format deviates from the usual edit flow of other APIs. This will be fixed, eventually. For now, to change the "Value" of ZM_X10_HOUSE_CODE from A to B: + +:: + + curl -XPUT http://server/zm/api/configs/edit/ZM_X10_HOUSE_CODE.json -d "Config[Value]=B" + +To validate changes have been made: + +:: + + curl -XGET http://server/zm/api/configs/view/ZM_X10_HOUSE_CODE.json Run State Apis ^^^^^^^^^^^^^^^