Get single process by ID

  • 1 minute(s) read
Prev Next
Get
/processes/{processId}

Display the specified resource.

Security
OAuth

Laravel passport oauth2 security.

FlowAuthorization Code
Authorization URLhttp://processmaker.test/oauth/authorize
Token URLhttp://processmaker.test/oauth/token
Refresh URLhttp://processmaker.test/token/refresh
HTTP
Type bearer
Path parameters
processId
integerRequired

ID of process to return

Query parameters
include
string

Include data from related models in payload. Comma separated list.

Default""
Responses
200

Successfully found the process

Expand All
object
process_category_id
integer (id)

Represents a business process definition.

name
string
case_title
string
description
string
status
string
Valid values[ "ACTIVE", "INACTIVE", "ARCHIVED" ]
pause_timer_start
integer
cancel_screen_id
integer
has_timer_start_events
boolean
request_detail_screen_id
integer (id)
is_valid
integer
package_key
string
start_events
Array of object (ProcessStartEvents)
object
eventDefinitions
object
parallelMultiple
boolean
outgoing
object
incoming
object
id
string
name
string
warnings
string
self_service_tasks
object
signal_events
Array of object
object
category
object
manager_id
integer (id)
user_id
integer (id)
id
string (id)
deleted_at
string (date-time)
created_at
string (date-time)
updated_at
string (date-time)
notifications
object
task_notifications
object