Merged in feature/HOR-3965 (pull request #6133)

Feature/HOR-3965

Approved-by: Paula Quispe <paula.quispe@processmaker.com>

workflow/engine/src/ProcessMaker/BusinessModel/Catalog.php

@@ -43,20 +43,25 @@ class Catalog
     }
 
     /**
-     * Update Catalog
+     * Update Catalog.
      *
      * @param string $cat_uid    Unique id of Group
      * @param string $cat_type   Unique id of Group
      * @param array  $arrayData  Data
      *
-     * return array Return data of the new Group update
-     * 
-     * @author Marco Antonio Nina <marco.antonio.nina@colosa.com>
+     * @return array Return data of the new Group update
+     *
+     * @access private
+     * @deprecated since 3.2.2
      */
     public function update($cat_uid, $cat_type, $arrayData)
     {
         $catalog = new \Catalog();
-        $response = $catalog->update($cat_uid, $cat_type, $arrayData);
+        $arrayData['CAT_UID'] = $cat_uid;
+        $arrayData['CAT_TYPE'] = !isset($arrayData['CAT_TYPE'])
+            ? $cat_type
+            : $arrayData['CAT_TYPE'];
+        $response = $catalog->createOrUpdate($arrayData);
         return $response;
     }
 

workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php

@@ -63,8 +63,14 @@ class ActionsByEmail extends Api
     }
 
     /**
+     * Update template.
      *
      * @url PUT /updateTemplate
+     *
+     * @param type $params
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function updateTemplate($params)
     {
@@ -81,8 +87,16 @@ class ActionsByEmail extends Api
     }
 
     /**
+     * Update configuration.
      *
      * @url PUT /saveConfiguration
+     *
+     * @param type $params
+     *
+     * @return mixed
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function saveConfiguration($params)
     {

workflow/engine/src/ProcessMaker/Services/Api/Calendar.php

@@ -80,13 +80,17 @@ class Calendar extends Api
     }
 
     /**
-     * 
-     * @access protected
-     * @class  AccessControl {@permission PM_SETUP_CALENDAR}
+     * Update calendar.
+     *
      * @url PUT /:cal_uid
      *
      * @param string $cal_uid      {@min 32}{@max 32}
      * @param array  $request_data
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_SETUP_CALENDAR}
      */
     public function doPut($cal_uid, $request_data)
     {

workflow/engine/src/ProcessMaker/Services/Api/Cases.php

@@ -756,12 +756,21 @@ class Cases extends Api
     }
 
     /**
+     * Start a new case and assign the logged-in user to work on the initial task 
+     * in the case. Note that the logged-in user must be in the pool of assigned 
+     * users for the initial task.
+     * 
      * @url POST
-     *
+     * 
      * @param string $pro_uid {@from body} {@min 32}{@max 32}
      * @param string $tas_uid {@from body} {@min 32}{@max 32}
      * @param array $variables {@from body}
-     *
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostCase($pro_uid, $tas_uid, $variables = null)
     {
@@ -776,13 +785,26 @@ class Cases extends Api
     }
 
     /**
+     * Creates a new case. It is similar to POST /cases, but it impersonates the 
+     * session variables, so it is more robust than POST /cases. Note that the 
+     * specified user to work on the case must be assigned to the pool of users 
+     * for the initial task. Also note that the new case's status will be set to 
+     * "DRAFT", not "TO_DO". If wishing to change the new case's status to "TO_DO", 
+     * then create the following trigger in the process and use 
+     * PUT /cases/{app_uid}/execute-trigger/{tri_uid} to execute it.
+     * 
      * @url POST /impersonate
-     *
+     * 
      * @param string $pro_uid {@from body} {@min 32}{@max 32}
      * @param string $usr_uid {@from body} {@min 32}{@max 32}
      * @param string $tas_uid {@from body} {@min 32}{@max 32}
      * @param array $variables {@from body}
-     *
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostCaseImpersonate($pro_uid, $usr_uid, $tas_uid, $variables = null)
     {
@@ -796,12 +818,19 @@ class Cases extends Api
     }
 
     /**
+     * Update case reassignment.
+     *
      * @url PUT /:app_uid/reassign-case
      *
      * @param string $app_uid {@min 32}{@max 32}
      * @param string $usr_uid_source {@from body} {@min 32}{@max 32}
      * @param string $usr_uid_target {@from body} {@min 32}{@max 32}
      * @param string $del_index {@from body}
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_REASSIGNCASE,PM_REASSIGNCASE_SUPERVISOR}
      */
     public function doPutReassignCase($app_uid, $usr_uid_source, $usr_uid_target, $del_index = null)
     {
@@ -815,11 +844,17 @@ class Cases extends Api
     }
 
     /**
-     * Route Case
+     * Route Case.
+     *
      * @url PUT /:app_uid/route-case
      *
      * @param string $app_uid {@min 32}{@max 32}
      * @param string $del_index {@from body}
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPutRouteCase($app_uid, $del_index = null)
     {
@@ -835,12 +870,14 @@ class Cases extends Api
     /**
      * Cancel Case
      *
+     * @url PUT /:cas_uid/cancel
+     *
      * @param string $cas_uid {@min 1}{@max 32}
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
+     * @throws RestException
      *
-     * @url PUT /:cas_uid/cancel
+     * @access protected
+     * @class AccessControl {@permission PM_CANCELCASE}
      */
     public function doPutCancelCase($cas_uid)
     {
@@ -856,13 +893,15 @@ class Cases extends Api
     /**
      * Pause Case
      *
+     * @url PUT /:cas_uid/pause
+     *
      * @param string $cas_uid {@min 1}{@max 32}
      * @param string $unpaused_date {@from body}
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
+     * @throws RestException
      *
-     * @url PUT /:cas_uid/pause
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPutPauseCase($cas_uid, $unpaused_date = null)
     {
@@ -882,12 +921,14 @@ class Cases extends Api
     /**
      * Unpause Case
      *
+     * @url PUT /:cas_uid/unpause
+     *
      * @param string $cas_uid {@min 1}{@max 32}
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
+     * @throws RestException
      *
-     * @url PUT /:cas_uid/unpause
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPutUnpauseCase($cas_uid)
     {
@@ -901,15 +942,17 @@ class Cases extends Api
     }
 
     /**
-     * Unpause Case
+     * Execute trigger in a case.
+     *
+     * @url PUT /:cas_uid/execute-trigger/:tri_uid
      *
      * @param string $cas_uid {@min 1}{@max 32}
      * @param string $tri_uid {@min 1}{@max 32}
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
+     * @throws RestException
      *
-     * @url PUT /:cas_uid/execute-trigger/:tri_uid
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPutExecuteTriggerCase($cas_uid, $tri_uid)
     {
@@ -924,13 +967,12 @@ class Cases extends Api
 
     /**
      * Delete Case
+     * @url DELETE /:cas_uid
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      *
      * @param string $cas_uid {@min 1}{@max 32}
-     *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
-     * @url DELETE /:cas_uid
      */
     public function doDeleteCase($cas_uid)
     {
@@ -973,15 +1015,17 @@ class Cases extends Api
     /**
      * Put Case Variables
      *
+     * @url PUT /:app_uid/variable
+     *
      * @param string $app_uid {@min 1}{@max 32}
      * @param array $request_data
      * @param string $dyn_uid {@from path}
      * @param int $del_index {@from path}
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
+     * @throws RestException
      *
-     * @url PUT /:app_uid/variable
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPutCaseVariables($app_uid, $request_data, $dyn_uid = '', $del_index = 0)
     {
@@ -1095,16 +1139,21 @@ class Cases extends Api
     }
 
     /**
-     * Put Case Variables
+     * Create a new case note for a given case. Note that only users who are 
+     * currently assigned to work on the case or have Process Permissions to 
+     * access case notes may create a case note.
      *
+     * @url POST /:app_uid/note
+     * 
      * @param string $app_uid {@min 1}{@max 32}
      * @param string $note_content {@min 1}{@max 500}
      * @param int $send_mail {@choice 1,0}
-     *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
-     * @url POST /:app_uid/note
+     * 
+     * @return void
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostCaseNote($app_uid, $note_content, $send_mail = 0)
     {
@@ -1140,14 +1189,17 @@ class Cases extends Api
     /**
      * Execute triggers
      *
+     * @url PUT /:app_uid/execute-triggers
+     *
      * @param string $app_uid {@min 1}{@max 32}
      * @param int $del_index {@from body}
      * @param string $obj_type {@from body}
      * @param string $obj_uid {@from body}
      *
-     * @copyright Colosa - Bolivia
+     * @throws RestException
      *
-     * @url PUT /:app_uid/execute-triggers
+     * @class AccessControl {@permission PM_CASES}
+     * @access protected
      */
     public function doPutExecuteTriggers($app_uid, $del_index, $obj_type, $obj_uid)
     {
@@ -1231,10 +1283,16 @@ class Cases extends Api
 
     /**
      * Mark a task process as a bookmark
+     * 
      * @url POST /bookmark/:tas_uid
-     *
+     * 
      * @param string $tas_uid {@min 32}{@max 32}
-     *
+     * 
+     * @return void
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostBookmarkStartCase($tas_uid)
     {

workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php

@@ -56,8 +56,6 @@ class InputDocument extends Api
     }
 
     /**
-     * @access protected
-     * @class AccessControl {@className \ProcessMaker\Services\Api\Cases}
      * @url GET /:app_uid/input-document/:app_doc_uid/file
      *
      * @param string $app_uid {@min 32}{@max 32}
@@ -77,6 +75,8 @@ class InputDocument extends Api
 
     /**
      * @url DELETE /:app_uid/:del_index/input-document/:app_doc_uid
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      *
      * @param string $app_uid     {@min 32}{@max 32}
      * @param int    $del_index   {@min 1}
@@ -96,12 +96,23 @@ class InputDocument extends Api
     }
 
     /**
+     * Uploads a new Input Document file to a specified case. Note that the 
+     * logged-in user must either be currently assigned to work on the case or a 
+     * Process Supervisor with permissions to access the Input Document; otherwise, 
+     * this endpoint returns an HTTP status code of 302.
+     * 
      * @url POST /:app_uid/input-document
-     *
+     * 
      * @param string $app_uid         { @min 32}{@max 32}
      * @param string $tas_uid         {@min 32}{@max 32}
      * @param string $app_doc_comment
      * @param string $inp_doc_uid     {@min 32}{@max 32}
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostInputDocument($app_uid, $tas_uid, $app_doc_comment, $inp_doc_uid)
     {

workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php

@@ -117,6 +117,8 @@ class OutputDocument extends Api
 
     /**
      * @url DELETE /:app_uid/output-document/:app_doc_uid
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      *
      * @param string $app_uid     {@min 32}{@max 32}
      * @param string $app_doc_uid     {@min 32}{@max 32}
@@ -133,11 +135,26 @@ class OutputDocument extends Api
     }
 
     /**
+     * Generate a specified Output Document for a given case, meaning that a PDF, 
+     * a DOC or both files (depending on options selected in the definition of the 
+     * Output Document) will be created, inserting any variables in the template. 
+     * If the Output Document already exists, then it will be regenerated. 
+     * If versioning is enabled, then the regenerated files will be given a new 
+     * version number and document index number, but if versioning is NOT enabled, 
+     * then the existing files will be overwritten with the same version number 
+     * and document index number.
+     * 
      * @url POST /:app_uid/:del_index/output-document/:out_doc_uid
-     *
+     * 
      * @param string $app_uid     {@min 32}{@max 32}
      * @param int    $del_index   {@min 1}
      * @param string $out_doc_uid {@min 32}{@max 32}
+     * 
+     * @return object
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostOutputDocument($app_uid, $del_index, $out_doc_uid)
     {

workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php

@@ -78,14 +78,21 @@ class Variable extends Api
     }
 
     /**
+     * Create a variable in a case, meaning the variable is instantiated in the case.
+     * 
      * @url POST /:app_uid/:del_index/variable/:var_name
-     *
+     * @status 201
+     * 
      * @param string $app_uid      {@min 32}{@max 32}
      * @param int    $del_index    {@min 1}
      * @param string $var_name
      * @param array  $request_data
-     *
-     * @status 201
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostVariable($app_uid, $del_index, $var_name, array $request_data)
     {
@@ -99,14 +106,20 @@ class Variable extends Api
     }
 
     /**
+     * Update variable.
+     *
      * @url PUT /:app_uid/:del_index/variable/:var_name
+     * @status 204
      *
      * @param string $app_uid      {@min 32}{@max 32}
      * @param int    $del_index    {@min 1}
      * @param string $var_name
      * @param array  $request_data
      *
-     * @status 204
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPutVariable($app_uid, $del_index, $var_name, array $request_data)
     {
@@ -119,6 +132,8 @@ class Variable extends Api
 
     /**
      * @url DELETE /:app_uid/:del_index/variable/:var_name
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      *
      * @param string $app_uid   {@min 32}{@max 32}
      * @param int    $del_index {@min 1}

workflow/engine/src/ProcessMaker/Services/Api/Catalog.php

@@ -38,14 +38,19 @@ class Catalog extends Api
     }
 
     /**
+     * Deprecated.
+     * 
      * @url POST
-     *
-     * @param array $request_data
-     *
-     * @author Marco Antonio Nina <marco.antonio.nina@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
      * @status 201
+     * 
+     * @param array $request_data
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
+     * @deprecated The method has been deprecated.
      */
     public function doPost($request_data)
     {
@@ -62,14 +67,18 @@ class Catalog extends Api
     }
 
     /**
+     * Update catalog.
+     *
      * @url PUT /:cat_uid/:cat_type
      *
      * @param string $cat_uid  {@min 32}{@max 32}
      * @param string $cat_type      {@min 32}{@max 32}
      * @param array  $request_data
      *
-     * @author Marco Antonio Nina <marco.antonio.nina@colosa.com>
-     * @copyright Colosa - Bolivia
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      */
     public function doPut($cat_uid, $cat_type, $request_data)
     {
@@ -81,25 +90,5 @@ class Catalog extends Api
             throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage()));
         }
     }
