fernando/luos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
Feature/HOR-3965

Approved-by: Paula Quispe <paula.quispe@processmaker.com>
This commit is contained in:
Paula Quispe
2017-10-20 23:17:35 +00:00
parent c7480418f2 f6eb465ea1
commit e7ca3e6887
54 changed files with 1280 additions and 442 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
workflow/engine/src/ProcessMaker/BusinessModel/Catalog.php
View File

@@ -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;
}

14
workflow/engine/src/ProcessMaker/Services/Api/ActionsByEmail.php
View File

@@ -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)
{

10
workflow/engine/src/ProcessMaker/Services/Api/Calendar.php
View File

@@ -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)
{

130
workflow/engine/src/ProcessMaker/Services/Api/Cases.php
View File

@@ -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)
{

17
workflow/engine/src/ProcessMaker/Services/Api/Cases/InputDocument.php
View File

@@ -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)
{

19
workflow/engine/src/ProcessMaker/Services/Api/Cases/OutputDocument.php
View File

@@ -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)
{

23
workflow/engine/src/ProcessMaker/Services/Api/Cases/Variable.php
View File

@@ -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}

45
workflow/engine/src/ProcessMaker/Services/Api/Catalog.php
View File

@@ -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()));
}
}
}

24
workflow/engine/src/ProcessMaker/Services/Api/Consolidated.php
View File

@@ -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 = '')
{

83
workflow/engine/src/ProcessMaker/Services/Api/Dashboard.php
View File

@@ -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)
{

45
workflow/engine/src/ProcessMaker/Services/Api/Department.php
View File

@@ -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}
*

33
workflow/engine/src/ProcessMaker/Services/Api/EmailServer.php
View File

@@ -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}
*

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

@@ -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)
{

22
workflow/engine/src/ProcessMaker/Services/Api/Group.php
View File

@@ -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}
*/

28
workflow/engine/src/ProcessMaker/Services/Api/Group/User.php
View File

@@ -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}

208
workflow/engine/src/ProcessMaker/Services/Api/Light.php
View File

