HOR-3968

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

@@ -756,12 +756,18 @@ 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
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @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}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostCase($pro_uid, $tas_uid, $variables = null)
     {
@@ -776,13 +782,23 @@ 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
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @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}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostCaseImpersonate($pro_uid, $usr_uid, $tas_uid, $variables = null)
     {
@@ -1095,14 +1111,18 @@ 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
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param string $app_uid {@min 1}{@max 32}
      * @param string $note_content {@min 1}{@max 500}
      * @param int $send_mail {@choice 1,0}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostCaseNote($app_uid, $note_content, $send_mail = 0)
     {
@@ -1231,9 +1251,11 @@ class Cases extends Api
      * Mark a task process as a bookmark
      * 
      * @url POST /bookmark/:tas_uid
+     * 
+     * @param string $tas_uid {@min 32}{@max 32}
+     * 
      * @access protected
      * @class AccessControl {@permission PM_CASES}
-     * @param string $tas_uid {@min 32}{@max 32}
      */
     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}
@@ -96,13 +94,20 @@ 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
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @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}
+     * 
+     * @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

@@ -133,12 +133,23 @@ 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
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param string $app_uid     {@min 32}{@max 32}
      * @param int    $del_index   {@min 1}
      * @param string $out_doc_uid {@min 32}{@max 32}
