Requests
API Reference for ProcessMaker Request API
Last updated
Was this helpful?
API Reference for ProcessMaker Request API
Last updated
Was this helpful?
Display a listing of the resource.
/requests
Only return requests by type (all|in_progress|completed)
all
, in_progress
, completed
, started_me
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
, desc
Include data from related models in payload. Comma separated list.
Display the specified resource.
/requests/{process_request_id}
ID of process request to return
Include data from related models in payload. Comma separated list.
Update a request
/requests/{process_request_id}
ID of process request to return
Represents an Eloquent model of a Request which is an instance of a Process.
ACTIVE
, COMPLETED
, ERROR
, CANCELED
No body
Trigger a intermediate catch event
/requests/{process_request_id}/events/{event_id}
ID of process request to return
ID of process event to return
No body
Display a listing of the resource.
/requests/{request_id}/files
ID of the request
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
, desc
Store a newly created resource in storage.
/requests/{request_id}/files
ID of the request
Variable name in the request data to use for the file name
save a new media file
Display the specified resource.
/requests/{request_id}/files/{file_id}
ID of the request
ID of the file to return