Activiti Integration

Configuration

  • Enable Activity endpoints

    • POST to /API/Activiti_Manager/enable with url where the activiti server is running.
    • {"baseUrl": "http://{host:port}/activiti-rest/service/"}
  • Login to oeCloud based application and link your activiti-account to current logged-in user.

    • POST to /API/Activiti_Account
    • {"username":..., "password": ...}

Activiti API Mapping

Requests to Activiti server are forwarded using oeCloud Rest Connector. All the REST API’s exposed by Activiti are mapped to the models/apis created in oeWorkflow. This generalizes the Activiti API’s for a developer using oeCloud to build an app using Activiti Workflow Engine. We categorised the APIs into models based on Activiti documentation.

Activiti_Deployment

HTTP Method Deployment API Description
POST /Activiti_Deployments/create Create a new deployment
DELETE /Activiti_Deployments/deleteById/{deploymentId} Delete a deployment
GET /Activiti_Deployments/get List of Deployments
GET /Activiti_Deployments/getById/{deploymentId} Get a deployment
GET /Activiti_Deployments/getResource/{deploymentId}/{resourceId} Get a deployment resource
GET /Activiti_Deployments/getResourceContent/{deploymentId}/{resourceId} Get a deployment resource content
GET /Activiti_Deployments/getResourcesById/{deploymentId} List resources in a deployment
POST /Activiti_Deployments/invoke

Activiti_ProcessDefinition

HTTP Method Process Definition API Description
PUT /Activiti_ProcessDefinitions/activate/{processDefinitionId} Activate a process definition
POST /Activiti_ProcessDefinitions/createCandidateStarter/{processDefinitionId} Add a candidate starter to a process definition
DELETE /Activiti_ProcessDefinitions/deleteCandidateStarter/{processDefinitionId}/{family}/{identityId} Delete a candidate starter from a process definition
GET /Activiti_ProcessDefinitions/get List of process definitions
GET /Activiti_ProcessDefinitions/getBPMNModel/{processDefinitionId} Get a process definition BPMN model
GET /Activiti_ProcessDefinitions/getById/{processDefinitionId} Get a process definition
GET /Activiti_ProcessDefinitions/getCandidateStarter/{processDefinitionId}/{family}/{identityId} Get a candidate starter from a process definition
GET /Activiti_ProcessDefinitions/getCandidateStarters/{processDefinitionId} Get all candidate starters for a process-definition
GET /Activiti_ProcessDefinitions/getResourceContent/{processDefinitionId} Get a process definition resource content
POST /Activiti_ProcessDefinitions/invoke
PUT /Activiti_ProcessDefinitions/suspend/{processDefinitionId} Suspend a process definition
PUT /Activiti_ProcessDefinitions/updateCategory/{processDefinitionId} Update category for a process definition

Activiti_Model

HTTP Method Model API Description
POST /Activiti_Models/create Create a model
DELETE /Activiti_Models/deleteById/{modelId} Delete a model
GET /Activiti_Models/get Get a list of models
GET /Activiti_Models/getById/{modelId} Get a model
GET /Activiti_Models/getEditorSource/{modelId} Get the editor source for a model
GET /Activiti_Models/getExtraEditorSource/{modelId} Get the extra editor source for a model
POST /Activiti_Models/invoke
PUT /Activiti_Models/setEditorSource/{modelId} Set the editor source for a model
PUT /Activiti_Models/setExtraEditorSource/{modelId} Set the extra editor source for a model
GET /Activiti_Models/update/{modelId} Update a model

Activiti_ProcessInstance

HTTP Method Process Instance API Description
PUT /Activiti_ProcessInstances/activate/{processInstanceId} Activate a process instance
POST /Activiti_ProcessInstances/createInvolvedUser/{processInstanceId} Add an involved user to a process instance
PUT /Activiti_ProcessInstances/createVariables/{processInstanceId} Create a new binary variable on a process-instance
DELETE /Activiti_ProcessInstances/deleteById/{processInstanceId} Delete a process instance
DELETE /Activiti_ProcessInstances/deleteInvolvedUser/{processInstanceId}/{userId}/{type} Remove an involved user to from process instance
GET /Activiti_ProcessInstances/get List of process instances
GET /Activiti_ProcessInstances/getById/{processInstanceId} Get a process instance
GET /Activiti_ProcessInstances/getDiagram/{processInstanceId} Get diagram for a process instance
GET /Activiti_ProcessInstances/getInvolvedPeople/{processInstanceId} Get involved people for process instance
GET /Activiti_ProcessInstances/getVariable/{processInstanceId}/{variableName} Get a variable for a process instance
GET /Activiti_ProcessInstances/getVariables/{processInstanceId} List of variables for a process instance
POST /Activiti_ProcessInstances/invoke
GET /Activiti_ProcessInstances/query Query process instances
POST /Activiti_ProcessInstances/start Start a process instance
PUT /Activiti_ProcessInstances/suspend/{processInstanceId} Suspend a process instance
PUT /Activiti_ProcessInstances/updateVariable/{processInstanceId}/{variableName} Update a variable or a binary variable on a process instance
PUT /Activiti_ProcessInstances/createVariables/{processInstanceId} Create variables on a process instance

