3.2 - 3.8 - REST API Designer - Events

Event Endpoints

The current methods implemented for event resources in the ProcessMaker API designer end point are listed below:

Event resources:

Get Events List: GET project/{prj_uid}/events

Gets a list of the events in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/events

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Result:

Type	Description
array	Returns an array of existing events in the process

Example:

Response

Get Event Messages: GET project/{prj_uid}/events?filter=message

Gets the list of the event messages in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/events?filter=message

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Optional Parameters:

Name	Type	Description
filter	String	Event type to be listed ("message")

Result:

Type	Description
array	Returns an array of existing events in the process

Example:

Response

Get Event Condition: GET project/{prj_uid}/events?filter=conditional

Gets the list of the event conditions in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/events?filter=conditional

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Optional Parameters:

Name	Type	Description
filter	String	Event type to be listed ("conditional")

Result:

Type	Description
array	Returns an array of existing events in the process

Example:

Response

Get Multiple Events List: GET project/{prj_uid}/events?filter=multiple

Gets the list of the multiple events in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/events?filter=multiple

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Optional Parameters:

Name	Type	Description
filter	String	Event type to be listed ("multiple")

Result:

Type	Description
array	Returns an array of existing events in the process

Example:

Response

Get Event: GET project/{prj_uid}/event/{evn_uid}

Gets information about an event.

GET /api/1.0/{workspace}/project/{prj_uid}/event/{evn_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
evn_uid	String	Event UID

Result:

Type	Description
object	Returns an object containing the event data

Example:

Response

Create Event: POST project/{prj_uid}/event

Creates a new event.

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}/event

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Required Fields:

Name	Type	Description
evn_description	String	Event description
evn_status	String	Event status
evn_action	String	Variable for the priority case
evn_related_to	String	Template of the routing screen
tas_uid	String	Task UID. Only if evn_related_to = "SINGLE"
evn_tas_uid_from	String	Initial task UID. Only if evn_related_to = "MULTIPLE"
evn_tas_estimated_duration	String	Time lapse for the completion of the tasks
evn_time_unit	String	Value type of the time lapse when performing a task or tasks
evn_when	Integer	Value in days of the time lapse for the execution of the event
evn_when_occurs	Integer	Time when the event will be held
tri_uid	Integer	UID of the trigger that will execute the event
evn_tas_uid_to	String	Final task UID. Only if evn_related_to = "MULTIPLE"

Optional Fields:

Name	Type	Description
evn_conditions	String	Condition that will execute the event if met

Result:

Type	Description
object	Returns an object containing data about the event created.

Example:

Request

Response

Update Event: PUT project/{prj_uid}/event/{evn_uid}

Updates an event.

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}/event/{evn_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
evn_uid	String	Event UID

Required Fields:

Name	Type	Description
evn_description	String	Event description
evn_status	String	Event status
evn_action	String	Variable for the priority case
evn_related_to	String	Template of the routing screen
tas_uid	String	Task UID. Just if evn_related_to = "SINGLE"
evn_tas_uid_from	String	Initial task UID. Just if evn_related_to = "MULTIPLE"
evn_tas_estimated_duration	String	Time lapse for the completion of the tasks
evn_time_unit	String	Value type of the time lapse when performing a task or tasks
evn_when	Integer	Value in days of the time lapse for the execution of the event
evn_when_occurs	Integer	Time when the event will be held.
tri_uid	Integer	UID of the trigger that will execute that event
evn_tas_uid_to	String	Final task UID. Just if evn_related_to = "MULTIPLE"

Optional Fields:

Name	Type	Description
evn_conditions	String	Condition that will execute the event if met

Result:

Type	Description
empty	No return

Example:

Request

Response

Delete Event: DELETE project/{prj_uid}/event/{evn_uid}

Deletes an event.

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}/event/{evn_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
evn_uid	String	Event UID

Result:

Type	Description
empty	No return

Example:

Response