Path: / API / queryRuntimeAPI


Resources
NameDescription
canExecuteTask
? canExecuteTask/{taskUUID}
Returns true if the given task is READY and: - if the task is assigned: if the assigned user is the logged user - if the task is not assigned: if the logged user is in the candidates list
getActiveUsersOfProcessInstance
? getActiveUsersOfProcessInstance/{instanceuuid}
List name of active users.
getActiveUsersOfProcessInstancesList name of active users for each given process instances.
getActivityInstance
? getActivityInstance/{activityUUID}
Returns the record of the activity with the given activity UUID.
getActivityInstanceCommentFeed
? getActivityInstanceCommentFeed/{activityUUID}
Obtains the comments of an activity.
getActivityInstanceEvents
? getActivityInstanceEvents/{activityuuid}
Returns all activity instance events which are waiting to be executed.
getActivityInstanceState
? getActivityInstanceState/{activityUUID}
Gets the activity state of the activity according to its UUID
getActivityInstanceVariable
? getActivityInstanceVariable/{activityUUID}
Obtains a variable defined as local to the activity for the given activity UUID and variable name.
getActivityInstanceVariables
? getActivityInstanceVariables/{activityUUID}
Obtains the variables defined as local to the activity for the given activity UUID.
getActivityInstances
? getActivityInstances/{instanceUUID}
Returns all records of activity for the given process instance UUID.
getAttachmentNames
? getAttachmentNames/{instanceUUID}
Obtains the process attachment names.
getAttachmentValueGets the content of an attachment instance as a byte array.
getAttachments
? getAttachments/{instanceUUID}/{attachmentName}
Obtains versions of a process attachment according to its UUID and the attachment name.
getCommentFeed
? getCommentFeed/{instanceUUID}
Obtains all the comments (activity and process) of a ProcessInstance.
getDocument
? getDocument/{documentUUID}
getDocumentContent
? getDocumentContent/{documentUUID}
getDocumentVersions
? getDocumentVersions/{documentUUID}
getDocuments
getEvent
? getEvent/{eventUUID}
Returns the event according to its UUID.
getEventsReturns all events which are waiting to be executed.
getLastAttachment
? getLastAttachment/{instanceUUID}/{attachmentName}
Obtains the last attachment of a process according to its UUID and the attachment name.
getLastAttachmentWihDate
? getLastAttachmentWihDate/{instanceUUID}/{attachmentName}
Obtains the last version of a process attachment created before the given date.
getLastAttachments
? getLastAttachments/{instanceUUID}
Obtains for each attachment (given by its name) the its last version for a process instance
getLastAttachmentsByRegex
? getLastAttachmentsByRegex/{instanceUUID}
Obtains the last versions of some process attachments (the attachment name should match with the regular expression)
getLightActivityInstance
? getLightActivityInstance/{activityInstanceUUID}
Returns the record of the activity with the given activity instance UUID.
getLightActivityInstances
? getLightActivityInstances/{instanceUUID}
Returns all records of activity for the given process instance UUID.
getLightActivityInstancesFromRootGets for each process instance UUID, the list of light activity instances which belong to a process instance according to its UUID.
getLightActivityInstancesFromRootByState
? getLightActivityInstancesFromRootByState/{state}
Gets for each process instance UUID, the list of light activity instances which belong to a process instance according to its UUID having the given state.
getLightActivityInstancesPaged
? getLightActivityInstancesPaged/{instanceUUID}
Returns all records of activity for the given process instance UUID.
getLightLastUpdatedActivityInstanceFromRoot
? getLightLastUpdatedActivityInstanceFromRoot/{considerSystemTaks}
Gets for each process instance UUID, the light activity instance that have been updated after all others
getLightParentProcessInstancesGets a set of light process instances from an index to the page size.
getLightParentProcessInstancesByPagingCriterionGets a list of light process instances from an index to the page size.
getLightParentProcessInstancesExceptGets the LightProcessInstances that are not sub-process instances and not having the ProcessDefinitionUUID in the given ProcessDefinitionUUIDs sub-set.
getLightParentProcessInstancesFromProcessUUIDsGets the LightProcessInstances that are not sub-process instances and having the ProcessDefinitionUUID in the given ProcessDefinitionUUIDs sub-set.
getLightParentProcessInstancesWithActiveUser
? getLightParentProcessInstancesWithActiveUser/{userId}
* Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user.
getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDate
? getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDate/{userId}
* Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays.
getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateAndProcessUUIDs
? getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateAndProcessUUIDs/{userId}
* Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays.
getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateAndProcessUUIDsWithPagingCriterion
? getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateAndProcessUUIDsWithPagingCriterion/{username}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays order by the giver pagingCriterion.
getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateExcept
? getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateExcept/{userId}
* Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays.
getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateExceptWithPagingCriterion
? getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateExceptWithPagingCriterion/{username}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays order by the given pagingCriterion.
getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateWithPagingCriterion
? getLightParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateWithPagingCriterion/{userId}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays order by the given pagingCriterion.
getLightParentProcessInstancesWithActiveUserAndPagingCriterionFromProcessUUIDs
? getLightParentProcessInstancesWithActiveUserAndPagingCriterionFromProcessUUIDs/{username}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user order by pagingCriterion.
getLightParentProcessInstancesWithActiveUserAndProcessUUIDs
? getLightParentProcessInstancesWithActiveUserAndProcessUUIDs/{userId}
* Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user.
getLightParentProcessInstancesWithActiveUserExcept
? getLightParentProcessInstancesWithActiveUserExcept/{userId}
* Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user.
getLightParentProcessInstancesWithActiveUserExceptWithPaginCriterion
? getLightParentProcessInstancesWithActiveUserExceptWithPaginCriterion/{userId}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user order by the pagingCriterion.
getLightParentProcessInstancesWithActiveUserWithPagingCriterion
? getLightParentProcessInstancesWithActiveUserWithPagingCriterion/{userId}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user.
getLightParentProcessInstancesWithInvolvedUser
? getLightParentProcessInstancesWithInvolvedUser/{userId}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user.
getLightParentProcessInstancesWithInvolvedUserByProcesses
? getLightParentProcessInstancesWithInvolvedUserByProcesses/{userId}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user.
getLightParentProcessInstancesWithInvolvedUserByProcessesAnPagingCriterion
? getLightParentProcessInstancesWithInvolvedUserByProcessesAnPagingCriterion/{userId}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the involved user order by the given pagingCriterion.
getLightParentProcessInstancesWithInvolvedUserExcept
? getLightParentProcessInstancesWithInvolvedUserExcept/{userId}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the active user.
getLightParentProcessInstancesWithInvolvedUserExceptWithPagingCriterion
? getLightParentProcessInstancesWithInvolvedUserExceptWithPagingCriterion/{username}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the involved user order by the given pagingCriterion.
getLightParentProcessInstancesWithInvolvedUserWithPagingCriterion
? getLightParentProcessInstancesWithInvolvedUserWithPagingCriterion/{userId}
Gets LightProcessInstances that are not sub-process instances and having the given userId member of the involved user order by pagingCriterion.
getLightParentProcessInstancesWithOverdueTasks
? getLightParentProcessInstancesWithOverdueTasks/{userId}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past.
getLightParentProcessInstancesWithOverdueTasksAndProcessUUID
? getLightParentProcessInstancesWithOverdueTasksAndProcessUUID/{userId}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past.
getLightParentProcessInstancesWithOverdueTasksAndProcessUUIDWithPagingCriterion
? getLightParentProcessInstancesWithOverdueTasksAndProcessUUIDWithPagingCriterion/{username}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past order by the given pagingCriterion.
getLightParentProcessInstancesWithOverdueTasksExcept
? getLightParentProcessInstancesWithOverdueTasksExcept/{userId}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past.
getLightParentProcessInstancesWithOverdueTasksExceptWithPagingCriterion
? getLightParentProcessInstancesWithOverdueTasksExceptWithPagingCriterion/{username}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past.
getLightParentProcessInstancesWithOverdueTasksWithPagingCriterion
? getLightParentProcessInstancesWithOverdueTasksWithPagingCriterion/{userId}
Gets the ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past order by the given pagingCriterion.
getLightParentUserInstancesReturns at most pageSize instances started by the logged user
getLightParentUserInstancesExceptReturns at most pageSize instances started by the given user.
getLightParentUserInstancesExceptWithPagingCriterionReturns at most pageSize instances started by the current user order by pagingCriterion.
getLightParentUserInstancesFromProcessUUIDsWithPagingCriterionReturns at most pageSize instances started by the given user.
getLightParentUserInstancesWithPagingCriterionReturns at most pageSize instances started by the logged user
getLightParentUsersInstancesReturns at most pageSize instances started by the given user.
getLightProcessInstance
? getLightProcessInstance/{instanceUUID}
Returns the light process instance with the given process instance UUID.
getLightProcessInstancesGets all light process instances.
getLightProcessInstancesByIndexAndPageSizeGets a set of light process instances from an index to the page size.
getLightProcessInstancesByIndexPageSizeAndPagingCriterionGets a set of light process instances from an index to the page size ordered by the paging criterion.
getLightProcessInstancesByPageSizeAndPagingCriterionGets a list of light process instances from an index to the page size according to the set of process instance UUIDs.
getLightProcessInstancesByProcessInstanceUUIDsGets a set of light process instances form their UUIDs.
getLightProcessInstancesByProcessInstanceUUIDsIndexAndPageSizeGets a set of light process instances from an index to the page size according to the collection of process instance UUIDs.
getLightTaskInstance
? getLightTaskInstance/{activityUUID}
Returns the record of the task with the given task UUID.
getLightTaskInstancesFromRootGets for each process instance UUID the list of light task instances which belong to a process instance according to its UUID.
getLightTaskList
? getLightTaskList/{instanceUUID}
getLightTaskListByActivityState
? getLightTaskListByActivityState/{taskState}
See getTaskList(ActivityState taskState).
getLightTaskListByProcessInstanceUUID
? getLightTaskListByProcessInstanceUUID/{instanceUUID}
See getTaskList(ProcessInstanceUUID instanceUUID, Collection taskStates)
getLightTaskListByUserId
? getLightTaskListByUserId/{userId}/{taskState}
See getTaskList(String userId, ActivityState taskState)
getLightTasks
? getLightTasks/{instanceUUID}
See getTasks(ProcessInstanceUUID instanceUUID)
getLightTasksByTaskNames
? getLightTasksByTaskNames/{instanceUUID}
Returns a set of tasks which are a task name from the set of task and the given process instance UUID and the task names
getLightUserInstancesReturns all instances started by the logged user
getLightWeightProcessInstancesReturns all records of instance for the given process processDefinitionUUIDs.
getNumberOfActivityInstanceCommentsCounts the number of comments of all given activities.
getNumberOfComments
? getNumberOfComments/{instanceUUID}
Counts the number of all comments (activity and process) of a process.
getNumberOfParentProcessInstancesCounts the number of process instances which are not a sub instance.
getNumberOfParentProcessInstancesWithActiveUser
? getNumberOfParentProcessInstancesWithActiveUser/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active user.
getNumberOfParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDate
? getNumberOfParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDate/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays.
getNumberOfParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateAndProcessUUIDs
? getNumberOfParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateAndProcessUUIDs/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays.
getNumberOfParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateExcept
? getNumberOfParentProcessInstancesWithActiveUserAndActivityInstanceExpectedEndDateExcept/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the next remainingDays.
getNumberOfParentProcessInstancesWithActiveUserAndProcessUUIDs
? getNumberOfParentProcessInstancesWithActiveUserAndProcessUUIDs/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active user.
getNumberOfParentProcessInstancesWithActiveUserExcept
? getNumberOfParentProcessInstancesWithActiveUserExcept/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active user.
getNumberOfParentProcessInstancesWithInvolvedUser
? getNumberOfParentProcessInstancesWithInvolvedUser/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the involved user.
getNumberOfParentProcessInstancesWithInvolvedUserAndCategory
? getNumberOfParentProcessInstancesWithInvolvedUserAndCategory/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the involved users and the given category.
getNumberOfParentProcessInstancesWithInvolvedUserAndCategoryAndProcessUUIDs
? getNumberOfParentProcessInstancesWithInvolvedUserAndCategoryAndProcessUUIDs/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the involved users and the given category.
getNumberOfParentProcessInstancesWithInvolvedUserAndCategoryExcept
? getNumberOfParentProcessInstancesWithInvolvedUserAndCategoryExcept/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the involved users and the given category.
getNumberOfParentProcessInstancesWithInvolvedUserAndProcessUUIDs
? getNumberOfParentProcessInstancesWithInvolvedUserAndProcessUUIDs/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the involved user.
getNumberOfParentProcessInstancesWithInvolvedUserExcept
? getNumberOfParentProcessInstancesWithInvolvedUserExcept/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the involved user.
getNumberOfParentProcessInstancesWithOverdueTasks
? getNumberOfParentProcessInstancesWithOverdueTasks/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past.
getNumberOfParentProcessInstancesWithOverdueTasksAndProcessUUIDs
? getNumberOfParentProcessInstancesWithOverdueTasksAndProcessUUIDs/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past.
getNumberOfParentProcessInstancesWithOverdueTasksExcept
? getNumberOfParentProcessInstancesWithOverdueTasksExcept/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active users and having at least one task with the expected end date in the past.
getNumberOfParentProcessInstancesWithStartedBy
? getNumberOfParentProcessInstancesWithStartedBy/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active user.
getNumberOfParentProcessInstancesWithStartedByAndProcessUUIDs
? getNumberOfParentProcessInstancesWithStartedByAndProcessUUIDs/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active user.
getNumberOfParentProcessInstancesWithStartedByExcept
? getNumberOfParentProcessInstancesWithStartedByExcept/{userId}
Gets the number of ProcessInstances that are not sub-process instances and having the given userId member of the active user.
getNumberOfProcessInstanceComments
? getNumberOfProcessInstanceComments/{instanceUUID}
Counts the number of comments of a process.
getNumberOfProcessInstancesCounts the number of process instances.
getOneTask
? getOneTask/{taskState}
Gets an activity UUID among all available tasks of the logged user according to the given activity state.
getOneTaskByProcessDefinitionUUIDAndActivityState
? getOneTaskByProcessDefinitionUUIDAndActivityState/{processUUID}/{taskState}
Gets an activity UUID among all available tasks of the logged user according to the given activity state and the given process UUID.
getOneTaskByProcessInstanceUUIDAndActivityState
? getOneTaskByProcessInstanceUUIDAndActivityState/{instanceUUID}/{taskState}
Gets an activity UUID among all available tasks of the logged user according to the given activity state and the given process instance UUID.
getProcessInstance
? getProcessInstance/{instanceUUID}
Returns the record of the instance with the given UUID.
getProcessInstanceCommentFeed
? getProcessInstanceCommentFeed/{instanceUUID}
Obtains the comments belonging to the process.
getProcessInstanceEvents
? getProcessInstanceEvents/{instanceuuid}
Returns all process instance events which are waiting to be executed.
getProcessInstanceVariable
? getProcessInstanceVariable/{instanceUUID}
Obtains a process variable for the given process instance UUID and variable name.
getProcessInstanceVariables
? getProcessInstanceVariables/{instanceUUID}
Obtains the process variables for the given process instance UUID.
getProcessInstanceVariablesWithMaxDate
? getProcessInstanceVariablesWithMaxDate/{instanceUUID}
Obtains the process variables for the given process instance UUID at the given date.
getProcessInstancesGets all process instances.
getProcessInstancesByProcessInstanceUUIDsReturns all records of instances matching with the given ProcessInstanceUUID.
getProcessInstancesWithInstanceStatesReturns all records of instances in one of the given states.
getProcessInstancesWithTaskStateReturns all records of instances having one task in one of the given states.
getTask
? getTask/{taskUUID}
Returns the record of the task with the given task UUID.
getTaskCandidatesReturns the candidates of the tasks with the given task UUID.
getTaskList
? getTaskList/{instanceUUID}
Obtains the user tasks depending on the given activity states for the given instance and the authenticated user.
getTaskListByActivityState
? getTaskListByActivityState/{taskState}
Obtains the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the authenticated user.
getTaskListByUserIdAndActivityState
? getTaskListByUserIdAndActivityState/{userId}/{taskState}
Obtains the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given user.
getTasks
? getTasks/{instanceUUID}
Returns all records of task for the given process instance UUID.
getUserInstancesReturns all instances started by the logged user
getVariable
? getVariable/{activityUUID}
Obtains a variable for the given activity and variable name.
getVariables
? getVariables/{activityUUID}
Obtains the activity variables (including global process and local activity variables) for the given activity UUID.
search
searchByMaxResult
searchDocuments