Activiti_Execution

HTTP Method Executions API Description
GET /Activiti_Executions/activeActivities/{executionId} Get active activities in an execution
POST /Activiti_Executions/createVariables/{executionId} Create new variable or new binary variable on an execution
PUT /Activiti_Executions/executeAction/{executionId} Execute an action on an execution
GET /Activiti_Executions/get List of executions
GET /Activiti_Executions/getById/{executionId} Get an execution
GET /Activiti_Executions/getVariable/{executionId}/{variableName} Get a variable for an execution
GET /Activiti_Executions/getVariables/{executionId} List of variables for an execution
POST /Activiti_Executions/invoke
POST /Activiti_Executions/query Query executions
PUT /Activiti_Executions/updateVariables/{executionId}/{variableName} Update variables or binary variables on an execution

Activiti_Task

HTTP Method Tasks API Description
POST /Activiti_Tasks/claim/{taskId} Task actions
POST /Activiti_Tasks/complete/{taskId} Task actions
POST /Activiti_Tasks/createAttachmentWithFile/{taskId} Create a new attachment on a task, with an attached file
POST /Activiti_Tasks/createAttachmentWithLink/{taskId} Create a new attachment on a task, containing a link to an external resource
POST /Activiti_Tasks/createBinaryVariable/{taskId} Create a new binary variable on a task
POST /Activiti_Tasks/createCommentById/{taskId} Create a new comment on a task
POST /Activiti_Tasks/createIdentityLink/{taskId} Create an identity link on a task
POST /Activiti_Tasks/createVariables/{taskId} Create variables on a task
POST /Activiti_Tasks/delegate/{taskId} Task actions
DELETE /Activiti_Tasks/deleteAttachment/{taskId}/{attachmentId} Delete an attachment on a task
DELETE /Activiti_Tasks/deleteById/{taskId} Delete a task
DELETE /Activiti_Tasks/deleteComment/{taskId}/{commentId} Delete a comment on a task
DELETE /Activiti_Tasks/deleteIdentityLink/{taskId}/{family}/{identityId}/{type} Delete an identity link on a task
DELETE /Activiti_Tasks/deleteVariable/{taskId}/{variableName} Delete a variable on a task
DELETE /Activiti_Tasks/deleteVariables/{taskId} Delete all local variables on a task
GET /Activiti_Tasks/get List of tasks
GET /Activiti_Tasks/getAttachment/{taskId}/{attachmentId} Get an attachment on a task
GET /Activiti_Tasks/getAttachmentContent/{taskId}/{attachmentId} Get the content for an attachment
GET /Activiti_Tasks/getAttachmentsById/{taskId} Get all attachments on a task
GET /Activiti_Tasks/getBinaryData/{taskId}/{variableName} Get the binary data for a variable
GET /Activiti_Tasks/getById/{taskId} Get a task
GET /Activiti_Tasks/getComments/{taskId}/{commentId} Get a comment on a task
GET /Activiti_Tasks/getCommentsById/{taskId} Get all comments on a task
GET /Activiti_Tasks/getEvent/{taskId}/{eventId} Get an event on a task
GET /Activiti_Tasks/getEventsById/{taskId} Get all events for a task
GET /Activiti_Tasks/getIdentityLink/{taskId}/{family}/{identityId}/{type} Get a single identity link on a task
GET /Activiti_Tasks/getIdentityLinksById/{taskId} Get all identity links for a task
GET /Activiti_Tasks/getIdentityLinksGroupsById/{taskId} Get all identitylinks for a task for groups
GET /Activiti_Tasks/getIdentityLinksUsersById/{taskId} Get all identitylinks for a task for users
GET /Activiti_Tasks/getVariable/{taskId}/{variableName} Get a variable from a task
GET /Activiti_Tasks/getVariables/{taskId} Get all variables for a task
POST /Activiti_Tasks/invoke
POST /Activiti_Tasks/query Query for tasks
POST /Activiti_Tasks/resolve/{taskId} Task actions
PUT /Activiti_Tasks/updateBinaryVariable/{taskId}/{variableName} Updating a binary variable on a task
PUT /Activiti_Tasks/updateVariables/{taskId}/{variableName} Update variables on a task
PUT /Activiti_Tasks/updateById Update a task
PUT /Activiti_Tasks/updateVariable/{taskId}/{variableName} Update an existing variable on a task

Activiti_History