-
-    /**
-     * @url DELETE /:cat_uid/:cat_type
-     *
-     * @param string $cat_uid  {@min 32}{@max 32}
-     * @param string $cat_type      {@min 32}{@max 32}
-     *
-     * @author Marco Antonio Nina <marco.antonio.nina@colosa.com>
-     * @copyright Colosa - Bolivia
-     */
-    public function doDelete($cat_uid, $cat_type)
-    {
-        try {
-            $catalog = new \ProcessMaker\BusinessModel\Catalog();
-
-            $arrayData = $catalog->delete($cat_uid, $cat_type);
-        } catch (\Exception $e) {
-            throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage()));
-        }
-    }
 }
 

workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php

@@ -108,16 +108,18 @@ class Consolidated extends Api
     /**
      * Get Cases Consolidated
      *
+     * @url PUT /cases/:tas_uid/:dyn_uid/:pro_uid
+     *
      * @param string $tas_uid {@min 1} {@max 32}
      * @param string $dyn_uid {@min 1} {@max 32}
      * @param string $pro_uid {@min 1} {@max 32}
      * @param array $request_data
+     *
      * @return array
+     * @throws RestException
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
-     * @url PUT /cases/:tas_uid/:dyn_uid/:pro_uid
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPutCasesConsolidated($tas_uid, $dyn_uid, $pro_uid, $request_data)
     {
@@ -133,18 +135,20 @@ class Consolidated extends Api
     /**
      * Post Derivate
      *
+     * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/:field_grid_val
+     * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/
+     * 
      * @param string $app_uid {@min 1} {@max 32}
      * @param string $app_number
      * @param int $del_index
      * @param string $field_grid
      * @param string $field_grid_val
+     * 
      * @return array
-     *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
-     * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/:field_grid_val
-     * @url POST /derivate/:app_uid/:app_number/:del_index/:field_grid/
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostDerivate($app_uid, $app_number, $del_index, $field_grid, $field_grid_val = '')
     {

workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php

@@ -220,12 +220,18 @@ class Dashboard extends Api
     }
 
     /**
+     * Create dashboard.
+     * 
      * @url POST
-     *
-     * @param array $request_data
-     *
-     *
      * @status 201
+     * 
+     * @param array $request_data
+     * 
+     * @return integer
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      */
     public function doPostDashboard($request_data)
     {
@@ -242,11 +248,15 @@ class Dashboard extends Api
     /**
      * Put dashboards configuration
      *
-     * @param array $request_data
-     *
-     *
      * @url PUT
      *
+     * @param array $request_data
+     *
+     * @return string
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      */
     public function doPutDashboard($request_data)
     {
@@ -262,6 +272,8 @@ class Dashboard extends Api
 
     /**
      * @url DELETE /:das_uid
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      *
      * @param string $das_uid  {@min 32}{@max 32}
      *
@@ -279,12 +291,18 @@ class Dashboard extends Api
     }
 
     /**
-     * @param array $request_data
-     *
-     *
+     * Create owner
+     * 
      * @url POST /owner
-     *
      * @status 201
+     * 
+     * @param array $request_data
+     * 
+     * @return object
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      */
     public function doPostOwner($request_data)
     {
@@ -300,6 +318,8 @@ class Dashboard extends Api
 
     /**
      * @url DELETE /:das_uid/owner/:owner_uid
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      *
      * @param string $das_uid  {@min 32}{@max 32}
      * @param string $owner_uid  {@min 32}{@max 32}
@@ -317,12 +337,18 @@ class Dashboard extends Api
     }
 
     /**
-     * @param array $request_data
-     *
-     *
+     * Create indicator.
+     * 
      * @url POST /indicator
-     *
      * @status 201
+     * 
+     * @param array $request_data
+     * 
+     * @return string
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      */
     public function doPostIndicator($request_data)
     {
@@ -341,8 +367,11 @@ class Dashboard extends Api
      *
      * @param array $request_data
      *
-     * @url PUT /indicator
+     * @return string
+     * @throws RestException
      *
+     * @class AccessControl {@permission PM_DASHBOARD}
+     * @access protected
      */
     public function doPutIndicator($request_data)
     {
@@ -358,6 +387,8 @@ class Dashboard extends Api
 
     /**
      * @url DELETE /indicator/:ind_uid
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      *
      * @param string $ind_uid  {@min 32}{@max 32}
      *
@@ -376,10 +407,15 @@ class Dashboard extends Api
     /**
      * Post dashboards configuration by userUid
      *
-     * @param array $request_data
-     *
      * @url POST /config/
-     *
+     * 
+     * @param array $request_data
+     * 
+     * @return integer
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      */
     public function doPostDashboardConfigByUsrUid($request_data)
     {
@@ -416,10 +452,15 @@ class Dashboard extends Api
     /**
      * Put dashboards configuration by usr_uid
      *
-     * @param array $request_data
-     *
      * @url PUT /config
      *
+     * @param array $request_data
+     *
+     * @return array
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_DASHBOARD}
      */
     public function doPutDashboardConfigByUsrUid($request_data)
     {

workflow/engine/src/ProcessMaker/Services/Api/Department.php

@@ -102,13 +102,21 @@ class Department extends Api
     }
 
     /**
+     * Assign a user to a specified department in version 3.0 and later. If the 
+     * user is already a member of another department, the user will be transfered 
+     * to the specified department.
+     * 
      * @url POST /:dep_uid/assign-user
-     *
+     * @status 201
+     * 
      * @param string $dep_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     *
-     * @status 201
-     *
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPostAssignUser($dep_uid, array $request_data)
     {
@@ -123,6 +131,8 @@ class Department extends Api
 
     /**
      * @url DELETE /:dep_uid/unassign-user/:usr_uid
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      *
      * @param string $dep_uid {@min 1}{@max 32}
      * @param string $usr_uid {@min 1}{@max 32}
@@ -141,13 +151,18 @@ class Department extends Api
     }
 
     /**
+     * Update manager user
+     *
      * @url PUT /:dep_uid/set-manager/:usr_uid
      *
      * @param string $dep_uid {@min 1}{@max 32}
      * @param string $usr_uid {@min 1}{@max 32}
      *
      * @return array
+     * @throws RestException
      *
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPutSetManager($dep_uid, $usr_uid)
     {
@@ -180,15 +195,19 @@ class Department extends Api
     }
 
     /**
+     * Create a new department.
+     * 
      * @url POST
-     *
+     * @status 201
+     * 
      * @param array $request_data
      * @param string $dep_title {@from body} {@min 1}
-     *
+     * 
      * @return array
-     *
-     * @status 201
-     *
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPost($request_data, $dep_title)
     {
@@ -202,11 +221,17 @@ class Department extends Api
     }
 
     /**
+     * Update department.
+     *
      * @url PUT /:dep_uid
      *
      * @param string $dep_uid      {@min 1}{@max 32}
      * @param array  $request_data
      *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPut($dep_uid, $request_data)
     {
@@ -221,6 +246,8 @@ class Department extends Api
 
     /**
      * @url DELETE /:dep_uid
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      *
      * @param string $dep_uid {@min 1}{@max 32}
      *

workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php

@@ -85,9 +85,17 @@ class EmailServer extends Api
     }
 
     /**
+     * Test connection.
+     * 
      * @url POST /test-connection
-     *
+     * 
      * @param array $request_data
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_SETUP_EMAIL}
      */
     public function doPostTestConnection(array $request_data)
     {
@@ -103,11 +111,18 @@ class EmailServer extends Api
     }
 
     /**
+     * Create email server.
+     * 
      * @url POST
-     *
-     * @param array $request_data
-     *
      * @status 201
+     * 
+     * @param array $request_data
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_SETUP_EMAIL}
      */
     public function doPost(array $request_data)
     {
@@ -123,12 +138,18 @@ class EmailServer extends Api
     }
 
     /**
+     * Update email server.
+     *
      * @url PUT /:mess_uid
+     * @status 200
      *
      * @param string $mess_uid     {@min 32}{@max 32}
      * @param array  $request_data
      *
-     * @status 200
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_SETUP_EMAIL}
      */
     public function doPut($mess_uid, array $request_data)
     {
@@ -141,6 +162,8 @@ class EmailServer extends Api
 
     /**
      * @url DELETE /:mess_uid
+     * @access protected
+     * @class AccessControl {@permission PM_SETUP_EMAIL}
      *
      * @param string $mess_uid {@min 32}{@max 32}
      *

workflow/engine/src/ProcessMaker/Services/Api/File.php

@@ -12,9 +12,17 @@ use \Luracast\Restler\RestException;
 class File extends Api
 {
     /**
-     *
+     * Upload file.
+     * 
      * @url POST /upload
+     * 
      * @param array  $request_data
+     * 
+     * @return array
+     * @throws RestException
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostFilesUpload($request_data)
     {

workflow/engine/src/ProcessMaker/Services/Api/Group.php

@@ -73,11 +73,18 @@ class Group extends Api
     }
 
     /**
+     * Create a new group.
+     * 
      * @url POST
-     *
-     * @param array $request_data
-     *
      * @status 201
+     * 
+     * @param array $request_data
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPost($request_data)
     {
@@ -96,10 +103,17 @@ class Group extends Api
     }
 
     /**
+     * Update group.
+     *
      * @url PUT /:grp_uid
      *
      * @param string $grp_uid      {@min 32}{@max 32}
      * @param array  $request_data
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPut($grp_uid, $request_data)
     {
@@ -115,6 +129,8 @@ class Group extends Api
 
     /**
      * @url DELETE /:grp_uid
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      *
      * @param string $grp_uid {@min 32}{@max 32}
      */

workflow/engine/src/ProcessMaker/Services/Api/Group/User.php

@@ -12,12 +12,19 @@ use \Luracast\Restler\RestException;
 class User extends Api
 {
     /**
+     * Assign a user to a specified group.
+     * 
      * @url POST /:grp_uid/user
-     *
+     * @status 201
+     * 
      * @param string $grp_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     *
-     * @status 201
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPostUser($grp_uid, $request_data)
     {
@@ -32,11 +39,18 @@ class User extends Api
     }
 
     /**
+     * Assign a group of users to a specified group or groups.
+     * 
      * @url POST /batch-users
-     *
-     * @param array $request_data
-     *
      * @status 201
+     * 
+     * @param array $request_data
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPostBatchUsers($request_data)
     {
@@ -63,6 +77,8 @@ class User extends Api
 
     /**
      * @url DELETE /:grp_uid/user/:usr_uid
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      *
      * @param string $grp_uid {@min 32}{@max 32}
      * @param string $usr_uid {@min 32}{@max 32}

workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php

@@ -36,15 +36,15 @@ class NotificationDevice extends Api
     }
 
     /**
-     * Post Create register device with userUid
+     * Update device language.
+     *
+     * @url PUT /notification/:dev_uid
      *
      * @param string $dev_uid {@min 32}{@max 32}
      * @param array $request_data
      *
-     * @author Ronald Quenta <ronald.quenta@processmaker.com>
      * @return array
-     *
-     * @url PUT /notification/:dev_uid
+     * @throws RestException
      */
     public function updateDeviceLanguage($dev_uid, $request_data)
     {
@@ -78,14 +78,14 @@ class NotificationDevice extends Api
     }
 
     /**
+     * @url DELETE /notification/:dev_uid
+     * This actions is executed in the logout action
+     *
      * Delete record device with dev_uid and usr_uid
      *
      * @param string $dev_uid {@min 32}{@max 32}
      *
-     * @author Ronald Quenta <ronald.quenta@processmaker.com>
      * @return array
-     *
-     * @url DELETE /notification/:dev_uid
      */
     public function deleteDevice($dev_uid)
     {

workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php

@@ -137,17 +137,18 @@ class Pmtable extends Api
     }
 
     /**
+     * Update pm-table.
+     *
+     * @url PUT /:pmt_uid
+     *
      * @param string $pmt_uid {@min 1} {@max 32}
-     *
      * @param array $request_data
-     * @return void
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
+     * @return void
+     * @throw RestException
      *
      * @access protected
-     * @class  AccessControl {@permission PM_SETUP_PM_TABLES}
-     * @url PUT /:pmt_uid
+     * @class AccessControl {@permission PM_SETUP_PM_TABLES}
      */
     public function doPutPmTable(
         $pmt_uid,
@@ -163,17 +164,18 @@ class Pmtable extends Api
     }
 
     /**
+     * Update pm-table data.
+     *
+     * @url PUT /:pmt_uid/data
+     *
      * @param string $pmt_uid {@min 1} {@max 32}
-     *
      * @param array $request_data
-     * @return array
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
+     * @return array
+     * @throws RestException
      *
      * @access protected
-     * @class  AccessControl {@permission PM_SETUP_PM_TABLES}
-     * @url PUT /:pmt_uid/data
+     * @class AccessControl {@permission PM_SETUP_PM_TABLES}
      */
     public function doPutPmTableData(
         $pmt_uid,

workflow/engine/src/ProcessMaker/Services/Api/Process.php

@@ -63,6 +63,17 @@ class Process extends Api
         return $response;
     }
 
+    /**
+     * Create process
+     * 
+     * @param array $request_data
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
+     */
     public function post($request_data = null)
     {
         defined('SYS_LANG') || define("SYS_LANG", $request_data["lang"]);
@@ -78,6 +89,18 @@ class Process extends Api
         }
     }
 
+    /**
+     * Update a process by UID.
+     *
+     * @param string $processUid
+     * @param array $request_data
+     *
+     * @return array
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
+     */
     public function put($processUid, $request_data = null)
     {
         $response = array();

workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php

@@ -90,13 +90,17 @@ class ProcessCategory extends Api
     }
 
     /**
-     * 
-     * @access protected
-     * @class  AccessControl {@permission PM_SETUP_PROCESS_CATEGORIES}
+     * Update category.
+     *
      * @url PUT /category/:cat_uid
      *
-     * @param string $cat_uid      {@min 32}{@max 32}
+     * @param string $cat_uid {@min 32}{@max 32}
      * @param array  $request_data
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_SETUP_PROCESS_CATEGORIES}
      */
     public function doPutCategory($cat_uid, array $request_data)
     {

workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php

@@ -101,17 +101,21 @@ class Activity extends Api
         }
     }
 
-
     /**
+     * Update an activity.
+     *
+     * @url PUT /:prj_uid/activity/:act_uid
+     *
      * @param string $prj_uid {@min 32} {@max 32}
      * @param string $act_uid {@min 32} {@max 32}
      * @param ActivityPropertiesStructure $properties {@from body}
+     * @param array $request_data
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     * @return array
+     * @return void
+     * @throws RestException
      *
-     * @url PUT /:prj_uid/activity/:act_uid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutProjectActivity($prj_uid, $act_uid, ActivityPropertiesStructure $properties, $request_data =  array())
     {
@@ -217,9 +221,18 @@ class Activity extends Api
     }
     
     /**
+     * Get activity validate self service.
+     *
      * @url PUT /:prj_uid/activity/validate-active-cases
      *
      * @param string $prj_uid {@min 32}{@max 32}
+     * @param array $request_data
+     *
+     * @return \StdClass
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doGetActivityValidateSelfService($prj_uid, $request_data =  array())
     {

workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Assignee.php

@@ -92,14 +92,21 @@ class Assignee extends Api
     }
 
     /**
+     * Assign an user or group to a task.
+     * 
      * @url POST /:prjUid/activity/:actUid/assignee
-     *
+     * @status 201
+     * 
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $actUid {@min 32} {@max 32}
      * @param string $aas_uid {@min 32} {@max 32}
      * @param string $aas_type {@choice user,group}
-     *
-     * @status 201
+     * 
+     * @return void
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityAssignee($prjUid, $actUid, $aas_uid, $aas_type)
     {
@@ -112,6 +119,8 @@ class Assignee extends Api
 
     /**
      * @url DELETE /:prjUid/activity/:actUid/assignee/:aasUid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $actUid {@min 32} {@max 32}
@@ -191,14 +200,21 @@ class Assignee extends Api
     }
 
     /**
+     * Assign an user or group to a task (Ad-hoc assignment).
+     * 
      * @url POST /:prjUid/activity/:actUid/adhoc-assignee
-     *
+     * @status 201
+     * 
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $actUid {@min 32} {@max 32}
      * @param string $ada_uid {@min 32} {@max 32}
      * @param string $ada_type {@choice user,group}
-     *
-     * @status 201
+     * 
+     * @return void
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityAdhocAssignee($prjUid, $actUid, $ada_uid, $ada_type)
     {
@@ -211,6 +227,8 @@ class Assignee extends Api
 
     /**
      * @url DELETE /:prjUid/activity/:actUid/adhoc-assignee/:adaUid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $actUid {@min 32} {@max 32}

workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step.php

@@ -34,8 +34,11 @@ class Step extends Api
     }
 
     /**
+     * Assign a step to a task.
+     * 
      * @url POST /:prj_uid/activity/:act_uid/step
-     *
+     * @status 201
+     * 
      * @param string $act_uid        {@min 32}{@max 32}
      * @param string $prj_uid        {@min 32}{@max 32}
      * @param array  $request_data
@@ -44,8 +47,12 @@ class Step extends Api
      * @param string $step_condition {@from body}
      * @param int    $step_position  {@from body}{@min 1}
      * @param string $step_mode      {@from body}{@choice EDIT,VIEW}{@required true}
-     *
-     * @status 201
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityStep(
         $act_uid,
@@ -73,6 +80,8 @@ class Step extends Api
     }
 
     /**
+     * Update step.
+     *
      * @url PUT /:prj_uid/activity/:act_uid/step/:step_uid
      *
      * @param string $step_uid       {@min 32}{@max 32}
@@ -84,6 +93,11 @@ class Step extends Api
      * @param string $step_condition {@from body}
      * @param int    $step_position  {@from body}{@min 1}
      * @param string $step_mode      {@from body}{@choice EDIT,VIEW}
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutActivityStep(
         $step_uid,
@@ -109,6 +123,8 @@ class Step extends Api
 
     /**
      * @url DELETE /:prj_uid/activity/:act_uid/step/:step_uid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $step_uid {@min 32}{@max 32}
      * @param string $act_uid  {@min 32}{@max 32}
@@ -218,8 +234,11 @@ class Step extends Api
     }
 
     /**
+     * Create Steps for a Task.
+     * 
      * @url POST /:prj_uid/activity/:act_uid/step/all
-     *
+     * @status 201
+     * 
      * @param string $act_uid        {@min 32}{@max 32}
      * @param string $prj_uid        {@min 32}{@max 32}
      * @param array  $request_data
@@ -228,8 +247,12 @@ class Step extends Api
      * @param string $step_condition {@from body}
      * @param int    $step_position  {@from body}{@min 1}
      * @param string $step_mode      {@from body}{@choice EDIT,VIEW}{@required true}
-     *
-     * @status 201
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityStepAll(
         $act_uid,

workflow/engine/src/ProcessMaker/Services/Api/Project/Activity/Step/Trigger.php

@@ -34,14 +34,21 @@ class Trigger extends Api
     }
 
     /**
+     * Assign a trigger to a step.
+     * 
      * @url POST /:prj_uid/activity/:act_uid/step/:step_uid/trigger
-     *
+     * @status 201
+     * 
      * @param string $step_uid
      * @param string $act_uid
      * @param string $prj_uid
      * @param StepTriggerPostStructure $request_data
-     *
-     * @status 201
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityStepTrigger($step_uid, $act_uid, $prj_uid, StepTriggerPostStructure $request_data = null)
     {
@@ -57,6 +64,8 @@ class Trigger extends Api
     }
 
     /**
+     * Update activity step trigger.
+     *
      * @url PUT /:prj_uid/activity/:act_uid/step/:step_uid/trigger/:tri_uid
      *
      * @param string $tri_uid
@@ -64,6 +73,11 @@ class Trigger extends Api
      * @param string $act_uid
      * @param string $prj_uid
      * @param StepTriggerPutStructure $request_data
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutActivityStepTrigger($tri_uid, $step_uid, $act_uid, $prj_uid, StepTriggerPutStructure $request_data = null)
     {
@@ -80,6 +94,8 @@ class Trigger extends Api
 
     /**
      * @url DELETE /:prj_uid/activity/:act_uid/step/:step_uid/trigger/:tri_uid/:type
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $tri_uid
      * @param string $step_uid
@@ -122,13 +138,20 @@ class Trigger extends Api
     }
 
     /**
+     * Assign a trigger to the "Assignment" or "Routing" step section of an activity.
+     * 
      * @url POST /:prj_uid/activity/:act_uid/step/trigger
-     *
+     * @status 201
+     * 
      * @param string $act_uid
      * @param string $prj_uid
      * @param StepAssignTaskTriggerPostStructure $request_data
-     *
-     * @status 201
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityStepAssignTaskTrigger($act_uid, $prj_uid, StepAssignTaskTriggerPostStructure $request_data = null)
     {
@@ -144,12 +167,19 @@ class Trigger extends Api
     }
 
     /**
+     * Update activity step assign task trigger.
+     *
      * @url PUT /:prj_uid/activity/:act_uid/step/trigger/:tri_uid
      *
      * @param string $tri_uid
      * @param string $act_uid
      * @param string $prj_uid
      * @param StepAssignTaskTriggerPutStructure $request_data
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutActivityStepAssignTaskTrigger($tri_uid, $act_uid, $prj_uid, StepAssignTaskTriggerPutStructure $request_data = null)
     {
@@ -166,6 +196,8 @@ class Trigger extends Api
 
     /**
      * @url DELETE /:prj_uid/activity/:act_uid/step/trigger/:tri_uid/:type
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $tri_uid
      * @param string $act_uid

workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php

@@ -51,12 +51,19 @@ class CaseScheduler extends Api
     }
 
     /**
+     * Creates a new Case Scheduler. 
+     * 
+     * @url POST /:prjUid/case-scheduler
+     * @status 201
+     * 
      * @param string $prjUid {@min 32} {@max 32}
      * @param CaseSchedulerStructure $request_data
-     *
-     * @url POST /:prjUid/case-scheduler
-     *
-     * @status 201
+     * 
+     * @return mixed
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProjectCaseScheduler($prjUid, CaseSchedulerStructure $request_data =  null)
     {
@@ -75,12 +82,19 @@ class CaseScheduler extends Api
     }
 
     /**
+     * Update project case scheduler.
+     *
      * @url PUT /:prjUid/case-scheduler/:schUid
      *
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $schUid {@min 32} {@max 32}
-     * @param CaseSchedulerStructure $request_data     
+     * @param CaseSchedulerStructure $request_data
      *
+     * @return array
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutProjectCaseScheduler($prjUid, $schUid, CaseSchedulerStructure $request_data)
     {
@@ -100,6 +114,9 @@ class CaseScheduler extends Api
 
     /**
      * @url DELETE /:prjUid/case-scheduler/:schUid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
+     *
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $schUid {@min 32} {@max 32}
      *

workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php

@@ -30,6 +30,8 @@ class CaseTracker extends Api
     }
 
     /**
+     * Update case tracker.
+     *
      * @url PUT /:prj_uid/case-tracker/property
      *
      * @param string $prj_uid         {@min 32}{@max 32}
@@ -37,6 +39,11 @@ class CaseTracker extends Api
      * @param string $map_type        {@from body}{@choice NONE,PROCESSMAP,STAGES}
      * @param int    $routing_history {@from body}{@choice 0,1}
      * @param int    $message_history {@from body}{@choice 0,1}
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutCaseTracker(
         $prj_uid,

workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php

@@ -31,16 +31,23 @@ class CaseTrackerObject extends Api
     }
 
     /**
+     * Assign an object (Dynaform, Input Document, Output Document) to a case tracker.
+     * 
      * @url POST /:prj_uid/case-tracker/object
-     *
+     * @status 201
+     * 
      * @param string $prj_uid       {@min 32}{@max 32}
      * @param array  $request_data
      * @param string $cto_type_obj  {@from body}{@choice DYNAFORM,INPUT_DOCUMENT,OUTPUT_DOCUMENT}{@required true}
      * @param string $cto_uid_obj   {@from body}{@min 32}{@max 32}{@required true}
      * @param string $cto_condition {@from body}
      * @param int    $cto_position  {@from body}{@min 1}
-     *
-     * @status 201
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostCaseTrackerObject(
         $prj_uid,
@@ -64,6 +71,8 @@ class CaseTrackerObject extends Api
     }
 
     /**
+     * Update case tracker object.
+     *
      * @url PUT /:prj_uid/case-tracker/object/:cto_uid
      *
      * @param string $cto_uid       {@min 32}{@max 32}
@@ -73,6 +82,11 @@ class CaseTrackerObject extends Api
      * @param string $cto_uid_obj   {@from body}{@min 32}{@max 32}
      * @param string $cto_condition {@from body}
      * @param int    $cto_position  {@from body}{@min 1}
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutCaseTrackerObject(
         $cto_uid,
@@ -94,6 +108,8 @@ class CaseTrackerObject extends Api
 
     /**
      * @url DELETE /:prj_uid/case-tracker/object/:cto_uid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $cto_uid {@min 32}{@max 32}
      * @param string $prj_uid {@min 32}{@max 32}

workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php

@@ -55,9 +55,12 @@ class DataBaseConnection extends Api
     }
 
     /**
+     * Test a database connection with the provided settings.
+     * 
+     * @url POST /:prj_uid/database-connection/test
+     * 
      * @param string $prj_uid {@min 1} {@max 32}
      * @param array $request_data
-     *
      * @param string $dbs_type {@from body} {@required true}
      * @param string $dbs_server {@from body} {@required false}
      * @param string $dbs_database_name {@from body} {@required false}
@@ -65,12 +68,12 @@ class DataBaseConnection extends Api
      * @param string $dbs_encode {@from body} {@required true}
      * @param string $dbs_password {@from body}
      * @param string $dbs_description {@from body}
+     * 
      * @return array
-     *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
-     * @url POST /:prj_uid/database-connection/test
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostTestDataBaseConnection(
         $prj_uid,
@@ -94,9 +97,13 @@ class DataBaseConnection extends Api
     }
 
     /**
+     * Creates a new database connection.
+     * 
+     * @url POST /:prj_uid/database-connection
+     * @status 201
+     * 
      * @param string $prj_uid {@min 1} {@max 32}
      * @param array $request_data
-     *
      * @param string $dbs_type {@from body} {@required true}
      * @param string $dbs_server {@from body} {@required false}
      * @param string $dbs_database_name {@from body} {@required false}
@@ -104,13 +111,12 @@ class DataBaseConnection extends Api
      * @param string $dbs_encode {@from body} {@required true}
      * @param string $dbs_password {@from body}
      * @param string $dbs_description {@from body}
+     * 
      * @return array
-     *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
-     * @url POST /:prj_uid/database-connection
-     * @status 201
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostDataBaseConnection(
         $prj_uid,
@@ -133,10 +139,13 @@ class DataBaseConnection extends Api
     }
 
     /**
+     * Update database connection.
+     *
+     * @url PUT /:prj_uid/database-connection/:dbs_uid
+     *
      * @param string $prj_uid {@min 1} {@max 32}
      * @param string $dbs_uid {@min 1} {@max 32}
      * @param array $request_data
-     *
      * @param string $dbs_type {@from body} {@required true}
      * @param string $dbs_server {@from body} {@required true}
      * @param string $dbs_database_name {@from body} {@required true}
@@ -144,12 +153,12 @@ class DataBaseConnection extends Api
      * @param string $dbs_encode {@from body} {@required true}
      * @param string $dbs_password {@from body}
      * @param string $dbs_description {@from body}
+     *
      * @return void
+     * @throws RestException
      *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
-     * @url PUT /:prj_uid/database-connection/:dbs_uid
+     * @access protected
+     * @class AccessControl {@permission PM_SETUP}
      */
     public function doPutDataBaseConnection(
         $prj_uid,
@@ -173,14 +182,13 @@ class DataBaseConnection extends Api
     }
 
     /**
+     * @url DELETE /:prj_uid/database-connection/:dbs_uid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
+     *
      * @param string $prj_uid {@min 1} {@max 32}
      * @param string $dbs_uid {@min 1} {@max 32}
      * @return void
-     *
-     * @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
-     * @copyright Colosa - Bolivia
-     *
-     * @url DELETE /:prj_uid/database-connection/:dbs_uid
      */
     public function doDeleteDataBaseConnection($prj_uid, $dbs_uid)
     {

workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php

@@ -38,12 +38,19 @@ class DynaForm extends Api
     }
     
     /**
+     * Create Dynaform.
+     * 
      * @url POST /:prj_uid/dynaform
-     *
+     * @status 201
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     *
-     * @status 201
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostDynaForm($prj_uid, $request_data)
     {
@@ -63,11 +70,18 @@ class DynaForm extends Api
     }
 
     /**
+     * Update dynaform.
+     *
      * @url PUT /:prj_uid/dynaform/:dyn_uid
      *
      * @param string $dyn_uid      {@min 32}{@max 32}
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutDynaForm($dyn_uid, $prj_uid, $request_data)
     {
@@ -83,6 +97,8 @@ class DynaForm extends Api
 
     /**
      * @url DELETE /:prj_uid/dynaform/:dyn_uid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $dyn_uid {@min 32}{@max 32}
      * @param string $prj_uid {@min 32}{@max 32}
@@ -137,10 +153,18 @@ class DynaForm extends Api
     }
 
     /**
+     * Upload language for a Dynaform.
+     * 
      * @url POST /:prj_uid/dynaform/:dyn_uid/upload-language
      *
      * @param string $dyn_uid {@min 32}{@max 32}
      * @param string $prj_uid {@min 32}{@max 32}
+     * 
+     * @return void
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostDynaFormLanguage($dyn_uid, $prj_uid)
     {
@@ -154,10 +178,19 @@ class DynaForm extends Api
     }
 
     /**
+     * Delete language from a Dynaform.
+     * 
      * @url POST /:prj_uid/dynaform/:dyn_uid/delete-language/:lang
      *
      * @param string $dyn_uid {@min 32}{@max 32}
      * @param string $prj_uid {@min 32}{@max 32}
+     * @param string $lang
+     * 
+     * @return void
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doDeleteDynaFormLanguage($dyn_uid, $prj_uid, $lang)
     {
@@ -188,11 +221,19 @@ class DynaForm extends Api
     }
 
     /**
+     * Get Dynaform's history.
+     * 
      * @url POST /:prj_uid/dynaform/:dyn_uid/history
      *
      * @param string $dyn_uid {@min 32}{@max 32}
      * @param string $prj_uid {@min 32}{@max 32}
      * @param array  $request_data
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doGetDynaFormHistory($dyn_uid, $prj_uid, $request_data)
     {

workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php

@@ -64,9 +64,18 @@ class EmailEvent extends Api
     }
     
     /**
+     * Save Data for email event.
+     * 
      * @url POST /:prj_uid/email-event
-     *
+     * 
      * @param string $prj_uid {@min 1} {@max 32}
+     * @param array $request_data
+     * 
+     * @return array
+     * @throws RestException 
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostEmailEvent($prj_uid, array $request_data)
     {
@@ -79,11 +88,18 @@ class EmailEvent extends Api
     }
     
     /**
+     * Update email event.
+     *
      * @url PUT /:prj_uid/email-event/:email_event_uid
      *
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param string $email_event_uid    {@min 32}{@max 32}
      * @param array  $request_data
+     *
+     * @throws RestException
+     *
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPutEmailEvent($prj_uid, $email_event_uid, array $request_data)
     {
@@ -96,6 +112,8 @@ class EmailEvent extends Api
     
     /**
      * @url DELETE /:prj_uid/email-event/:email_event_uid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $prj_uid   {@min 32}{@max 32}
      * @param string $email_event_uid {@min 32}{@max 32}
@@ -111,6 +129,8 @@ class EmailEvent extends Api
     
     /**
      * @url DELETE /:prj_uid/email-event/by-event/:act_uid
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      *
      * @param string $prj_uid   {@min 32}{@max 32}
      * @param string $act_uid {@min 32}{@max 32}