3.2 - 3.8 - REST API Designer - Steps

Step Endpoints

A step is an action within a task, which can be a DynaForm, Input Document, Output Document or an External Step (which is created with a plugin). The following endpoints are available to manage steps in ProcessMaker:

Step resources:

Get Steps for Task: GET /project/{prj_uid}/activity/{act_uid}/steps

Gets the list of the steps assigned to a task.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/steps

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/steps
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/steps
act_uid	Unique ID of task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/steps

Result:

Element	Description
[	An array of step objects.
{	First step object.
"step_uid": "800335382526013ee5406d6046561388",	Unique ID of the step.
"step_type_obj": "DYNAFORM",	Type of step, which can be "DYNAFORM", "INPUT_DOCUMENT", "OUTPUT_DOCUMENT" or "EXTERNAL" (a step created by a plugin).
"step_uid_obj": "480515388526013e03f5323091406324",	Unique ID of the step's object, which can be a Dynaform, Input Document, Output Document or External Step.
"step_condition": "@@investigateClient == 'true'",	A string containing the step's condition. If it evaluates to true, then the step will be executed.
"step_position": 1,	The step position, where the first step in the task is 1, the second is 2, etc.
"step_mode": "EDIT",	The mode, which can be "EDIT" or "VIEW". The BPMN Process Designer does not have a graphical option to use the "VIEW" mode.
"obj_title": "Background Check",	The title of the step's object.
"obj_description":"Info about client's history",	The description of the step's object.
"triggers": [	An array of triggers that are executed before or after the step.
{	First trigger object.
"tri_uid": "389005986576b14b28bac58020591119",	The unique ID of the trigger.
"tri_title": "Lookup criminal history",	The title of the trigger.
"tri_description":"Database searches on client",	The description of the trigger.
"st_type": "BEFORE",	The type of execution, which is "BEFORE" if executed before the step or "AFTER" if executed after the step.
"st_condition":"@@criminalHistory == 'yes'",	A string containing the trigger's condition. If it evaluates to true, then the trigger will be executed.
"st_position": 1	The trigger's position, which is 1 for the first trigger, 2 for the second trigger, etc. There is separate counting for "BEFORE" and "AFTER" triggers.
},	End first trigger object.
...	Any additional trigger objects.
]	End array of trigger objects.
},	End first step object.
...	Any additional step objects.
]	End array of step objects.

Example:

Response

PHP Example:

Find the unique ID of the step that holds the "Criminal history" Dynaform.

Get Available Steps for Task: GET /project/{prj_uid}/activity/{act_uid}/available-steps

Gets the list of available steps that may be assigned to a task.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/available-steps

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/steps
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/steps
act_uid	Unique ID of task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/steps

Result:

Element	Description
[	An array of available objects.
{	First object.
"obj_uid": "800335382526013ee5406d6046561388",	Unique ID of the object.
"obj_title": "Background Check",	The title of the object.
"obj_description":"Info about client's history",	The description of the object.
"obj_type": "DYNAFORM"	The type of object, which can be "DYNAFORM", "INPUT_DOCUMENT", "OUTPUT_DOCUMENT" or "EXTERNAL" (a custom step created by a plugin).
},	End first object.
...	Any additional objects.
]	End array of available objects.

Example:

Response

PHP Example:

Search for an available Input Document that has the title "History Files" and assign it as a step in the task:

Get Step for Activity: GET /project/{prj_uid}/activity/{act_uid}/step/{step_uid}

Gets a single step assigned to an activity.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
act_uid	Unique ID of task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695

Result:

Element	Description
{	Step object.
"step_uid": "800335382526013ee5406d6046561388",	Unique ID of the step.
"step_type_obj": "DYNAFORM",	Type of step, which can be "DYNAFORM", "INPUT_DOCUMENT", "OUTPUT_DOCUMENT" or "EXTERNAL" (a step created by a plugin).
"step_uid_obj": "480515388526013e03f5323091406324",	Unique ID of the step's object, which can be a Dynaform, Input Document, Output Document or External Step.
"step_condition": "@@investigateClient == 'true'",	A string containing the step's condition. If it evaluates to true, then the step will be executed.
"step_position": 1,	The step position, where the first step in the task is 1, the second is 2, etc.
"step_mode": "EDIT",	The mode, which can be "EDIT" or "VIEW". The BPMN Process Designer does not have a graphical option to use the "VIEW" mode.
"obj_title": "Background Check",	The title of the step's object.
"obj_description":"Info about client's history"	The description of the step's object.
}	End step object.