HTTP Method History API Description
POST /Activiti_Histories/createCommentById/{processInstanceId} Create a new comment on a historic process instance
DELETE /Activiti_Histories/deleteComment/{processInstanceId}/{commentId} Delete a comment on a historic process instance
DELETE /Activiti_Histories/deleteProcessInstanceById/{processInstanceId} Delete a historic process instance
DELETE /Activiti_Histories/deleteTaskById/{taskId} Delete a historic task instance
GET /Activiti_Histories/getActivityInstances Get historic activity instances
GET /Activiti_Histories/getBinaryDataHistoricVariable/{detailId} Get the binary data for a historic variable
GET /Activiti_Histories/getBinaryDataProcessInstanceVariable/{processInstanceId}/{variableName} Get the binary data for a historic process instance variable
GET /Activiti_Histories/getBinaryDataTaskVariable/{taskId}/{variableName} Get the binary data for a historic Task instance variable
GET /Activiti_Histories/getBinaryDataVariable/{varInstanceId} Get the binary data for a historic detail variable
GET /Activiti_Histories/getComments/{processInstanceId}/{commentId} Get a comment on a historic process instance
GET /Activiti_Histories/getCommentsById/{processInstanceId} Get all comments on a historic process instance
GET /Activiti_Histories/getHistoricDetails Get historic detail
GET /Activiti_Histories/getProcessInstanceById/{processInstanceId} Get a historic process instance
GET /Activiti_Histories/getProcessInstanceIdentityLinksById/{processInstanceId} Get the identity links of a historic process instance
GET /Activiti_Histories/getProcessInstances List of historic process instances
GET /Activiti_Histories/getTaskById/{taskId} Get a single historic task instance
GET /Activiti_Histories/getTaskIdentityLinksById/{taskId} Get the identity links of a historic task instance
GET /Activiti_Histories/getTasks Get historic task instances
GET /Activiti_Histories/getVariableInstances List of historic variable instances
POST /Activiti_Histories/invoke
POST /Activiti_Histories/queryActivityInstance Query for historic activity instances
POST /Activiti_Histories/queryHistoricDetails Query for historic details
POST /Activiti_Histories/queryProcessInstance Query for historic process instances
POST /Activiti_Histories/queryTask Query for historic task instances
POST /Activiti_Histories/queryVariableInstance Query for historic variable instances

Activiti_Form

HTTP Method Forms API Description
POST /Activiti_Forms/CreateFormData Submit task form data
GET /Activiti_Forms/getFormData Get form data
POST /Activiti_Forms/invoke

Activiti_Table

HTTP Method Forms API Description
GET /Activiti_Tables/get/{tableName} List of tables
GET /Activiti_Tables/getById/{tableName} Get a single table
GET /Activiti_Tables/getRowData/{tableName} Get row data for a single table
GET /Activiti_Tables/getColumnsById/{tableName} Get column info for a single table
POST /Activiti_Tables/invoke

Activiti_Engine

HTTP Method Engine API Description
GET /Activiti_Engines/getProperties Get engine properties
GET /Activiti_Engines/getEngine Get engine Info
POST /Activiti_Engines/invoke

Activiti_Runtime

HTTP Method Runtime API Description
POST /Activiti_Runtimes/invoke
POST /Activiti_Runtimes/query Signal event received

Activiti_Job

HTTP Method Jobs API Description
POST /Activiti_Jobs/complete/{jobId} Execute a single job
DELETE /Activiti_Jobs/deleteById/{jobId} Delete a job
GET /Activiti_Jobs/getById/{jobId} Get a single job
GET /Activiti_Jobs/getJobs Get a list of jobs
GET /Activiti_Jobs/getStackTraceById/{jobId} Get the exception stacktrace for a job
POST /Activiti_Jobs/invoke

Activiti_User

HTTP Method Users API Description
POST /Activiti_Users/create Create a User
POST /Activiti_Users/createUserInfoById/{userId} Create a new user’s info entry
DELETE /Activiti_Users/deleteById/{userId} Delete a User
DELETE /Activiti_Users/deleteUserInfoById/{key}/{userId} Delete a user’s info
GET /Activiti_Users/get Get list of Users
GET /Activiti_Users/getById/{userId} Get a Single User
GET /Activiti_Users/getPictureById/{userId} Get a User’s Picture
GET /Activiti_Users/getUserInfo/{userId} List a user’s info
GET /Activiti_Users/getUserInfoById/{userId}/{key} Get a user’s info
POST /Activiti_Users/invoke
PUT /Activiti_Users/updateById Update a User
PUT /Activiti_Users/updatePictureById Updating a user’s picture
PUT /Activiti_Users/updateUserInfoById/{userId}/{key} Update a user’s info

Activiti_Group

HTTP Method Groups API Description
POST /Activiti_Groups/create Create a group
DELETE /Activiti_Groups/delete/{groupId} Delete a group
DELETE /Activiti_Groups/deleteMember/{groupId}/{userId} Delete a member from a group
GET /Activiti_Groups/get Get a list of groups
GET /Activiti_Groups/getById/{groupId} Get a single group
GET /Activiti_Groups/getUsersofGroup Get Users of a group
POST /Activiti_Groups/invoke
PUT /Activiti_Groups/update/{groupId} Update a group
POST /Activiti_Groups/updateMember/{groupId} Add a member to a group