@@ -796,24 +796,24 @@ class Light extends Api
/**
* Delete case
*
* @copyright Colosa - Bolivia
*
* @url DELETE /case/:app_uid/delete
* @access protected
* @class AccessControl {@permission PM_CASES}
*
* @param string $app_uid {@min 32}{@max 32}
*/
public function doDeleteCases($app_uid)
{
try {
$oCase = new ClassesCases();
$oCase->removeCase($app_uid);
$usr_uid = $this->getUserId();
$cases = new BusinessModelCases();
$cases->deleteCase($app_uid, $usr_uid);
$result = array(
"message" => G::LoadTranslation("ID_COMMAND_EXECUTED_SUCCESSFULLY")
);
} catch (Exception $e) {
throw (new RestException(Api::STAT_APP_EXCEPTION, $e->getMessage()));
}
return $result;
}
@@ -967,15 +967,19 @@ class Light extends Api
/**
* Execute Trigger case
*
* @url POST /process/:prj_uid/task/:act_uid/case/:cas_uid/step/:step_uid/execute-trigger/:type
*
* @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}
*
* @copyright Colosa - Bolivia
*
* @url POST /process/:prj_uid/task/:act_uid/case/:cas_uid/step/:step_uid/execute-trigger/:type
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doPutExecuteTriggerCase($prj_uid, $act_uid, $cas_uid, $step_uid, $type)
{
@@ -1133,10 +1137,21 @@ class Light extends Api
}
/**
* Starts 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 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
*
*
* @param string $pro_uid {@min 32}{@max 32}
* @param string $task_uid {@min 32}{@max 32}
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function postStartCase($pro_uid, $task_uid)
{
@@ -1175,11 +1190,18 @@ class Light extends Api
/**
* Route Case
*
* @url PUT /cases/:app_uid/route-case
*
* @param string $app_uid {@min 32}{@max 32}
* @param int $del_index {@from body}
* @param array $tasks {@from body}
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doPutRouteCase($app_uid, $del_index = null, $tasks = array())
{
@@ -1228,11 +1250,20 @@ 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
*
*
* @param string $app_uid { @min 32}{@max 32}
* @param float $latitude {@min -90}{@max 90}
* @param float $longitude {@min -180}{@max 180}
*
* @return mixed
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function postInputDocumentLocation($app_uid, $latitude, $longitude)
{
@@ -1270,9 +1301,17 @@ 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}
*
* @return mixed
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function postDownloadFile($app_uid, $request_data)
{
@@ -1368,11 +1407,26 @@ 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
*
*
* @param $access
* @param $refresh
*
* @return mixed
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function uidUploadFiles($app_uid, $request_data)
{
@@ -1388,11 +1442,26 @@ 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
*
*
* @param $access
* @param $refresh
*
* @return mixed
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function documentUploadFiles($app_uid, $app_doc_uid, $request_data)
{
@@ -1408,10 +1477,17 @@ class Light extends Api
}
/**
* Assign the user logged-in to an unassigned case.
*
* @url POST /case/:app_uid/claim
*
*
* @param $app_uid {@min 1}{@max 32}
*
* @return mixed
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function claimCaseUser($app_uid)
{
@@ -1498,15 +1574,21 @@ 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
*
* @param string $app_uid {@min 1}{@max 32}
* @param string $noteContent {@min 1}{@max 500}
* @param int $sendMail {@choice 1,0}
*
* @copyright Colosa - Bolivia
*
* @url POST /case/:app_uid/note
*
* @return mixed
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doPostCaseNote($app_uid, $noteContent, $sendMail = 0)
{
@@ -1591,13 +1673,18 @@ class Light extends Api
}
/**
* @return stdclass
* @throws RestException
*
* Reassign a case.
*
* @url POST /reassign/:app_uid/user/:to_usr_uid
*
* @param string $app_uid {@min 1}{@max 32}
* @param string $to_usr_uid {@min 1}{@max 32}
*
* @url POST /reassign/:app_uid/user/:to_usr_uid
*
* @return stdclass
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_REASSIGNCASE, PM_REASSIGNCASE_SUPERVISOR}
*/
public function reassignCase($app_uid, $to_usr_uid)
{
@@ -1615,12 +1702,15 @@ class Light extends Api
/**
* Paused Case
*
* @url POST /cases/:app_uid/pause
*
* @param string $app_uid {@min 1}{@max 32}
*
* @return stdclass
* @throws RestException
*
* @param string $app_uid {@min 1}{@max 32}
*
* @url POST /cases/:app_uid/pause
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function pauseCase($app_uid, $request_data)
{
@@ -1639,12 +1729,15 @@ class Light extends Api
/**
* Unpaused Case
*
* @return stdclass
* @throws RestException
*
* @param string $app_uid {@min 1}{@max 32}
*
* @url POST /cases/:app_uid/unpause
*
* @param string $app_uid {@min 1}{@max 32}
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function unpauseCase($app_uid)
{
@@ -1662,13 +1755,19 @@ class Light extends Api
}
/**
* Cancel Case
*
* @param string $cas_uid {@min 1}{@max 32}
*
* @copyright Colosa - Bolivia
* 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}
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doPutCancelCase($app_uid)
{
@@ -1716,12 +1815,17 @@ class Light 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}
*
* @url PUT /:app_uid/variable
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doPutCaseVariables($app_uid, $request_data, $dyn_uid = '', $del_index = 0)
{
@@ -1834,10 +1938,23 @@ 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
*
* @param string $app_uid
* @param array $request_data
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doGetStep($app_uid, $request_data)
{
@@ -1931,11 +2048,18 @@ class Light extends Api
}
/**
* This function checks if the application uids sent are in the draft list for the specified user
* This function checks if the application uids sent are in the draft list for
* the specified user.
*
* @url POST /draft/check
*
* @param array $requestData
*
* @return array $response
* @throws Exception
*
* @access protected
* @class AccessControl {@permission PM_CASES}
*/
public function doGetDraftCheck($requestData)
{

14
workflow/engine/src/ProcessMaker/Services/Api/Light/NotificationDevice.php
View File

@@ -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)
{

26
workflow/engine/src/ProcessMaker/Services/Api/Pmtable.php
View File

@@ -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,

23
workflow/engine/src/ProcessMaker/Services/Api/Process.php
View File

@@ -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();

12
workflow/engine/src/ProcessMaker/Services/Api/ProcessCategory.php
View File

@@ -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)
{

23
workflow/engine/src/ProcessMaker/Services/Api/Project/Activity.php
View File

@@ -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())
{

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

@@ -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}

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

@@ -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,

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

@@ -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

27
workflow/engine/src/ProcessMaker/Services/Api/Project/CaseScheduler.php
View File

@@ -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}
*

