Path: / API / runtimeAPI


Resources
NameDescription
addAttachment
? addAttachment/{instanceUUID}/{name}
Add an attachment to a process instance.
addAttachmentWithDescription
? addAttachmentWithDescription/{instanceUUID}/{name}
Add an attachment to a process instance.
addAttachmentsAdd all attachments to the process instance defined in the attachment instance.
addComment
? addComment/{instanceUUID}/{activityUUID}/{userId}
Adds a comment to the ProcessInstance feed.
addCommentToAProcessInstance
? addCommentToAProcessInstance/{instanceUUID}/{userId}
Adds a comment to the ProcessInstance feed.
addCommentToAnActivityInstance
? addCommentToAnActivityInstance/{activityUUID}/{userId}
Adds a comment to an ActivityInstance feed.
addDocumentVersion
? addDocumentVersion/{documentUUID}
addProcessMetaDataAdds a process meta data.
assignTask
? assignTask/{taskUUID}
Launches the execution of both RoleResolver and Filters for the given task.
assignTaskWithCandidates
? assignTaskWithCandidates/{taskUUID}
Forces to replace the candidates set of the given task by the given candidates set.
cancelProcessInstance
? cancelProcessInstance/{instanceUUID}
Cancels the process instance with the given instance UUID.
cancelProcessInstancesCancels for each given instance UUID, the process instance.
createDocument
deleteAllProcessInstancesDeletes all runtime objects for all instances created with the given process UUIDs collection and delete also all there recorded data from the journal.
deleteCatchingEventsDeletes events
deleteDocuments
deleteEvent
? deleteEvent/{eventUUID}
Deletes the event.
deleteEvents
deleteProcessInstance
? deleteProcessInstance/{instanceUUID}
Deletes all runtime objects for the process instance with the given instance UUID and delete also recorded data from the journal.
deleteProcessInstancesDeletes for each given instance UUID, all runtime objects
deleteProcessMetaDataDeletes a process meta data.
enableEventsInFailure
enablePermanentEventInFailure
? enablePermanentEventInFailure/{activityUUID}
evaluateGroovyExpression
evaluateGroovyExpressionInActivityInstance
? evaluateGroovyExpressionInActivityInstance/{activityInstanceUUID}/{useActivityScope}/{propagate}
Evaluates an expression using Groovy.
evaluateGroovyExpressionWithContext
evaluateGroovyExpressions
evaluateGroovyExpressionsWithContext
? evaluateGroovyExpressionsWithContext/{processInstanceUUID}/{useInitialVariableValues}/{propagate}
executeConnectorExecutes a Connector.
executeConnectorInActivityInstance
? executeConnectorInActivityInstance/{activityInstanceUUID}/{useCurrentVariableValues}
Executes a Connector in the context of an activity .
executeConnectorWithClassLoader
executeConnectorWithContext
? executeConnectorWithContext/{definitionUUID}
Executes a Connector in the context of a process.
executeEvent
? executeEvent/{eventUUID}
Executes the event.
executeFilterExecutes a Filter.
executeFilterWithClassLoader
executeRoleResolverExecutes a RoleResolver.
executeRoleResolverWithClassLoader
executeTask
? executeTask/{taskUUID}/{assignTask}
Executes the given task.
finishTask
? finishTask/{taskUUID}/{taskAssign}
Finishes the task.
getModifiedJavaObject
? getModifiedJavaObject/{processUUID}
Gets the modified java object based on the given variable expression, initial variable value and attribute value
instantiateProcess
instantiateProcessWithVariables
? instantiateProcessWithVariables/{uuid}
Creates an instance of the specified process with the added variable map and start the execution.
instantiateProcessWithVariablesAndAttachements
? instantiateProcessWithVariablesAndAttachements/{processUUID}
Creates an instance of the specified process with the added variable map, the default attachments and start the execution.
removeAttachment
? removeAttachment/{instanceUUID}/{name}
Removes all versions of an attachment according to its name.
resumeTask
? resumeTask/{taskUUID}/{taskAssign}
Resumes the task if the task has SUSPENDED state.
setActivityInstancePriority
? setActivityInstancePriority/{activityInstanceUUID}/{priority}
set an activity instance priority
setActivityInstanceVariable
? setActivityInstanceVariable/{activityUUID}
Searches for variable with the given activity UUID and variable Id.
setActivityInstanceVariables
? setActivityInstanceVariables/{activityUUID}
Searches for variables with the given activity UUID and variables Id.
setProcessInstanceVariable
? setProcessInstanceVariable/{instanceUUID}
Searches for variable with id variableId within the given process instance with ProcessInstanceUUID instanceUUID.
setProcessInstanceVariables
? setProcessInstanceVariables/{instanceUUID}
Searches for variables with id variableId within the given process instance with ProcessInstanceUUID instanceUUID.
setVariable
? setVariable/{activityUUID}
Searches for variable with id variableId within the given activity instance with the given UUID.
skipTask
? skipTask/{taskUUID}
Skips the task if the task has READY state.
startActivity
? startActivity/{activityUUID}
Starts the activity.
startTask
? startTask/{taskUUID}/{assignTask}
Starts the task.
suspendTask
? suspendTask/{taskUUID}/{assignTask}
Suspends the task if the task has EXECUTING state.
unassignTask
? unassignTask/{taskUUID}
If this task had a userId set, set it to null.
updateActivityExpectedEndDate
? updateActivityExpectedEndDate/{activityUUID}
Updates the expected date when the activity should finish.
updateExpirationDate
? updateExpirationDate/{eventUUID}
Updates the expiration date of an event.