Example:

Response

Assign Step to Task: POST /project/{prj_uid}/activity/{act_uid}/step

Assigns a step to a task.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

POST /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/step
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/step
act_uid	Unique ID of task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/activity/748962028577d84795d55b3012565154/step

POST Parameters:

Example parameter	Description
{
"step_type_obj": "DYNAFORM",	Type of step, which can be "DYNAFORM", "INPUT_DOCUMENT", "OUTPUT_DOCUMENT" or "EXTERNAL" (a step created by a plugin).
"step_uid_obj": "480515388526013e03f5323091406324",	Unique ID of the step's object, which can be a Dynaform, Input Document, Output Document or External Step.
"step_mode": "EDIT",	For classic processes imported or upgraded from ProcessMaker 2. The mode can be "EDIT" or "VIEW" for Dynaforms, "ATTACH" or "VIEW" for Input Documents, and "EDIT" for Output Documents. For BPMN processes, the mode is not used and should always be set to "EDIT".
"step_condition": "@@investigateClient == 'true'",	Optional. A string containing a PHP condition, which can contain case and system variables. If it evaluates to true, then the step will be executed. If it evaluates to false, then it won't be executed. If the expression consists of a single value, remember that in PHP a non-zero number and a non-empty string are considered true.
"step_position": 1,	Optional. The step position, where the first step in the task is 1, the second is 2, etc. If an object is already in that position, then it will be displaced downward in the step order. If not included, then the object will be placed as the last step in the task.
}

Result:

If successful, the HTTP status code is set to 201 (Created) and an object is returned with information about the new step.

Example:

Request

Response

PHP Example:

Assign a Dynaform as the last step in the task:

Update Step for Activity: PUT /project/{prj_uid}/activity/{act_uid}/step/{step_uid}

Updates the assignment of a step to an activity.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

PUT /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
act_uid	Unique ID of task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695

PUT Parameters:

Parameter	Description
{
"step_type_obj": "DYNAFORM",	Optional. Type of step, which can be "DYNAFORM", "INPUT_DOCUMENT", "OUTPUT_DOCUMENT" or "EXTERNAL" (a step created by a plugin). Note that step_type_obj must be included if changing the step_uid_obj.
"step_uid_obj": "480515388526013e03f5323091406324",	Optional. Unique ID of the step's object, which can be a Dynaform, Input Document, Output Document or External Step.
"step_mode": "EDIT",	Optional. For classic processes imported or upgraded from ProcessMaker 2. The mode can be "EDIT" or "VIEW" for Dynaforms, "ATTACH" or "VIEW" for Input Documents, and "EDIT" for Output Documents. For BPMN processes, the mode is not used and should always be set to "EDIT".
"step_condition": "@@investigateClient == 'true'",	Optional. A string containing a PHP condition, which can contain case and system variables. If it evaluates to true, then the step will be executed. If it evaluates to false, then it won't be executed. If the expression consists of a single value, remember that in PHP a non-zero number and a non-empty string are considered true.
"step_position": 1,	Optional. The step position, where the first step in the task is 1, the second is 2, etc. If an object is already in that position, then it will be displaced downward in the step order. If not included, then the object will be placed as the last step in the task.
}

Result:

If successful, the HTTP status code is set to 200 (OK) and there is no return object. If an error occurs, the HTTP status code is 400 and an object like the following is returned:

{
  "error": {
    "code": 400,
    "message": "Bad Request: The Input Document with step_uid_obj: 969593549576b120e0c11b2046307156 does not exist."
  }
}

Example:

Request

Content-Type: application/json
{
  "step_type_obj":  "DYNAFORM",
  "step_uid_obj":   "761754168526157a5878337086391024",
  "step_condition": "",
  "step_position":  1,
  "step_mode":      "EDIT"
}

Response

200 (OK)

PHP Example:

Move a step to the beginning of a task and add a condition to the task:

