ProcessRun

Retrieve and manage process runs

ProcessGroupRun

A run-time grouping of JobRuns and other GroupRuns.

Properties

Name	Type	Description	Restrictions
active	boolean¦null	If present, indicates whether new and existing JobRuns in this GroupRun will be run.
children	[ProcessGroupRunChild]	The children of this GroupRun. Children can be a JobRun or another GroupRun.
childrenEligibleToStartCount	integer(int32)¦null	If present, indicates the number of children under this group that are eligible to start.
created	Action	When the action was performed, and details about the user who did it.
eligibleToStart	boolean¦null	If present, indicates whether Start can be called on this GroupRun.
id	string	The GroupRun’s unique identifier
modified	Action	When the action was performed, and details about the user who did it.
name	string	The name of the GroupRun.
ordinal	integer(int32)	The zero-based index representing the location of this child within its parent group	read-only
parallel	boolean	If true, JobRuns within this GroupRun are run in parallel. If false, serial.	required
parent	string¦null	The id of this child’s parent. Not present if the parent is the root GroupRun of the ProcessRun.
readOnly	boolean	Whether this GroupRun is read-only.	required
revision	integer(int64)	The revision number of the current representation of the GroupRun.
status	string	The general execution status of the JobRun. The same set of statuses apply to all JobRuns. For action specific statuses see a JobRun’s action status.
statusCounts	object	Convenience map of JobRun statuses to the number of JobRuns with that status.
statusCounts.additionalProperties	integer(int64)	Convenience map of JobRun statuses to the number of JobRuns with that status.
triggerType	string¦null	What triggers a group child to execute.

Enumerated Values

Property	Value
status	waiting
status	running
status	cancelling
status	complete
status	cancelled
status	error
status	errorHold
triggerType	whenEligible
triggerType	manual

Example

{
  "id": "root-group-123",
  "name": "Main Workflow Run",
  "parallel": false,
  "readOnly": false,
  "status": "running"
}

ProcessGroupRunChild

Represents a child element within a GroupRun in a running process (runtime). A “group run” child can be either a JobRun or another nested GroupRun, reflecting the hierarchical structure of work execution. The type field determines which specific child type is present.

Properties

Name	Type	Description	Restrictions
groupRun	ProcessGroupRun	A run-time grouping of JobRuns and other GroupRuns.
jobRun	JobRun	An instantiation of a Job created when a Process is started or when a new action is added to a running Process. An action’s implementation can be carried out by multiple JobRuns that make up a single action’s implementation. A JobRun’s action type is dictated by the type of “arguments” that are passed to it. The arguments are action specific.
type	string	The type of GroupRun child. The corresponding JobRun or GroupRun details will be provided below.

Enumerated Values

Property	Value
type	group
type	job

Example

{
  "jobRun": {
    "id": "jobinstance-123",
    "status": "waiting"
  },
  "type": "job"
}

ProcessRun

A Process that has been started. An instantiation of a Process.

Properties

Name	Type	Description	Restrictions
autoClose	boolean	If this process is configured to automatically close once all actions are completed or canceled.	read-only, required
businessDateExclusions	[string]	Individual dates that are excluded as business days of this ProcessRun. Impacts relative date calculations.	read-only, unique
businessDateInclusions	[string]	Individual dates that are included as business days of this ProcessRun, regardless of exclusion rules.	read-only, unique
businessDaysOfWeek	[string]	The days of the week that are deemed “working days” for this ProcessRun. Impacts relative date calculations.	read-only, unique
businessEndDate	string(date)	The end date for the ProcessRun.	read-only
businessStartDate	string(date)	Date for when the ProcessRun should start for anchoring relative dates	read-only
calendars	[string]	A set of calendar ids associated with this ProcessRun. The events of these calendars are displayed in calendar ux components in Processes.	read-only, unique
certAutoApprove	boolean	If certification auto approval is turned on for certification actions on this process.	read-only, required
completedDate	string(date-time)	When the ProcessRun was completed.	read-only
created	Action	When the action was performed, and details about the user who did it.
defaultCertApproverReminders	ReminderData	Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.
defaultCertSignerReminders	ReminderData	Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.
dueDate	string(date)	When the Process is due.	read-only
id	string	The Process’ unique identifier.	read-only
jobRunMap	object	Convenience map of JobRun id to JobRun.	read-only
jobRunMap.additionalProperties	JobRun	An instantiation of a Job created when a Process is started or when a new action is added to a running Process. An action’s implementation can be carried out by multiple JobRuns that make up a single action’s implementation. A JobRun’s action type is dictated by the type of “arguments” that are passed to it. The arguments are action specific.
managerUser	string	The userId of the user this ProcessRun runs as.	read-only
modified	Action	When the action was performed, and details about the user who did it.
name	string	The name of the ProcessRun.	read-only
process	string	The Process id that was started that created this ProcessRun.	read-only
relativeDates	boolean	If relative dates are enabled for this process. Enables automatic shifting of dates based on the ProcessRun start date and business days configuration.	read-only, required
revision	integer(int64)	The revision number of the current representation of the Process	read-only
root	ProcessGroupRun	A run-time grouping of JobRuns and other GroupRuns.
status	string	The general execution status of the JobRun. The same set of statuses apply to all JobRuns. For action specific statuses see a JobRun’s action status.	read-only
statusCounts	object	Convenience map of JobRun action statuses to the number of JobRuns with that status.	read-only
statusCounts.additionalProperties	integer(int64)	Convenience map of JobRun action statuses to the number of JobRuns with that status.

Enumerated Values

Property	Value
status	waiting
status	running
status	cancelling
status	complete
status	cancelled
status	error
status	errorHold

Example

{
  "autoClose": true,
  "businessDateExclusions": [
    "2024-12-25",
    "2024-01-01"
  ],
  "businessDateInclusions": [
    "2024-12-28"
  ],
  "businessDaysOfWeek": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday",
    "friday"
  ],
  "businessEndDate": "2024-12-31",
  "businessStartDate": "2024-01-01",
  "calendars": [
    "calendar-123",
    "calendar-456"
  ],
  "certAutoApprove": true,
  "completedDate": "2024-12-30T18:30:00Z",
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "defaultCertApproverReminders": {
    "mode": "default"
  },
  "defaultCertSignerReminders": {
    "mode": "default"
  },
  "dueDate": "2024-12-31",
  "id": "processinstance-xyz789",
  "jobRunMap": {
    "job-instance-1": {
      "id": "job-instance-1",
      "status": "complete"
    },
    "job-instance-2": {
      "id": "job-instance-2",
      "status": "running"
    }
  },
  "managerUser": "manager123",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Q4 2024 Financial Close",
  "process": "process-abc123",
  "relativeDates": false,
  "revision": 5,
  "root": {
    "id": "root-group-123",
    "name": "Main Workflow Run",
    "parallel": false,
    "readOnly": false,
    "status": "running"
  },
  "status": "running",
  "statusCounts": {
    "Completed": 5,
    "Running": 3,
    "Waiting": 2
  }
}

ProcessRunOptions

Options that can change details about the execution of the Process, including whether or not to send an email notification to the ProcessRun creator upon the completion or cancellation of the Process.

Properties

Name	Type	Description	Restrictions
sendProcessCompleteEmail	boolean	If true (the default value), then when the Process is completed or cancelled an email notification is sent to the user who started the Process.

Example

{
  "sendProcessCompleteEmail": false
}