7
workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTracker.php
View File

@@ -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,

22
workflow/engine/src/ProcessMaker/Services/Api/Project/CaseTrackerObject.php
View File

@@ -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}

54
workflow/engine/src/ProcessMaker/Services/Api/Project/DataBaseConnection.php
View File

@@ -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)
{

47
workflow/engine/src/ProcessMaker/Services/Api/Project/DynaForm.php
View File

@@ -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)
{

22
workflow/engine/src/ProcessMaker/Services/Api/Project/EmailEvent.php
View File

@@ -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}

24
workflow/engine/src/ProcessMaker/Services/Api/Project/Event.php
View File

@@ -139,6 +139,10 @@ class Event extends Api
}
/**
* Update event.
*
* @url PUT /:prj_uid/event/:evn_uid
*
* @param string $prj_uid {@min 1} {@max 32}
* @param string $evn_uid {@min 1} {@max 32}
* @param array $request_data
@@ -156,13 +160,11 @@ class Event extends Api
* @param string $evn_tas_uid_to {@from body}
* @param string $evn_conditions {@from body}
*
* @access public
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @return void
* @throws RestException
*
* @url PUT /:prj_uid/event/:evn_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutEvent (
$prj_uid,
@@ -201,17 +203,13 @@ class Event extends Api
}
/**
* @url DELETE /:prj_uid/event/:evn_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 1} {@max 32}
* @param string $evn_uid {@min 1} {@max 32}
* @return void
*
* @access public
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @return void
*
* @url DELETE /:prj_uid/event/:evn_uid
*/
public function doDeleteEvent($prj_uid, $evn_uid)
{

46
workflow/engine/src/ProcessMaker/Services/Api/Project/FilesManager.php
View File

@@ -37,11 +37,19 @@ class FilesManager extends Api
}
/**
* Creates a file in the File Manager.
*
* @url POST /:prj_uid/file-manager
*
* @param string $prj_uid {@min 32} {@max 32}
* @param ProcessFilesManagerStructurePost $request_data
* @param string $prf_content
*
* @url POST /:prj_uid/file-manager
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostProcessFilesManager($prj_uid, ProcessFilesManagerStructurePost $request_data, $prf_content=null)
{
@@ -61,10 +69,18 @@ class FilesManager extends Api
}
/**
* Uploads a document to the File Manager.
*
* @url POST /:prj_uid/file-manager/:prf_uid/upload
*
* @param string $prj_uid {@min 32} {@max 32}
* @param string $prf_uid {@min 32} {@max 32}
*
* @url POST /:prj_uid/file-manager/:prf_uid/upload
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostProcessFilesManagerUpload($prj_uid, $prf_uid)
{
@@ -80,11 +96,19 @@ class FilesManager extends Api
}
/**
* Update process files manager
*
* @url PUT /:prj_uid/file-manager/:prf_uid
*
* @param string $prj_uid {@min 32} {@max 32}
* @param ProcessFilesManagerStructure $request_data
* @param string $prf_uid {@min 32} {@max 32}
*
* @url PUT /:prj_uid/file-manager/:prf_uid
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutProcessFilesManager($prj_uid, ProcessFilesManagerStructure $request_data, $prf_uid)
{
@@ -103,10 +127,12 @@ class FilesManager extends Api
}
/**
* @url DELETE /:prj_uid/file-manager/:prf_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32} {@max 32}
* @param string $prf_uid {@min 32} {@max 32}
*
* @url DELETE /:prj_uid/file-manager/:prf_uid
*/
public function doDeleteProcessFilesManager($prj_uid, $prf_uid)
{
@@ -137,10 +163,12 @@ class FilesManager extends Api
}
/**
* @url DELETE /:prj_uid/file-manager/folder
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32} {@max 32}
* @param string $path
*
* @url DELETE /:prj_uid/file-manager/folder
*/
public function doDeleteFolderProcessFilesManager($prj_uid, $path)
{

22
workflow/engine/src/ProcessMaker/Services/Api/Project/InputDocument.php
View File

@@ -33,12 +33,19 @@ class InputDocument extends Api
}
/**
* Create a new Input Document in a project.
*
* @url POST /:prj_uid/input-document
*
* @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 doPostInputDocument($prj_uid, $request_data)
{
@@ -58,11 +65,18 @@ class InputDocument extends Api
}
/**
* Update input document.
*
* @url PUT /:prj_uid/input-document/:inp_doc_uid
*
* @param string $inp_doc_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 doPutInputDocument($inp_doc_uid, $prj_uid, $request_data)
{
@@ -79,6 +93,8 @@ class InputDocument extends Api
/**
* @url DELETE /:prj_uid/input-document/:inp_doc_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $inp_doc_uid {@min 32}{@max 32}
* @param string $prj_uid {@min 32}{@max 32}

22
workflow/engine/src/ProcessMaker/Services/Api/Project/MessageEventDefinition.php
View File

@@ -80,12 +80,19 @@ class MessageEventDefinition extends Api
}
/**
* Create message event definition.
*
* @url POST /:prj_uid/message-event-definition
*
* @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 doPostMessageEventDefinition($prj_uid, array $request_data)
{
@@ -101,11 +108,18 @@ class MessageEventDefinition extends Api
}
/**
* Update message event definition.
*
* @url PUT /:prj_uid/message-event-definition/:msged_uid
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $msged_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutMessageEventDefinition($prj_uid, $msged_uid, array $request_data)
{
@@ -118,6 +132,8 @@ class MessageEventDefinition extends Api
/**
* @url DELETE /:prj_uid/message-event-definition/:msged_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $msged_uid {@min 32}{@max 32}

22
workflow/engine/src/ProcessMaker/Services/Api/Project/MessageType.php
View File

@@ -65,12 +65,19 @@ class MessageType extends Api
}
/**
* Create message type
*
* @url POST /:prj_uid/message-type
*
* @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 doPostMessageType($prj_uid, array $request_data)
{
@@ -86,11 +93,18 @@ class MessageType extends Api
}
/**
* Update message type.
*
* @url PUT /:prj_uid/message-type/:msgt_uid
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $msgt_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutMessageType($prj_uid, $msgt_uid, array $request_data)
{
@@ -103,6 +117,8 @@ class MessageType extends Api
/**
* @url DELETE /:prj_uid/message-type/:msgt_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $msgt_uid {@min 32}{@max 32}

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

@@ -67,13 +67,20 @@ class Variable extends Api
}
/**
* Return data of the new Message created.
*
* @url POST /:prj_uid/message-type/:msgt_uid/variable
*
* @status 201
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $msgt_uid {@min 32}{@max 32}
* @param array $request_data
*
* @status 201
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostMessageTypeVariable($prj_uid, $msgt_uid, array $request_data)
{
@@ -89,12 +96,19 @@ class Variable extends Api
}
/**
* Update message type variable.
*
* @url PUT /:prj_uid/message-type/:msgt_uid/variable/:msgtv_uid
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $msgt_uid {@min 32}{@max 32}
* @param string $msgtv_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutMessageTypeVariable($prj_uid, $msgt_uid, $msgtv_uid, array $request_data)
{
@@ -106,7 +120,9 @@ class Variable extends Api
}
/**
* @url DELETE /:prj_uid/message-type/:msgt_uid/variable/:msgtv_uid
* @url DELETE /:prj_uid/user/message-type/:msgt_uid/variable/:msgtv_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $msgt_uid {@min 32}{@max 32}

22
workflow/engine/src/ProcessMaker/Services/Api/Project/OutputDocuments.php
View File

@@ -51,12 +51,19 @@ class OutputDocuments extends Api
}
/**
* Create a new output document for a project.
*
* @url POST /:prjUid/output-document
*
* @status 201
*
* @param string $prjUid {@min 32} {@max 32}
* @param OutputDocumentStructure $request_data
*
* @status 201
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostProjectOutputDocument($prjUid, OutputDocumentStructure $request_data = null)
{
@@ -74,12 +81,18 @@ class OutputDocuments extends Api
}
/**
* Update project output document.
*
* @url PUT /:prjUid/output-document/:outputDocumentUid
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $outputDocumentUid {@min 32} {@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutProjectOutputDocument($prjUid, $outputDocumentUid, $request_data)
{
@@ -95,6 +108,9 @@ class OutputDocuments extends Api
/**
* @url DELETE /:prjUid/output-document/:outputDocumentUid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $outputDocumentUid {@min 32} {@max 32}
*

39
workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessPermissions.php
View File

@@ -58,9 +58,13 @@ class ProcessPermissions extends Api
}
/**
* Creates a new Process Permission for a project.
*
* @url POST /:prj_uid/process-permission/
* @status 201
*
* @param string $prj_uid {@min 1} {@max 32}
* @param array $request_data
*
* @param string $usr_uid {@from body} {@min 1} {@max 32}
* @param string $op_user_relation {@from body} {@choice 1,2}
* @param string $op_case_status {@from body} {@choice ALL,DRAFT,TO_DO,PAUSED,COMPLETED}
@@ -72,14 +76,12 @@ class ProcessPermissions extends Api
* @param string $dynaforms {@from body}
* @param string $inputs {@from body}
* @param string $outputs {@from body}
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
*
* @return array
*
* @url POST /:prj_uid/process-permission/
* @status 201
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostProcessPermission(
$prj_uid,
@@ -115,10 +117,13 @@ class ProcessPermissions extends Api
}
/**
* Update process permisson.
*
* @url PUT /:prj_uid/process-permission/:ob_uid
*
* @param string $prj_uid {@min 1} {@max 32}
* @param string $ob_uid {@min 1} {@max 32}
* @param array $request_data
*
* @param string $usr_uid {@from body} {@min 1} {@max 32}
* @param string $op_user_relation {@from body} {@choice 1,2}
* @param string $op_case_status {@from body} {@choice ALL,DRAFT,TO_DO,PAUSED,COMPLETED}
@@ -131,12 +136,11 @@ class ProcessPermissions extends Api
* @param string $inputs {@from body}
* @param string $outputs {@from body}
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @return array
* @throws RestException
*
* @url PUT /:prj_uid/process-permission/:ob_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutProcessPermission(
$prj_uid,
@@ -165,15 +169,14 @@ class ProcessPermissions extends Api
}
/**
* @url DELETE /:prj_uid/process-permission/:ob_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 1} {@max 32}
* @param string $ob_uid {@min 1} {@max 32}
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @return void
*
* @url DELETE /:prj_uid/process-permission/:ob_uid
*/
public function doDeleteProcessPermission($prj_uid, $ob_uid)
{

62
workflow/engine/src/ProcessMaker/Services/Api/Project/ProcessSupervisors.php
View File

@@ -234,13 +234,20 @@ class ProcessSupervisors extends Api
}
/**
* Assign a user or group as a process supervisor.
*
* @url POST /:prjUid/process-supervisor
*
* @status 201
*
* @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
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostProcessSupervisor($prjUid, $usr_uid, $pu_type)
{
@@ -257,13 +264,20 @@ class ProcessSupervisors extends Api
}
/**
* Assign a Dynaform to a Process Supervisor.
*
* @url POST /:prjUid/process-supervisor/dynaform
*
* @status 201
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $dyn_uid {@min 32} {@max 32}
* @param int $pud_position
*
* @status 201
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostProcessSupervisorDynaform($prjUid, $dyn_uid, $pud_position = null)
{
@@ -280,13 +294,20 @@ class ProcessSupervisors extends Api
}
/**
* Assign an input document to a Process Supervisor.
*
* @url POST /:prjUid/process-supervisor/input-document
*
* @status 201
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $inp_doc_uid {@min 32} {@max 32}
* @param int $pui_position
*
* @status 201
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostProcessSupervisorInputDocument($prjUid, $inp_doc_uid, $pui_position = null)
{
@@ -304,6 +325,8 @@ class ProcessSupervisors extends Api
/**
* @url DELETE /:prjUid/process-supervisor/:puUid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $puUid {@min 32} {@max 32}
@@ -322,6 +345,8 @@ class ProcessSupervisors extends Api
/**
* @url DELETE /:prjUid/process-supervisor/dynaform/:pudUid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $pudUid {@min 32} {@max 32}
@@ -340,6 +365,8 @@ class ProcessSupervisors extends Api
/**
* @url DELETE /:prjUid/process-supervisor/input-document/:puiUid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $puiUid {@min 32} {@max 32}
@@ -357,13 +384,19 @@ class ProcessSupervisors extends Api
}
/**
* Update process supervisor dynaform.
*
* @url PUT /:prjUid/process-supervisor/dynaform/:pud_uid
* @status 201
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $pud_uid {@min 32} {@max 32}
* @param int $pud_position
*
* @status 201
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutProcessSupervisorDynaform($prjUid, $pud_uid, $pud_position = null)
{
@@ -380,13 +413,20 @@ class ProcessSupervisors extends Api
}
/**
* Update process supervisor input document.
*
* @url PUT /:prjUid/process-supervisor/input-document/:pui_uid
* @status 201
*
* @param string $prjUid {@min 32} {@max 32}
* @param string $pui_uid {@min 32} {@max 32}
* @param int $pui_position
*
* @status 201
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutProcessSupervisorInputDocument($prjUid, $pui_uid, $pui_position = null)
{

12
workflow/engine/src/ProcessMaker/Services/Api/Project/ProjectUsers.php
View File

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

38
workflow/engine/src/ProcessMaker/Services/Api/Project/ReportTable.php
View File

@@ -95,21 +95,24 @@ class ReportTable extends Api
}
/**
* Creates a new Report Table.
*
* @url POST /:prj_uid/report-table
* @status 201
*
* @param string $prj_uid {@min 1} {@max 32}
* @param array $request_data
*
* @param string $rep_tab_name {@from body}
* @param string $rep_tab_dsc {@from body}
* @param string $rep_tab_connection {@from body}
* @param string $rep_tab_type {@from body} {@choice NORMAL,GRID}
* @param string $rep_tab_grid {@from body}
*
* @return array
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @url POST /:prj_uid/report-table
* @status 201
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostReportTable(
$prj_uid,
@@ -133,17 +136,20 @@ class ReportTable extends Api
}
/**
* Update report table.
*
* @url PUT /:prj_uid/report-table/:rep_uid
*
* @param string $prj_uid {@min 1} {@max 32}
* @param string $rep_uid {@min 1} {@max 32}
* @param array $request_data
*
* @param string $rep_tab_dsc {@from body}
*
* @return void
* @throws RestException
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @url PUT /:prj_uid/report-table/:rep_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutReportTable(
$prj_uid,
@@ -161,14 +167,14 @@ class ReportTable extends Api
}
/**
* @url DELETE /:prj_uid/report-table/:rep_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 1} {@max 32}
* @param string $rep_uid {@min 1} {@max 32}
* @return void
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @url DELETE /:prj_uid/report-table/:rep_uid
*/
public function doDeleteReportTable($prj_uid, $rep_uid)
{

22
workflow/engine/src/ProcessMaker/Services/Api/Project/ScriptTask.php
View File

@@ -80,12 +80,19 @@ class ScriptTask extends Api
}
/**
* Create script task for a project.
*
* @url POST /:prj_uid/script-task
*
* @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 doPostScriptTask($prj_uid, array $request_data)
{
@@ -101,11 +108,18 @@ class ScriptTask extends Api
}
/**
* Update script task.
*
* @url PUT /:prj_uid/script-task/:scrtas_uid
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $scrtas_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutScriptTask($prj_uid, $scrtas_uid, array $request_data)
{
@@ -118,6 +132,8 @@ class ScriptTask extends Api
/**
* @url DELETE /:prj_uid/script-task/:scrtas_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $scrtas_uid {@min 32}{@max 32}

11
workflow/engine/src/ProcessMaker/Services/Api/Project/SubProcess.php
View File

@@ -43,16 +43,19 @@ class Subprocess extends Api
}
/**
* Update subprocess.
*
* @url PUT /:prj_uid/subprocess/:tas_uid
*
* @param string $prj_uid {@min 1} {@max 32}
* @param string $tas_uid {@min 1} {@max 32}
* @param array $request_data
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @return void
* @throws RestException
*
* @url PUT /:prj_uid/subprocess/:tas_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutSubprocess($prj_uid, $tas_uid, $request_data)
{

22
workflow/engine/src/ProcessMaker/Services/Api/Project/TimerEvent.php
View File

@@ -86,12 +86,19 @@ class TimerEvent extends Api
}
/**
* Create timer event for a project.
*
* @url POST /:prj_uid/timer-event
*
* @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 doPostTimerEvent($prj_uid, array $request_data)
{
@@ -109,11 +116,18 @@ class TimerEvent extends Api
}
/**
* Update timer event.
*
* @url PUT /:prj_uid/timer-event/:tmrevn_uid
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $tmrevn_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutTimerEvent($prj_uid, $tmrevn_uid, array $request_data)
{
@@ -128,6 +142,8 @@ class TimerEvent extends Api
/**
* @url DELETE /:prj_uid/timer-event/:tmrevn_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $tmrevn_uid {@min 32}{@max 32}

36
workflow/engine/src/ProcessMaker/Services/Api/Project/Trigger.php
View File

@@ -55,6 +55,11 @@ class Trigger extends Api
}
/**
* Create a new trigger in a project.
*
* @url POST /:projectUid/trigger
* @status 201
*
* @param string $projectUid {@min 1} {@max 32}
* @param array $request_data
* @param string $tri_title {@from body} {@min 1}
@@ -62,13 +67,12 @@ class Trigger extends Api
* @param string $tri_type {@from body}
* @param string $tri_webbot {@from body}
* @param string $tri_param {@from body}
*
* @return array
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @url POST /:projectUid/trigger
* @status 201
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostTrigger($projectUid, $request_data, $tri_title, $tri_description = '', $tri_type = 'SCRIPT', $tri_webbot = '', $tri_param = '')
{
@@ -82,6 +86,10 @@ class Trigger extends Api
}
/**
* Update trigger.
*
* @url PUT /:projectUid/trigger/:triggerUid
*
* @param string $projectUid {@min 1} {@max 32}
* @param string $triggerUid {@min 1} {@max 32}
* @param array $request_data
@@ -90,12 +98,12 @@ class Trigger extends Api
* @param string $tri_type {@from body}
* @param string $tri_webbot {@from body}
* @param string $tri_param {@from body}
*
* @return void
* @throws RestException
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @url PUT /:projectUid/trigger/:triggerUid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutTrigger($projectUid, $triggerUid, $request_data, $tri_title = '', $tri_description = '', $tri_type = 'SCRIPT', $tri_webbot = '', $tri_param = '')
{
@@ -109,14 +117,14 @@ class Trigger extends Api
}
/**
* @url DELETE /:projectUid/trigger/:triggerUid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $projectUid {@min 1} {@max 32}
* @param string $triggerUid {@min 1} {@max 32}
* @return void
*
* @author Brayan Pereyra (Cochalo) <brayan@colosa.com>
* @copyright Colosa - Bolivia
*
* @url DELETE /:projectUid/trigger/:triggerUid
*/
public function doDeleteTrigger($projectUid, $triggerUid)
{

20
workflow/engine/src/ProcessMaker/Services/Api/Project/TriggerWizard.php
View File

@@ -66,14 +66,21 @@ class TriggerWizard extends Api
}
/**
* Create Trigger for a Process
*
* @url POST /:prj_uid/trigger-wizard/:lib_name/:fn_name
*
* @status 201
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $lib_name
* @param string $fn_name
* @param array $request_data
*
* @status 201
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPostTriggerWizard($prj_uid, $lib_name, $fn_name, $request_data)
{
@@ -93,6 +100,8 @@ class TriggerWizard extends Api
}
/**
* Update trigger wizard.
*
* @url PUT /:prj_uid/trigger-wizard/:lib_name/:fn_name/:tri_uid
*
* @param string $prj_uid {@min 32}{@max 32}
@@ -100,6 +109,11 @@ class TriggerWizard extends Api
* @param string $fn_name
* @param string $tri_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutTriggerWizard($prj_uid, $lib_name, $fn_name, $tri_uid, $request_data)
{

46
workflow/engine/src/ProcessMaker/Services/Api/Project/Variable.php
View File

@@ -48,12 +48,19 @@ class Variable extends Api
}
/**
* Create a process variable.
*
* @url POST /:prj_uid/process-variable
*
* @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 doPostVariable($prj_uid, $request_data)
{
@@ -72,11 +79,18 @@ class Variable extends Api
}
/**
* Update variable.
*
* @url PUT /:prj_uid/process-variable/:var_uid
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $var_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutVariable($prj_uid, $var_uid, array $request_data)
{
@@ -93,6 +107,8 @@ class Variable extends Api
/**
* @url DELETE /:prj_uid/process-variable/:var_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $var_uid {@min 32}{@max 32}
@@ -109,11 +125,21 @@ 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
*
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $var_name
* @param array $request_data
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY, PM_CASES}
*/
public function doPostVariableExecuteSql($prj_uid, $var_name = '', $request_data = array())
{
@@ -131,11 +157,21 @@ class Variable extends Api
}
/**
* Gets 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
*
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $var_name
* @param array $request_data
*
* @return array
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY, PM_CASES}
*/
public function doPostVariableExecuteSqlSuggest($prj_uid, $var_name, $request_data)
{

22
workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntry.php
View File

@@ -71,12 +71,19 @@ class WebEntry extends Api
}
/**
* Creates a new Web Entry using the method "PHP pages with Web Services".
*
* @url POST /:prj_uid/web-entry
*
* @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 doPostWebEntry($prj_uid, array $request_data)
{
@@ -93,11 +100,18 @@ class WebEntry extends Api
}
/**
* Update web-entry.
*
* @url PUT /:prj_uid/web-entry/:we_uid
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $we_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutWebEntry($prj_uid, $we_uid, array $request_data)
{
@@ -111,6 +125,8 @@ class WebEntry extends Api
/**
* @url DELETE /:prj_uid/web-entry/:we_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $we_uid {@min 32}{@max 32}

24
workflow/engine/src/ProcessMaker/Services/Api/Project/WebEntryEvent.php
View File

@@ -88,13 +88,19 @@ class WebEntryEvent extends Api
}
/**
* Create web entry event for a project.
*
* @url POST /:prj_uid/web-entry-event
* @class AccessControl {@permission PM_FACTORY}
*
* @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 doPostWebEntryEvent($prj_uid, array $request_data)
{
@@ -110,12 +116,19 @@ class WebEntryEvent extends Api
}
/**
* Update web-entry event.
*
* @url PUT /:prj_uid/web-entry-event/:wee_uid
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}
* @param string $wee_uid {@min 32}{@max 32}
* @param array $request_data
*
* @return mixed
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*/
public function doPutWebEntryEvent($prj_uid, $wee_uid, array $request_data)
{
@@ -129,6 +142,7 @@ class WebEntryEvent extends Api
/**
* @url DELETE /:prj_uid/web-entry-event/:wee_uid
* @access protected
* @class AccessControl {@permission PM_FACTORY}
*
* @param string $prj_uid {@min 32}{@max 32}

9
workflow/engine/src/ProcessMaker/Services/Api/Role.php
View File

@@ -99,12 +99,17 @@ class Role extends Api
}
/**
* @access protected
* @class AccessControl {@permission PM_USERS}
* Update a role.
*
* @url PUT /:rol_uid
*
* @param string $rol_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_USERS}
*/
public function doPut($rol_uid, array $request_data)
{

2
workflow/engine/src/ProcessMaker/Services/Api/Role/User.php
View File

@@ -72,9 +72,9 @@ class User extends Api
}
/**
* @url DELETE /:rol_uid/user/:usr_uid
* @access protected
* @class AccessControl {@permission PM_USERS}
* @url DELETE /:rol_uid/user/:usr_uid
*
* @param string $rol_uid {@min 32}{@max 32}
* @param string $usr_uid {@min 32}{@max 32}

31
workflow/engine/src/ProcessMaker/Services/Api/Test2.php
View File

@@ -1,31 +0,0 @@
<?php
namespace ProcessMaker\Services\Api;
use \ProcessMaker\Services\Api;
use \Luracast\Restler\RestException;
class Test2 extends Api
{
public function hello2()
{
return 'Hello #2';
}
/**
* @url GET /getHello
*/
public function helloworld($param = '')
{
return 'Greetings, from a overridden url ' . $param;
}
/**
* @url GET /sample/other/large/:name
*/
public function sampleOther($name)
{
return 'Name: ' . $name;
}
}

23
workflow/engine/src/ProcessMaker/Services/Api/Test3.php
View File

@@ -1,23 +0,0 @@
<?php
namespace ProcessMaker\Services\Api;
use \ProcessMaker\Services\Api;
use \Luracast\Restler\RestException;
class Test3 extends Api
{
public function hello3()
{
return 'Hello #3';
}
/**
* @status 201
*/
public function post2()
{
return array('success' => true);
}
}

9
workflow/engine/src/ProcessMaker/Services/Api/User.php
View File

@@ -83,12 +83,17 @@ class User extends Api
}
/**
* @access protected
* @class AccessControl {@permission PM_USERS}
* Update a user.
*
* @url PUT /:usr_uid
*
* @param string $usr_uid {@min 32}{@max 32}
* @param array $request_data
*
* @throws RestException
*
* @access protected
* @class AccessControl {@permission PM_USERS}
*/
public function doPutUser($usr_uid, $request_data)
{