tyler.durden
/
pandorafms
mirror of https://github.com/pandorafms/pandorafms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation improvements 

Former-commit-id: ad2155056dd26014f169e277eec2ac7cd463ea3a
This commit is contained in:
Alejandro Gallardo Escobar 2019-02-19 14:51:40 +01:00
parent 39a60639fb
commit 68afc9289d
1 changed files with 25 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
pandora_console/include/functions_api.php
View File

@ -6175,17 +6175,29 @@ function api_set_planned_downtimes_deleted($id, $thrash1, $thrash2, $returnType)
/** /**
* Create a new planned downtime. * Create a new planned downtime.
* e.g.: api.php?op=set&op2=planned_downtimes_created&id=pepito&other=testing|08-22-2015|08-31-2015|0|1|1|1|1|1|1|1|17:06:00|19:06:00|1|31|quiet|periodically|weekly&other_mode=url_encode_separator_|
* *
* @param $id name of planned downtime. * @param $id name of planned downtime.
* @param $thrash1 Don't use. * @param $thrash1 Don't use.
* @param array $other it's array, $other as param is <description>;<date_from>;<date_to>;<id_group>;<monday>; * @param array $other Contains the following elements (in order):
* <tuesday>;<wednesday>;<thursday>;<friday>;<saturday>;<sunday>;<periodically_time_from>;<periodically_time_to>; * <description>
* <periodically_day_from>;<periodically_day_to>;<type_downtime>;<type_execution>;<type_periodicity>; in this order * <date_from>
* and separator char (after text ; ) and separator (pass in param othermode as othermode=url_encode_separator_<separator>) * <date_to>
* example: * <id_group>
* * <monday>
* api.php?op=set&op2=planned_downtimes_created&id=pepito&other=testing|08-22-2015|08-31-2015|0|1|1|1|1|1|1|1|17:06:00|19:06:00|1|31|quiet|periodically|weekly&other_mode=url_encode_separator_| * <tuesday>
* * <wednesday>
* <thursday>
* <friday>
* <saturday>
* <sunday>
* <periodically_time_from>
* <periodically_time_to>
* <periodically_day_from>
* <periodically_day_to>
* <type_downtime>
* <type_execution>
* <type_periodicity>
* @param $thrash3 Don't use. * @param $thrash3 Don't use.
*/ */
@ -6249,20 +6261,16 @@ function api_set_planned_downtimes_created($id, $thrash1, $other, $thrash3)
/** /**
* Add new items to planned Downtime. * Add new items to planned Downtime.
* e.g.: api.php?op=set&op2=planned_downtimes_additem&id=123&other=1;2;3;4|Status;Unkown_modules&other_mode=url_encode_separator_|
* *
* @param $id id of planned downtime. * @param $id id of planned downtime.
* @param $thrash1 Don't use. * @param $thrash1 Don't use.
* @param array $other it's array, $other as param is <id_agent1;id_agent2;id_agent3;....id_agentn;>; * @param array $other
* <name_module1;name_module2;name_module3;......name_modulen;> in this order * The first index contains a list of agent Ids.
* and separator char (after text ; ) and separator (pass in param othermode as othermode=url_encode_separator_<separator>) * The second index contains a list of module names.
* example: * The list separator is the character ';'.
*
* api.php?op=set&op2=planned_downtimes_additem&id=123&other=1;2;3;4|Status;Unkown_modules&other_mode=url_encode_separator_|
*
* @param $thrash3 Don't use. * @param $thrash3 Don't use.
*/ */
function api_set_planned_downtimes_additem($id, $thrash1, $other, $thrash3) function api_set_planned_downtimes_additem($id, $thrash1, $other, $thrash3)
{ {
if (defined('METACONSOLE')) { if (defined('METACONSOLE')) {