+     * 
+     * @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,18 @@ 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
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_CASES}
+     * 
      * @param string $app_uid      {@min 32}{@max 32}
      * @param int    $del_index    {@min 1}
      * @param string $var_name
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostVariable($app_uid, $del_index, $var_name, array $request_data)
     {

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

@@ -38,11 +38,16 @@ class Catalog extends Api
     }
 
     /**
+     * Deprecated.
+     * 
      * @url POST
+     * @status 201
+     * 
+     * @param array $request_data
+     * 
      * @access protected
      * @class AccessControl {@permission PM_DASHBOARD}
-     * @param array $request_data
+     * @deprecated The method has been deprecated.
-     * @status 201
      */
     public function doPost($request_data)
     {

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

@@ -135,14 +135,16 @@ class Consolidated extends Api
      *
      * @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/
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @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
+     * 
+     * @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,11 +220,15 @@ class Dashboard extends Api
     }
 
     /**
+     * Create dashboard.
+     * 
      * @url POST
+     * @status 201
+     * 
+     * @param array $request_data
+     * 
      * @access protected
      * @class AccessControl {@permission PM_DASHBOARD}
-     * @param array $request_data
-     * @status 201
      */
     public function doPostDashboard($request_data)
     {
@@ -278,11 +282,15 @@ class Dashboard extends Api
     }
 
     /**
+     * Create owner
+     * 
      * @url POST /owner
+     * @status 201
+     * 
+     * @param array $request_data
+     * 
      * @access protected
      * @class AccessControl {@permission PM_DASHBOARD}
-     * @param array $request_data
-     * @status 201
      */
     public function doPostOwner($request_data)
     {
@@ -315,11 +323,15 @@ class Dashboard extends Api
     }
 
     /**
+     * Create indicator.
+     * 
      * @url POST /indicator
+     * @status 201
+     * 
+     * @param array $request_data
+     * 
      * @access protected
      * @class AccessControl {@permission PM_DASHBOARD}
-     * @param array $request_data
-     * @status 201
      */
     public function doPostIndicator($request_data)
     {
@@ -374,9 +386,11 @@ class Dashboard extends Api
      * Post dashboards configuration by userUid
      *
      * @url POST /config/
+     * 
+     * @param array $request_data
+     * 
      * @access protected
      * @class AccessControl {@permission PM_DASHBOARD}
-     * @param array $request_data
      */
     public function doPostDashboardConfigByUsrUid($request_data)
     {

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

@@ -102,12 +102,18 @@ 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
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_USERS}
+     * 
      * @param string $dep_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPostAssignUser($dep_uid, array $request_data)
     {
@@ -179,13 +185,17 @@ class Department extends Api
     }
 
     /**
+     * Create a new department.
+     * 
      * @url POST
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_USERS}
+     * 
      * @param array $request_data
      * @param string $dep_title {@from body} {@min 1}
      * @return array
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_USERS}
      */
     public function doPost($request_data, $dep_title)
     {

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

@@ -85,10 +85,14 @@ class EmailServer extends Api
     }
 
     /**
+     * Test connection.
+     * 
      * @url POST /test-connection
+     * 
+     * @param array $request_data
+     * 
      * @access protected
      * @class AccessControl {@permission PM_SETUP_EMAIL}
-     * @param array $request_data
      */
     public function doPostTestConnection(array $request_data)
     {
@@ -104,11 +108,15 @@ class EmailServer extends Api
     }
 
     /**
+     * Create email server.
+     * 
      * @url POST
+     * @status 201
+     * 
+     * @param array $request_data
+     * 
      * @access protected
      * @class AccessControl {@permission PM_SETUP_EMAIL}
-     * @param array $request_data
-     * @status 201
      */
     public function doPost(array $request_data)
     {

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

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

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

@@ -73,11 +73,15 @@ class Group extends Api
     }
 
     /**
+     * Create a new group.
+     * 
      * @url POST
+     * @status 201
+     * 
+     * @param array $request_data
+     * 
      * @access protected
      * @class AccessControl {@permission PM_USERS}
-     * @param array $request_data
-     * @status 201
      */
     public function doPost($request_data)
     {

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

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

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

@@ -968,13 +968,15 @@ class Light extends Api
      * Execute Trigger case
      *
      * @url POST /process/:prj_uid/task/:act_uid/case/:cas_uid/step/:step_uid/execute-trigger/:type
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param string $prj_uid {@min 1}{@max 32}
      * @param string $act_uid {@min 1}{@max 32}
      * @param string $cas_uid {@min 1}{@max 32}
      * @param string $step_uid {@min 32}{@max 32}
      * @param string $type {@choice before,after}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPutExecuteTriggerCase($prj_uid, $act_uid, $cas_uid, $step_uid, $type)
     {
@@ -1132,11 +1134,18 @@ class Light extends Api
     }
 
     /**
+     * Starts a new case and assigns 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 of the initial task. Also note that the new case's status will be 
+     * set to "DRAFT", not "TO_DO".
+     * 
      * @url POST /process/:pro_uid/task/:task_uid/start-case
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param string $pro_uid {@min 32}{@max 32}
      * @param string $task_uid {@min 32}{@max 32}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function postStartCase($pro_uid, $task_uid)
     {
@@ -1228,12 +1237,17 @@ class Light extends Api
     }
 
     /**
+     * Generates a Google Maps .jpg image file for a case. This image can be found 
+     * in the Documents section under the Home tab.
+     * 
      * @url POST /case/:app_uid/upload/location
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param string $app_uid { @min 32}{@max 32}
      * @param float $latitude {@min -90}{@max 90}
      * @param float $longitude {@min -180}{@max 180}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function postInputDocumentLocation($app_uid, $latitude, $longitude)
     {
@@ -1271,10 +1285,14 @@ class Light extends Api
     }
 
     /**
+     * Generates a base64 string of a file.
+     * 
      * @url POST /case/:app_uid/download64
+     * 
+     * @param string $app_uid {@min 32}{@max 32}
+     * 
      * @access protected
      * @class AccessControl {@permission PM_CASES}
-     * @param string $app_uid {@min 32}{@max 32}
      */
     public function postDownloadFile($app_uid, $request_data)
     {
@@ -1370,12 +1388,24 @@ class Light extends Api
     }
 
     /**
+     * Creates new case file record(s) in a specified case. These case files can 
+     * be attached files (used by File controls), Input Document files, or Output Document 
+     * files in version 1.0.1.8 and later. In version 1.0.1.7 and earlier, the case 
+     * files can only be attached files. (Note that case files are known as AppDocuments 
+     * in ProcessMaker). This endpoint adds new record(s) to the APP_DOCUMENT table 
+     * and stores their file name(s) in the CONTENT table in the database. It returns 
+     * the generated case file ID and version number for each file. This information 
+     * can then be used to call the POST /light/case/{app_uid}/upload/{app_doc_uid} 
+     * endpoint to upload each file.
+     * 
      * @url POST /case/:app_uid/upload
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param $access
      * @param $refresh
      * @return mixed
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function uidUploadFiles($app_uid, $request_data)
     {
@@ -1391,12 +1421,24 @@ class Light extends Api
     }
 
     /**
+     * Creates new case file record(s) in a specified case. These case files can 
+     * be attached files (used by File controls), Input Document files, or Output Document 
+     * files in version 1.0.1.8 and later. In version 1.0.1.7 and earlier, the case 
+     * files can only be attached files. (Note that case files are known as AppDocuments 
+     * in ProcessMaker). This endpoint adds new record(s) to the APP_DOCUMENT table 
+     * and stores their file name(s) in the CONTENT table in the database. It returns 
+     * the generated case file ID and version number for each file. This information 
+     * can then be used to call the POST /light/case/{app_uid}/upload/{app_doc_uid} 
+     * endpoint to upload each file.
+     * 
      * @url POST /case/:app_uid/upload/:app_doc_uid
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param $access
      * @param $refresh
      * @return mixed
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function documentUploadFiles($app_uid, $app_doc_uid, $request_data)
     {
@@ -1412,11 +1454,15 @@ class Light extends Api
     }
 
     /**
+     * Assigns the user logged-in to an unassigned case.
+     * 
      * @url POST /case/:app_uid/claim
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param $app_uid {@min 1}{@max 32}
      * @return mixed
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function claimCaseUser($app_uid)
     {
@@ -1503,15 +1549,18 @@ class Light extends Api
     }
 
     /**
-     * Post Case Notes
+     * Creates 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 /case/:app_uid/note
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param string $app_uid {@min 1}{@max 32}
      * @param string $noteContent {@min 1}{@max 500}
      * @param int $sendMail {@choice 1,0}
-     * @copyright Colosa - Bolivia
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doPostCaseNote($app_uid, $noteContent, $sendMail = 0)
     {
@@ -1596,13 +1645,18 @@ class Light extends Api
     }
 
     /**
+     * Reassign a case.
+     * 
      * @url POST /reassign/:app_uid/user/:to_usr_uid
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_REASSIGNCASE, PM_REASSIGNCASE_SUPERVISOR}
      * @param string $app_uid {@min 1}{@max 32}
      * @param string $to_usr_uid {@min 1}{@max 32}
+     * 
      * @return stdclass
      * @throws RestException
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_REASSIGNCASE, PM_REASSIGNCASE_SUPERVISOR}
      */
     public function reassignCase($app_uid, $to_usr_uid)
     {
@@ -1621,11 +1675,14 @@ class Light extends Api
      * Paused Case
      *
      * @url POST /cases/:app_uid/pause
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param string $app_uid {@min 1}{@max 32}
+     * 
      * @return stdclass
      * @throws RestException
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function pauseCase($app_uid, $request_data)
     {
@@ -1645,11 +1702,14 @@ class Light extends Api
      * Unpaused Case
      *
      * @url POST /cases/:app_uid/unpause
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param string $app_uid {@min 1}{@max 32}
+     * 
      * @return stdclass
      * @throws RestException
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function unpauseCase($app_uid)
     {
@@ -1667,12 +1727,16 @@ class Light extends Api
     }
 
     /**
-     * Cancel Case
+     * Cancels a case assigned to the user logged-in. The case's status is changed 
+     * to "CANCELLED" and it is no longer possible to open or change the case, 
+     * but all the case data will remain in the database.
      *
      * @url POST /cases/:app_uid/cancel
+     * 
+     * @param string $cas_uid {@min 1}{@max 32}
+     * 
      * @access protected
      * @class AccessControl {@permission PM_CASES}
-     * @param string $cas_uid {@min 1}{@max 32}
      */
     public function doPutCancelCase($app_uid)
     {
@@ -1838,12 +1902,19 @@ class Light extends Api
     }
 
     /**
-     * Get next step
+     * This endpoint executes the following three actions:
+     * 1. Executes a trigger before a step: First, it executes any trigger assigned 
+     * before the indicated step.
+     * 2. Get the Next Step: It obtains the details about the next step of the case.
+     * 3. Get Variables: Finally, it returns any variable stored or changed by 
+     * actions 1 and 2.
      *
      * @url POST /get-next-step/:app_uid
+     * 
+     * @return array
+     * 
      * @access protected
      * @class AccessControl {@permission PM_CASES}
-     * @return array
      */
     public function doGetStep($app_uid, $request_data)
     {
@@ -1941,11 +2012,14 @@ class Light extends Api
      * the specified user.
      * 
      * @url POST /draft/check
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_CASES}
      * @param array $requestData
+     * 
      * @return array $response
      * @throws Exception
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_CASES}
      */
     public function doGetDraftCheck($requestData)
     {

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

@@ -64,10 +64,13 @@ class Process extends Api
     }
 
     /**
-     * @access protected
+     * Create process
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param array $request_data
      * @return array
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function post($request_data = null)
     {

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

@@ -92,14 +92,18 @@ class Assignee extends Api
     }
 
     /**
+     * Assigns a user or group to a task.
+     * 
      * @url POST /:prjUid/activity/:actUid/assignee
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @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
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityAssignee($prjUid, $actUid, $aas_uid, $aas_type)
     {
@@ -191,14 +195,18 @@ class Assignee extends Api
     }
 
     /**
+     * Assigns a user or group to a task on an ad hoc basis.
+     * 
      * @url POST /:prjUid/activity/:actUid/adhoc-assignee
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @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
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityAdhocAssignee($prjUid, $actUid, $ada_uid, $ada_type)
     {

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

@@ -34,9 +34,11 @@ class Step extends Api
     }
 
     /**
+     * Assigns a step to a task.
+     * 
      * @url POST /:prj_uid/activity/:act_uid/step
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $act_uid        {@min 32}{@max 32}
      * @param string $prj_uid        {@min 32}{@max 32}
      * @param array  $request_data
@@ -45,7 +47,9 @@ 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
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityStep(
         $act_uid,
@@ -218,9 +222,11 @@ class Step extends Api
     }
 
     /**
+     * Create Steps for a Task.
+     * 
      * @url POST /:prj_uid/activity/:act_uid/step/all
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $act_uid        {@min 32}{@max 32}
      * @param string $prj_uid        {@min 32}{@max 32}
      * @param array  $request_data
@@ -229,7 +235,9 @@ 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
+     * 
+     * @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,18 @@ class Trigger extends Api
     }
 
     /**
+     * Assigns a trigger to a step.
+     * 
      * @url POST /:prj_uid/activity/:act_uid/step/:step_uid/trigger
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $step_uid
      * @param string $act_uid
      * @param string $prj_uid
      * @param StepTriggerPostStructure $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityStepTrigger($step_uid, $act_uid, $prj_uid, StepTriggerPostStructure $request_data = null)
     {
@@ -122,13 +126,17 @@ class Trigger extends Api
     }
 
     /**
+     * Assigns a trigger to the "Assignment" or "Routing" step section of an activity.
+     * 
      * @url POST /:prj_uid/activity/:act_uid/step/trigger
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $act_uid
      * @param string $prj_uid
      * @param StepAssignTaskTriggerPostStructure $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostActivityStepAssignTaskTrigger($act_uid, $prj_uid, StepAssignTaskTriggerPostStructure $request_data = null)
     {

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

@@ -51,12 +51,16 @@ class CaseScheduler extends Api
     }
 
     /**
+     * Creates a new Case Scheduler. 
+     * 
      * @url POST /:prjUid/case-scheduler
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prjUid {@min 32} {@max 32}
      * @param CaseSchedulerStructure $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProjectCaseScheduler($prjUid, CaseSchedulerStructure $request_data =  null)
     {

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

@@ -31,16 +31,20 @@ class CaseTrackerObject extends Api
     }
 
     /**
+     * Assigns an object (Dynaform, Input Document, Output Document) to a case tracker.
+     * 
      * @url POST /:prj_uid/case-tracker/object
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @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
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostCaseTrackerObject(
         $prj_uid,

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

@@ -55,9 +55,10 @@ class DataBaseConnection extends Api
     }
 
     /**
+     * Tests a database connection with the provided settings.
+     * 
      * @url POST /:prj_uid/database-connection/test
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY}
      * @param string $prj_uid {@min 1} {@max 32}
      * @param array $request_data
      * @param string $dbs_type {@from body} {@required true}
@@ -68,6 +69,9 @@ class DataBaseConnection extends Api
      * @param string $dbs_password {@from body}
      * @param string $dbs_description {@from body}
      * @return array
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostTestDataBaseConnection(
         $prj_uid,
@@ -91,9 +95,11 @@ class DataBaseConnection extends Api
     }
 
     /**
+     * Creates a new database connection.
+     * 
      * @url POST /:prj_uid/database-connection
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid {@min 1} {@max 32}
      * @param array $request_data
      * @param string $dbs_type {@from body} {@required true}
@@ -104,7 +110,9 @@ class DataBaseConnection extends Api
      * @param string $dbs_password {@from body}
      * @param string $dbs_description {@from body}
      * @return array
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostDataBaseConnection(
         $prj_uid,

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

@@ -38,12 +38,16 @@ class DynaForm extends Api
     }
     
     /**
+     * Create dynaform.
+     * 
      * @url POST /:prj_uid/dynaform
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostDynaForm($prj_uid, $request_data)
     {
@@ -137,11 +141,15 @@ class DynaForm extends Api
     }
 
     /**
+     * Upload language for dynaform.
+     * 
      * @url POST /:prj_uid/dynaform/:dyn_uid/upload-language
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY}
      * @param string $dyn_uid {@min 32}{@max 32}
      * @param string $prj_uid {@min 32}{@max 32}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostDynaFormLanguage($dyn_uid, $prj_uid)
     {
@@ -155,11 +163,15 @@ class DynaForm extends Api
     }
 
     /**
+     * Delete language for dynaform.
+     * 
      * @url POST /:prj_uid/dynaform/:dyn_uid/delete-language/:lang
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY}
      * @param string $dyn_uid {@min 32}{@max 32}
      * @param string $prj_uid {@min 32}{@max 32}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doDeleteDynaFormLanguage($dyn_uid, $prj_uid, $lang)
     {
@@ -190,12 +202,16 @@ class DynaForm extends Api
     }
 
     /**
+     * DynaForm History.
+     * 
      * @url POST /:prj_uid/dynaform/:dyn_uid/history
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY}
      * @param string $dyn_uid {@min 32}{@max 32}
      * @param string $prj_uid {@min 32}{@max 32}
      * @param array  $request_data
+     * 
+     * @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

@@ -65,9 +65,11 @@ class EmailEvent extends Api
     
     /**
      * @url POST /:prj_uid/email-event
+     * 
+     * @param string $prj_uid {@min 1} {@max 32}
+     * 
      * @access protected
      * @class AccessControl {@permission PM_FACTORY}
-     * @param string $prj_uid {@min 1} {@max 32}
      */
     public function doPostEmailEvent($prj_uid, array $request_data)
     {

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

@@ -37,12 +37,16 @@ class FilesManager extends Api
     }
 
     /**
+     * Creates a file in the File Manager.
+     * 
      * @url POST /:prj_uid/file-manager
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY}
      * @param string $prj_uid {@min 32} {@max 32}
      * @param ProcessFilesManagerStructurePost $request_data
      * @param string $prf_content
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProcessFilesManager($prj_uid, ProcessFilesManagerStructurePost $request_data, $prf_content=null)
     {
@@ -62,11 +66,15 @@ class FilesManager extends Api
     }
 
     /**
+     * Uploads a document to the File Manager.
+     * 
      * @url POST /:prj_uid/file-manager/:prf_uid/upload
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY}
      * @param string $prj_uid {@min 32} {@max 32}
      * @param string $prf_uid {@min 32} {@max 32}
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProcessFilesManagerUpload($prj_uid, $prf_uid)
     {

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

@@ -33,12 +33,16 @@ class InputDocument extends Api
     }
 
     /**
+     * Create a new Input Document in a project.
+     * 
      * @url POST /:prj_uid/input-document
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostInputDocument($prj_uid, $request_data)
     {

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

@@ -80,12 +80,16 @@ class MessageEventDefinition extends Api
     }
 
     /**
+     * Create message event definition.
+     * 
      * @url POST /:prj_uid/message-event-definition
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostMessageEventDefinition($prj_uid, array $request_data)
     {

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

@@ -65,12 +65,16 @@ class MessageType extends Api
     }
 
     /**
+     * Create message type
+     * 
      * @url POST /:prj_uid/message-type
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostMessageType($prj_uid, array $request_data)
     {

workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType/Variable.php

@@ -68,12 +68,14 @@ class Variable extends Api
 
     /**
      * @url POST /:prj_uid/message-type/:msgt_uid/variable
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param string $msgt_uid     {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostMessageTypeVariable($prj_uid, $msgt_uid, array $request_data)
     {

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

@@ -51,12 +51,16 @@ class OutputDocuments extends Api
     }
 
     /**
+     * Create a new output document for a project.
+     * 
      * @url POST /:prjUid/output-document
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prjUid {@min 32} {@max 32}
      * @param OutputDocumentStructure $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProjectOutputDocument($prjUid, OutputDocumentStructure $request_data = null)
     {

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

@@ -58,9 +58,11 @@ class ProcessPermissions extends Api
     }
 
     /**
+     * Creates a new Process Permission for a project.
+     * 
      * @url POST /:prj_uid/process-permission/
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid {@min 1} {@max 32}
      * @param array $request_data
      * @param string $usr_uid {@from body} {@min 1} {@max 32}
@@ -75,7 +77,9 @@ class ProcessPermissions extends Api
      * @param string $inputs {@from body}
      * @param string $outputs {@from body}
      * @return array
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProcessPermission(
         $prj_uid,

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

@@ -234,13 +234,17 @@ class ProcessSupervisors extends Api
     }
 
     /**
+     * Assign a user or group as a process supervisor.
+     * 
      * @url POST /:prjUid/process-supervisor
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $usr_uid {@min 32} {@max 32}
      * @param string $pu_type {@choice SUPERVISOR,GROUP_SUPERVISOR}
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProcessSupervisor($prjUid, $usr_uid, $pu_type)
     {
@@ -257,13 +261,17 @@ class ProcessSupervisors extends Api
     }
 
     /**
+     * Assigns a Dynaform to a Process Supervisor.
+     * 
      * @url POST /:prjUid/process-supervisor/dynaform
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $dyn_uid {@min 32} {@max 32}
      * @param int $pud_position
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProcessSupervisorDynaform($prjUid, $dyn_uid, $pud_position = null)
     {
@@ -280,13 +288,17 @@ class ProcessSupervisors extends Api
     }
 
     /**
+     * Assigns an input document to a Process Supervisor.
+     * 
      * @url POST /:prjUid/process-supervisor/input-document
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prjUid {@min 32} {@max 32}
      * @param string $inp_doc_uid {@min 32} {@max 32}
      * @param int $pui_position
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProcessSupervisorInputDocument($prjUid, $inp_doc_uid, $pui_position = null)
     {

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

@@ -70,12 +70,16 @@ class ProjectUsers extends Api
     }
 
     /**
+     * Return the user that can start a task.
+     * 
      * @url POST /:prj_uid/ws/user/can-start-task
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY}
      * @param string $prj_uid {@min 32} {@max 32}
      * @param string $act_uid {@min 32} {@max 32}
      * @param wsUserCanStartTaskStructure $request_data
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostProjectWsUserCanStartTask($prj_uid, $act_uid = null, wsUserCanStartTaskStructure $request_data =  null)
     {

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

@@ -95,9 +95,11 @@ class ReportTable extends Api
     }
 
     /**
+     * Creates a new Report Table.
+     * 
      * @url POST /:prj_uid/report-table
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid {@min 1} {@max 32}
      * @param array $request_data
      * @param string $rep_tab_name {@from body}
@@ -106,7 +108,9 @@ class ReportTable extends Api
      * @param string $rep_tab_type {@from body} {@choice NORMAL,GRID}
      * @param string $rep_tab_grid {@from body}
      * @return array
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostReportTable(
         $prj_uid,

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

@@ -80,12 +80,16 @@ class ScriptTask extends Api
     }
 
     /**
+     * Create script task for a project.
+     * 
      * @url POST /:prj_uid/script-task
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostScriptTask($prj_uid, array $request_data)
     {

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

@@ -86,12 +86,16 @@ class TimerEvent extends Api
     }
 
     /**
+     * Create timer event for a project.
+     * 
      * @url POST /:prj_uid/timer-event
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostTimerEvent($prj_uid, array $request_data)
     {

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

@@ -55,9 +55,11 @@ class Trigger extends Api
     }
 
     /**
+     * Create a new trigger in a project.
+     * 
      * @url POST /:projectUid/trigger
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $projectUid {@min 1} {@max 32}
      * @param array $request_data
      * @param string $tri_title {@from body} {@min 1}
@@ -66,7 +68,9 @@ class Trigger extends Api
      * @param string $tri_webbot {@from body}
      * @param string $tri_param {@from body}
      * @return array
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostTrigger($projectUid, $request_data, $tri_title, $tri_description = '', $tri_type = 'SCRIPT', $tri_webbot = '', $tri_param = '')
     {

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

@@ -66,14 +66,18 @@ class TriggerWizard extends Api
     }
 
     /**
+     * Create Trigger for a Process
+     * 
      * @url POST /:prj_uid/trigger-wizard/:lib_name/:fn_name
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param string $lib_name
      * @param string $fn_name
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostTriggerWizard($prj_uid, $lib_name, $fn_name, $request_data)
     {

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

@@ -48,12 +48,16 @@ class Variable extends Api
     }
 
     /**
+     * Create a process variable.
+     * 
      * @url POST /:prj_uid/process-variable
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostVariable($prj_uid, $request_data)
     {
@@ -109,12 +113,18 @@ class Variable extends Api
     }
 
     /**
+     * Executes an SQL query of a dependent field, such as a dropdown box, checkgroup 
+     * or radiogroup, that uses an SQL query with one or more dynamic variables 
+     * to populate its list of options.
+     * 
      * @url POST /:prj_uid/process-variable/:var_name/execute-query
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY, PM_CASES}
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param string $var_name
      * @param array  $request_data
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY, PM_CASES}
      */
     public function doPostVariableExecuteSql($prj_uid, $var_name = '', $request_data = array())
     {
@@ -132,12 +142,18 @@ class Variable extends Api
     }
 
     /**
+     * Queries the options in a suggest box, dropdown box, checkgroup or radiogroup, 
+     * which uses an SQL query to populate its list of options (or uses a datasource 
+     * which is "array variable" in version 3.0.1.8 or later).
+     * 
      * @url POST /:prj_uid/process-variable/:var_name/execute-query-suggest
-     * @access protected
+     * 
-     * @class AccessControl {@permission PM_FACTORY, PM_CASES}
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param string $var_name
      * @param array  $request_data
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY, PM_CASES}
      */
     public function doPostVariableExecuteSqlSuggest($prj_uid, $var_name, $request_data)
     {

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

@@ -71,12 +71,16 @@ class WebEntry extends Api
     }
 
     /**
+     * Creates a new Web Entry using the method "PHP pages with Web Services".
+     * 
      * @url POST /:prj_uid/web-entry
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostWebEntry($prj_uid, array $request_data)
     {

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

@@ -88,12 +88,16 @@ class WebEntryEvent extends Api
     }
 
     /**
+     * Create web entry event for a project.
+     * 
      * @url POST /:prj_uid/web-entry-event
-     * @access protected
+     * @status 201
-     * @class AccessControl {@permission PM_FACTORY}
+     * 
      * @param string $prj_uid      {@min 32}{@max 32}
      * @param array  $request_data
-     * @status 201
+     * 
+     * @access protected
+     * @class AccessControl {@permission PM_FACTORY}
      */
     public function doPostWebEntryEvent($prj_uid, array $request_data)
     {