$processId = '113406514573f91fdd453d7080353209';
$taskId =    '6537449955772ec4b9705a4019286874';
$stepId =    '761754168526157a5878337086391024';
$aParams = array (
   "step_position"  => 1,
   "step_condition" => "@@decision == 'redo' or @@decision == 'proceed'"
);
$url = "/api/1.0/workflow/project/$processId/activity/$taskId/step";
$oRet = pmRestRequest("POST", $url, $aParams);

if (isset($oRet->status) and $oRet->status == 200) {
   print "Step order changed.\n";
}

Unassign Step from Task: DELETE /project/{prj_uid}/activity/{act_uid}/step/{step_uid}

Unassigns a step from a task.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

DELETE /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
act_uid	Unique ID of task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695

Result:

If successful, then the HTTP status code is set to 200 (OK) and there is no return object. If an error occurs, the HTTP status code is set to 400 and an error object like the following is returned:

{
  "error": {
    "code":    400,
    "message": "Bad Request: The step with step_uid: 569912885578808e99e0091037758050 does not exist."
  }
}

Example:

Response

PHP Example:

Assign a Dynaform as the last step in the task:

Get Triggers for Step: GET /project/{prj_uid}/activity/{act_uid}/step/{step_uid}/triggers

Gets the list of triggers assigned to be executed before and after a step.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}/triggers

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/triggers
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/triggers
act_uid	Unique ID of task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/triggers
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/triggers

Result:

If successful, then the HTTP status code is set to 200 (OK) and an array of trigger objects is returned with the following structure:

Element	Description
[	An array of trigger objects.
{	First trigger object.
"tri_uid": "389005986576b14b28bac58020591119",	The unique ID of the trigger.
"tri_title": "Lookup criminal history",	The title of the trigger.
"tri_description":"Database searches on client",	The description of the trigger.
"st_type": "BEFORE",	The type of execution, which is "BEFORE" if executed before the step or "AFTER" if executed after the step.
"st_condition": "@@criminalHistory == 'yes'",	A string containing the trigger's condition. If it evaluates to true, then the trigger will be executed.
"st_position": 1	The trigger's position, which is 1 for the first trigger, 2 for the second trigger, etc. There is separate counting for "BEFORE" and "AFTER" triggers.
},	End first trigger object.
...	Any additional trigger objects.
]	End array of trigger objects.

Example:

Response

PHP Example:

Check whether a trigger titled "Get process information" is assigned to the task:

Get Available Triggers for Step: GET /project/{prj_uid}/activity/{act_uid}/step/{step_uid}/available-triggers/{type}

Gets the list of available triggers to assign to a step.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}/available-triggers/{type}

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/available-triggers/before
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/available-triggers/before
act_uid	Unique ID of the task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/available-triggers/before
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/available-triggers/before
type	When the trigger is executed, which can be either "before" or "after" the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/available-triggers/before

Result:

Element	Description
[	Start array of trigger objects.
{	First trigger object.
"tri_uid": "550289117529f8ba2705074055790637",	Unique ID of the trigger.
"tri_title": "Get user's email",	Title of the trigger.
"tri_description": "",	Description of the trigger.
"tri_type": "SCRIPT",	The type is always "SCRIPT".
"tri_webbot": "@@email = userInfo(@@USER_LOGGED)['mail'];",	PHP code of the trigger.
"tri_param": ""	A serialized array of parameters for the trigger's function if it was created with the trigger wizard. If a custom trigger, then set to "" (an empty string).
},	End first trigger object.
...	Any additional trigger objects.
]	End array.

Example:

Response

PHP example:

This example retrieves the list of available triggers for a step, and then searches for the one whose title is "Email Manager" and assigns it to execute before the step.

Get Trigger for Step: GET /project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger/{tri_uid}/{type}

Gets information about a single trigger assigned to a step.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger/{tri_uid}/{type}

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/451169569578965bd2a5513008268885/before
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/ 451169569578965bd2a5513008268885/before
act_uid	Unique ID of the task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/ 451169569578965bd2a5513008268885/before
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/ 451169569578965bd2a5513008268885/before
tri_uid	Unique ID of the trigger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695/trigger/ 451169569578965bd2a5513008268885/before
type	When the trigger is executed, which can be either before or after the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/ step/28191616657869600330ad8022614695/trigger/ 451169569578965bd2a5513008268885/before

Result:

