3.2 - 3.8 - REST API Designer - Case Scheduler

Case Scheduler Endpoints

The current methods implemented for the case scheduler resources in the ProcessMaker API designer are listed below:

Case Scheduler Resources

Get Case Schedulers List: GET project/{prj_uid}/case-schedulers

Gets the list of the case schedulers in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/case-schedulers

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Result:

Type	Description
array	Returns an array of objects containing information about the case schedulers.

Example:

Response

Get Case Scheduler: GET project/{prj_uid}/case-scheduler/{sch_uid}

Gets a specified case scheduler.

GET /api/1.0/{workspace}/project/{prj_uid}/case-scheduler/{sch_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
sch_uid	String	Case scheduler UID

Result:

Type	Description
object	Returns a case scheduler object

Example:

Response

Create Case Scheduler: POST project/{prj_uid}/case-scheduler

Creates a new Case Scheduler.

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}/case-scheduler

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Required Fields:

Name	Type	Description
sch_option	Number	The period of time the case scheduler will be activated in the case can be set with this option.
sch_start_time (Mandatory when sch_option=1,2,3, or 4)	Date	Task start time
sch_start_date (Mandatory when sch_option=1,2,3, or 4)	Date	Task start date
sch_week_days (Mandatory when sch_option=2)	Integer	Days of the week (1-7, they may be separated by a pipeline)
sch_start_day (Mandatory when sch_option=3)	Integer	Days of the week (1. Day of the month, 2. The day)
sch_start_day_opt_1 (Mandatory when sch_start_day=1)	Integer	Days of the month (1-30)
sch_start_day_opt_2 (Mandatory when sch_start_day=2)	Integer	Compound data. (Check their definitions in the main table)
sch_months (Mandatory when sch_option=3)	Integer	Months
sch_end_date (Mandatory when sch_option=1,2 or 3)	Date	End date of the task
sch_repeat_every (Mandatory when sch_option=5)	Date	Hours when the case scheduler will be repeated
sch_name	String	Case scheduler name
sch_del_user_name	String	Case scheduler username
tas_uid	String	Task UID

Optional Fields:

Name	Type	Description
sch_del_user_pass	String	Case scheduler password
sch_repeat_until	String	Repeat until
sch_repeat_stop_if_running	Integer	Stop when
case_sh_plugin_uid	String	Plugin UID
sch_state	String	Current status
sch_last_state	String	Previous status

Result:

Type	Description
object	Returns an object containing information about the new case scheduler.

Example:

Request

Response

Update Case Scheduler: PUT project/{prj_uid}/case-scheduler/{sch_uid}

Updates a Case Scheduler.

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}/case-scheduler/{sch_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
sch_uid	String	Case scheduler UID

Required Fields:

Name	Type	Description
sch_option	Number	The period of time the case scheduler will be activated in the case can be set with this option.
sch_name	String	Case scheduler name
sch_del_user_name	String	Case scheduler username
tas_uid	String	Task UID
sch_state	String	Case scheduler status
sch_start_time (Mandatory when sch_option=1,2,3, or 4)	Date	Task start time
sch_start_date (Mandatory when sch_option=1,2,3, or 4)	Date	Task start date
sch_week_days (Mandatory when sch_option=2)	Integer	Days of the week (1-7, they may be separated by a pipeline)
sch_start_day (Mandatory when sch_option=3)	Integer	Days of the week (1. Day of the month, 2. The day)
sch_start_day_opt_1 (Mandatory when sch_start_day=1)	Integer	Days of the month (1-30)
sch_start_day_opt_2 (Mandatory when sch_start_day=2)	Integer	Compound data. (View their definitions in the main table)
sch_months (Mandatory when sch_option=3)	Integer	Months
sch_end_date (Mandatory when sch_option=1,2 or 3)	Date	End date of the task
sch_repeat_every (Mandatory when sch_option=5)	Date	Hours when the case scheduler will be repeated

Optional Fields:

Name	Type	Description
sch_del_user_pass	String	Case scheduler password
sch_repeat_until	String	Repeat until
sch_repeat_stop_if_running	Integer	Stop when
case_sh_plugin_uid	String	Plugin UID
sch_last_state	String	Previous status

Result:

Type	Description
object	Returns an object containing new information about the case scheduler.

Example:

Request

Response

Delete Case Scheduler: DELETE project/{prj_uid}/case-scheduler/{sch_uid}

Deletes a Case Scheduler.

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}/case-scheduler/{sch_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
sch_uid	String	Case scheduler UID

Result:

Type	Description
empty	No return

Example:

Response