ZaneYork
/
zoneminder
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added example of configs API edit

This commit is contained in:
Pliable Pixels 2016-07-23 08:03:15 -04:00
parent 59cc952cef
commit 45a62dc8d8
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api.rst
View File

@ -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. 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 Run State Apis
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^