Element	Description
{	Start trigger object
"tri_uid": "550289117529f8ba2705074055790637",	Unique ID of the trigger.
"tri_title": "Get user's email",	Title of the trigger.
"tri_description": "",	Description of the trigger.
"st_type": "BEFORE",	Indicates whether the trigger is executed "BEFORE" or "AFTER" the step.
"st_condition": "@#amount > 500",	A condition in PHP language that can contain case variables. If it evaluates to true, then the trigger will be executed; otherwise, it won't be executed if it evaluates to false.
"st_position": 2	The execution order of the trigger, where the first trigger to execute is 1, the second is 2, etc. There is separate counting for "BEFORE" and "AFTER" triggers.
}	End trigger object.

Example:

Response

PHP example:

Assign Trigger to Step: POST /project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger

Assigns a trigger to a step.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

POST /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger

URL parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger
act_uid	Unique ID of the task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger

POST fields:

Element	Description
{	Start trigger object
"tri_uid": "550289117529f8ba2705074055790637",	Unique ID of the trigger.
"st_type": "BEFORE",	Indicates whether the trigger is executed "BEFORE" or "AFTER" the step.
"st_condition": "@#amount > 500",	(Optional) A condition in PHP language that can contain case variables. If it evaluates to true, then the trigger will be executed; otherwise, it won't be executed if it evaluates to false.
"st_position": 2	The execution order of the trigger, where the first trigger to execute is 1, the second is 2, etc. There is separate counting for "BEFORE" and "AFTER" triggers. If a trigger is already occupying that position, it will be displaced downward in the list.
}	End trigger object.

Result:

If successful, then the HTTP status is set to 201 (created) and there is no return object.

Example:

Request

Response

PHP example:

Update Trigger Assignment: PUT /project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger/{tri_uid}

Updates the assignment of a trigger to a step.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

PUT /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger/{tri_uid}

URL parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637
act_uid	Unique ID of the task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637
tri_uid	Unique ID of the trigger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637

PUT fields:

Element	Description
{	Start trigger object
"st_type": "BEFORE",	Required. Indicates whether the trigger is executed "BEFORE" or "AFTER" the step. Note that it is NOT possible to change the st_type with this endpoint. If needing to change the st_type, first unassign the trigger from the step and then reassign it.
"st_condition": "@#amount > 500",	Optional. A condition in PHP language that can contain case variables. If it evaluates to true, then the trigger will be executed; otherwise, it won't be executed if it evaluates to false.
"st_position": 2	Optional. The execution order of the trigger, where the first trigger to execute is 1, the second is 2, etc. There is separate counting for "BEFORE" and "AFTER" triggers. If a trigger is already occupying that position, it will be displaced downward in the list.
}	End trigger object.

Result:

If successful, then the HTTP status is set to 200 (OK) and there is no return object. If an error occurs, then an error object like the following is returned:

Example:

Request

Content-Type: application/json
{
    "st_type":      "BEFORE",
    "st_condition": "@@APPROVED == 'XY'",
    "st_position":  2
}

Response

200 (OK)

PHP example:

Unassign Trigger from Step:
DELETE /project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger/{tri_uid}/{type}

Unassigns a trigger from a step.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

DELETE /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/{step_uid}/trigger/{tri_uid}/{type}

URL parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637/ before
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637/ before
act_uid	Unique ID of the task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637/ before
step_uid	Unique ID of the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637/ before
tri_uid	Unique ID of the trigger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637 /before
type	Set to before or after to indicate whether the trigger is executed before or after the step.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ 28191616657869600330ad8022614695/trigger/550289117529f8ba2705074055790637/ before

Result:

Set to 200 (OK) if the trigger is unassigned from the step, so it will not be executed.

Example:

Response

PHP example:

Step endpoints - Assign Task (a special step that has no UID)

Get Triggers for Task: GET /project/{prj_uid}/activity/{act_uid}/step/triggers

Gets the list of assigned triggers in a task.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/triggers

URL Parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/triggers
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/triggers
act_uid	Unique ID of the task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/triggers

Result:

Type	Description
array	Returns an object array with data about each trigger.

Example:

Response

Available Triggers for Activity: GET /project/{prj_uid}/activity/{act_uid}/step/available-triggers/{type}

Gets the list of available triggers to assign.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/available-triggers/{type}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
act_uid	String	Activity UID
type	String	Trigger Type

Result:

Type	Description
array	Returns an object array with data about each trigger available for the step (according to the execution type)

Example:

Response

Get Trigger for Activity: GET /project/{prj_uid}/activity/{act_uid}/step/trigger/{tri_uid}/{type}

Gets a single trigger assigned to a step in an activity.

GET /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/trigger/{tri_uid}/{type}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
act_uid	String	Activity UID
tri_uid	String	Trigger UID
type	String	Type of trigger execution (before-assignment, before-routing, after-routing)

Result:

Type	Description
object	Returns an object with data about the trigger.

Example:

Response

Assign a Trigger to Activity: POST /project/{prj_uid}/activity/{act_uid}/step/trigger

Assigns a trigger to the "Assignment" or "Routing" step section of an activity.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

POST /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/trigger

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
act_uid	String	Activity UID

POST fields:

Element	Description
{	Start trigger object
"tri_uid": "550289117529f8ba2705074055790637",	Unique ID of the trigger.
"st_type": "BEFORE_ROUTING",	Indicates whether the trigger is executed "BEFORE_ASSIGNMENT", "BEFORE_ROUTING" or "AFTER_ROUTING" the case.
"st_condition": "@#amount > 500",	(Optional) A condition in PHP language that can contain case variables. If it evaluates to true, then the trigger will be executed; otherwise, it won't be executed if it evaluates to false.
"st_position": 2	The execution order of the trigger, where the first trigger to execute is 1, the second is 2, etc. There is separate counting for "BEFORE" and "AFTER" triggers. If a trigger is already occupying that position, it will be displaced downward in the list.
}	End trigger object.

Result:

Type	Description
empty	No return

Example:

Request

Response

Update Trigger: PUT /project/{prj_uid}/activity/{act_uid}/step/trigger/{tri_uid}

Updates a trigger that was assigned to the "Assignment" or "Routing" step section of an activity.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

PUT /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/trigger/{tri_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
act_uid	String	Activity UID
tri_uid	String	Trigger UID

PUT fields:

Element	Description
{	Start trigger object
"st_type": "BEFORE_ASSIGNMENT",	Required. Indicates whether the trigger is executed "BEFORE_ASSIGNMENT", "BEFORE_ROUTING", "AFTER_ROUTING" the task. Note that it is NOT possible to change the st_type with this endpoint. If needing to change the st_type, first unassign the trigger from the task and then reassign it.
"st_condition": "@#amount > 500",	Optional. A condition in PHP language that can contain case variables. If it evaluates to true, then the trigger will be executed; otherwise, it won't be executed if it evaluates to false.
"st_position": 2	Optional. The execution order of the trigger, where the first trigger to execute is 1, the second is 2, etc. There is separate counting for "BEFORE" and "AFTER" triggers. If a trigger is already occupying that position, it will be displaced downward in the list.
}	End trigger object.

Result:

Type	Description
empty	No return

Example:

Request

Response

Unassign Trigger: DELETE /project/{prj_uid}/activity/{act_uid}/step/trigger/{tri_uid}/{type}

Unassigns a trigger from the "Assignment" or "Routing" step section of an activity.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

DELETE: /api/1.0/{workspace}/project/{prj_uid}/activity/{act_uid}/step/trigger/{tri_uid}/{type}

URL parameters:

Name	Description	Example
workspace	Workspace name	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ trigger/6120910645852c920eba7d9069690137/before-routing
prj_uid	Unique ID of the project (process), which can be obtained by examining the @@PROCESS system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ trigger/6120910645852c920eba7d9069690137/before-routing
act_uid	Unique ID of the task, which can be obtained by examining the @@TASK system variable in the Debugger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ trigger/6120910645852c920eba7d9069690137/before-routing
tri_uid	Unique ID of the trigger.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ trigger/6120910645852c920eba7d9069690137/before-routing
type	Set to before-assignment, before-routing or after-routing to indicate whether the trigger is executed in the task.	/api/1.0/workflow/project/113406514573f91fdd453d7080353209/ activity/748962028577d84795d55b3012565154/step/ trigger/6120910645852c920eba7d9069690137/before-routing

Result:

Type	Description
empty	No return

Example:

Response