activiti

package module

v0.0.0-...-23d0917 Latest Latest Go to latest Published: Jan 7, 2019 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jumpjumpbean/go-activiti-rest

Links

Open Source Insights

README ¶

Go Client For Activiti v6.x Rest API

Go-activiti-rest client offers a library for interacting with Activiti6 server from Go applications. If you write applications in Golang and integrate them with Activiti6 then go-activiti-rest client will be uniquely useful.

Importing

import github.com/jumpjumpbean/go-activiti-rest

Example

package main

import (
	"github.com/jumpjumpbean/go-activiti-rest"
)

func main(){
	// Initialize client
	c, err := activiti.NewClient("kermit", "kermit",  "http://127.0.0.1:8080/activiti-rest/service")
	if err != nil {
		panic(err)
	}
	
	_, err = c.GetUser("fozzie")
	if err != nil {
		panic(err)
	}

	_, err = c.GetUsers()
	if err != nil {
		panic(err)
	}
	
	u := activiti.ActUser{
		ID:"jumpjumpbean",
		FirstName:"jump",
		LastName:"bean",
		Email:"[email protected]",
		Password:"jumpjumpbean",
	}

	_, err = c.CreateUser(u)
	if err != nil {
		panic(err)
	}

	_, err = c.UpdateUser(u)
	if err != nil {
		panic(err)
	}
	
	err = c.DeleteUser("jumpjumpbean")
	if err != nil {
		panic(err)
	}
}

REST API List

序号	REST API Item	Function
2.1.	List of Deployments	Deployments列表
2.2.	Get a deployment	获取Deployment
2.3.	Create a new deployment	创建新的Deployment
2.4.	Delete a deployment	删除Deployment
2.5.	List resources in a deployment	列出Deployment中的资源
2.6.	Get a deployment resource	获取Deployment资源
2.7.	Get a deployment resource content	获取Deployment资源内容

Process Definitions

序号	REST API Item	Function
3.1.	List of process definitions	流程定义列表
3.2.	Get a process definition	获取流程定义
3.3.	Update category for a process definition	流程定义的更新类别
3.4.	Get a process definition resource content	获取进程定义资源内容
3.5.	Get a process definition BPMN model	获取进程定义 BPMN 模型
3.6.	Suspend a process definition	暂停进程定义
3.7.	Activate a process definition	激活流程定义
3.8.	Get all candidate starters for a process-definition	获得所有候选者的过程
3.9.	Add a candidate starter to a process definition	在流程定义中添加候选启动器
3.10.	Delete a candidate starter from a process definition	从进程定义中删除候选启动器
3.11.	Get a candidate starter from a process definition	从流程定义中获取候选起始项

Models

序号	REST API Item	Function
4.1.	Get a list of models	获取模型列表
4.2.	Get a model	获取模型
4.3.	Update a model	更新模型
4.4.	Create a model	创建模型
4.5.	Delete a model	删除模型
4.6.	Get the editor source for a model	获取模型的编辑器源
4.7.	Set the editor source for a model	为模型设置编辑器源
4.8.	Get the extra editor source for a model	获取模型的额外编辑器源
4.9.	Set the extra editor source for a model	为模型设置额外的编辑器源

Process Instances

序号	REST API Item	Function
5.1.	Get a process instance	获取流程实例
5.2.	Delete a process instance	删除流程实例
5.3.	Activate or suspend a process instance	激活或挂起流程实例
5.4.	Start a process instance	启动流程实例
5.5.	List of process instances	流程实例列表
5.6.	Query process instances	查询流程实例
5.7.	Get diagram for a process instance	获取流程实例的关系图
5.8.	Get involved people for process instance	参与流程实例的人员
5.9.	Add an involved user to a process instance	将涉及的用户添加到流程实例
5.10.	Remove an involved user to from process instance	将涉及的用户从流程实例中删除
5.11.	List of variables for a process instance	流程实例的变量列表
5.12.	Get a variable for a process instance	获取流程实例的变量
5.13.	Create (or update) variables on a process instance	创建
5.14.	Update a single variable on a process instance	更新流程实例上的单个变量
5.15.	Create a new binary variable on a process-instance	在进程上创建新的二进制变量
5.16.	Update an existing binary variable on a process-instance	更新进程中的现有二进制变量

Executions

序号	REST API Item	Function
6.1.	Get an execution	获得Execution
6.2.	Execute an action on an execution	在Execution上执行操作
6.3.	Get active activities in an execution	在执行过程中获取活动
6.4.	List of executions	Execution列表
6.5.	Query executions	查询执行
6.6.	List of variables for an execution	执行变量列表
6.7.	Get a variable for an execution	获取用于执行的变量
6.8.	Create (or update) variables on an execution	创建
6.9.	Update a variable on an execution	更新Execution中的变量
6.10.	Create a new binary variable on an execution	在Execution中创建新的二进制变量
6.11.	Update an existing binary variable on a process-instance	更新Process-instance中的现有二进制变量

Tasks

序号	REST API Item	Function
7.1.	Get a task	获取任务
7.2.	List of tasks	任务清单
7.3.	Query for tasks	查询任务
7.4.	Update a task	更新任务
7.5.	Task actions	任务行动
7.6.	Delete a task	删除任务
7.7.	Get all variables for a task	获取任务的所有变量
7.8.	Get a variable from a task	从任务中获取变量
7.9.	Get the binary data for a variable	获取变量的二进制数据
7.10.	Create new variables on a task	在任务上创建新变量
7.11.	Create a new binary variable on a task	在任务上创建新的二进制变量
7.12.	Update an existing variable on a task	更新任务的现有变量
7.13.	Updating a binary variable on a task	更新任务的二进制变量
7.14.	Delete a variable on a task	删除任务上的变量
7.15.	Delete all local variables on a task	删除任务中的所有局部变量
7.16.	Get all identity links for a task	获取任务的所有标识链接
7.17.	Get all identitylinks for a task for either groups or users	为组或用户获取任务的所有 identitylinks
7.18.	Get a single identity link on a task	在任务上获取单个标识链接
7.19.	Create an identity link on a task	在任务上创建标识链接
7.20.	Delete an identity link on a task	删除任务上的标识链接
7.21.	Create a new comment on a task	创建新的任务注释
7.22.	Get all comments on a task	获取任务的所有注释
7.23.	Get a comment on a task	获取任务的注释
7.24.	Delete a comment on a task	删除任务的注释
7.25.	Get all events for a task	获取任务的所有事件
7.26.	Get an event on a task	在任务中获取事件
7.27.	Create a new attachment on a task, containing a link to an external resource	在任务上创建新附件, 包含指向外部资源的链接
7.28.	Create a new attachment on a task, with an attached file	使用附加文件在任务上创建新附件
7.29.	Get all attachments on a task	获取任务的所有附件
7.30.	Get an attachment on a task	获取任务的附件
7.31.	Get the content for an attachment	获取附件的内容
7.32.	Delete an attachment on a task	删除任务的附件

History

序号	REST API Item	Function
8.1.	Get a historic process instance	获取历史过程实例
8.2.	List of historic process instances	历史进程实例列表
8.3.	Query for historic process instances	查询历史进程实例
8.4.	Delete a historic process instance	删除历史进程实例
8.5.	Get the identity links of a historic process instance	获取历史进程实例的标识链接
8.6.	Get the binary data for a historic process instance variable	获取历史进程实例变量的二进制数据
8.7.	Create a new comment on a historic process instance	创建一个历史进程实例的新注释
8.8.	Get all comments on a historic process instance	获取历史过程实例的所有注释
8.9.	Get a comment on a historic process instance	获取一个历史过程实例的注释
8.10.	Delete a comment on a historic process instance	删除历史进程实例的注释
8.11.	Get a single historic task instance	获取单个历史任务实例
8.12.	Get historic task instances	获取历史任务实例
8.13.	Query for historic task instances	查询历史任务实例
8.14.	Delete a historic task instance	删除历史任务实例
8.15.	Get the identity links of a historic task instance	获取历史任务实例的标识链接
8.16.	Get the binary data for a historic task instance variable	获取历史任务实例变量的二进制数据
8.17.	Get historic activity instances	获取历史活动实例
8.18.	Query for historic activity instances	查询历史活动实例
8.19.	List of historic variable instances	历史变量实例列表
8.20.	Query for historic variable instances	查询历史变量实例
8.21.	Get historic detail	获取历史细节
8.22.	Query for historic details	查询历史细节
8.23.	Get the binary data for a historic detail variable	获取历史细节变量的二进制数据

Forms

序号	REST API Item	Function
9.1.	Get form data	获取表单数据
9.2.	Submit task form data	提交任务表单数据

Database tables

序号	REST API Item	Function
10.1.	List of tables	表格一览表
10.2.	Get a single table	获取单个表
10.3.	Get column info for a single table	获取单个表的列信息
10.4.	Get row data for a single table	获取单个表的行数据

Engine

序号	REST API Item	Function
11.1.	Get engine properties	获取引擎属性
11.2.	Get engine info	获取引擎信息

Runtime

序号	REST API Item	Function
12.1.	Signal event received	收到的信号事件

Jobs

序号	REST API Item	Function
13.1.	Get a single job	获得一份单独的工作
13.2.	Delete a job	删除作业
13.3.	Execute a single job	执行单个作业
13.4.	Get the exception stacktrace for a job	获取作业的异常堆栈
13.5.	Get a list of jobs	获取工作列表

Users

序号	REST API Item	Function
14.1.	Get a single user	获取单个用户
14.2.	Get a list of users	获取用户列表
14.3.	Update a user	更新用户
14.4.	Create a user	创建用户
14.5.	Delete a user	删除用户
14.6.	Get a user’s picture	获取用户的图片
14.7.	Updating a user’s picture	更新用户图片
14.8.	List a user’s info	列出用户信息
14.9.	Get a user’s info	获取用户信息
14.10.	Update a user’s info	更新用户信息
14.11.	Create a new user’s info entry	创建新用户的信息条目
14.12.	Delete a user’s info	删除用户信息

Groups

序号	REST API Item	Function
15.1.	Get a single group	获取单个组
15.2.	Get a list of groups	获取组列表
15.3.	Update a group	更新组
15.4.	Create a group	创建组
15.5.	Delete a group	删除组
15.6.	Get members in a group	获取组中的成员
15.7.	Add a member to a group	向组中添加成员
15.8.	Delete a member from a group	从组中删除成员

Documentation ¶

Index ¶

type ActClient
- func NewClient(username string, password string, baseURL string) (*ActClient, error)
type ActErrorResponse
- func (r *ActErrorResponse) Error() string
type ActProcessDefinition
type ActProcessDefinitions
type ActProcessInstance
type ActProcessInstances
type ActStartProcessInstance
type ActTask
type ActTasks
type ActUser
type ActUsers
type ActVariable
type JSONTime
- func (t JSONTime) MarshalJSON() ([]byte, error)
type TaskAction

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ActClient ¶

type ActClient struct {
	Client   *http.Client
	Username string
	Password string
	BaseURL  string
	Log      io.Writer // If user set log file name all requests will be logged there
}

Client represents a Activiti 6.x REST API Client

func NewClient ¶

func NewClient(username string, password string, baseURL string) (*ActClient, error)

NewClient returns new Client struct BaseURL is the activiti rest api url, for example 'http://localhost:8080'

func (*ActClient) CreateUser ¶

func (c *ActClient) CreateUser(u ActUser) (*ActUser, error)

CreateUser creates a user in activiti Endpoint: POST identity/users

func (*ActClient) DeleteUser ¶

func (c *ActClient) DeleteUser(uid string) error

DeleteUser deletes a user in activiti Endpoint: DELETE identity/users/{userId}

func (*ActClient) GetProcessDefinition ¶

func (c *ActClient) GetProcessDefinition(pid string) (*ActProcessDefinition, error)

GetProcessDefinition retrieves process definition by ID Endpoint: GET repository/process-definitions/{processDefinitionId}

func (*ActClient) GetProcessDefinitions ¶

func (c *ActClient) GetProcessDefinitions() (*ActProcessDefinitions, error)

GetProcessDefinitions retrieves all process definitions Endpoint: GET repository/process-definitions

func (*ActClient) GetProcessInstance ¶

func (c *ActClient) GetProcessInstance(pid string) (*ActProcessInstance, error)

GetProcessInstance retrieves process instance by ID Endpoint: GET runtime/process-instances/{processInstanceId}

func (*ActClient) GetProcessInstances ¶

func (c *ActClient) GetProcessInstances() (*ActProcessInstances, error)

GetProcessInstances retrieves all process instances Endpoint: GET runtime/process-instances

func (*ActClient) GetTask ¶

func (c *ActClient) GetTask(tid string) (*ActTask, error)

GetTask retrieves task by ID Endpoint: GET runtime/tasks/{taskId}

func (*ActClient) GetTasks ¶

func (c *ActClient) GetTasks() (*ActTasks, error)

GetTasks retrieves all tasks Endpoint: GET runtime/tasks

func (*ActClient) GetUser ¶

func (c *ActClient) GetUser(uid string) (*ActUser, error)

GetUser retrieves user by ID Endpoint: GET identity/users/{userId}

func (*ActClient) GetUsers ¶

func (c *ActClient) GetUsers() (*ActUsers, error)

GetUsers retrieves all users Endpoint: GET identity/users

func (*ActClient) NewRequest ¶

func (c *ActClient) NewRequest(method, url string, payload interface{}) (*http.Request, error)

NewRequest constructs a request Convert payload to a JSON

func (*ActClient) Send ¶

func (c *ActClient) Send(req *http.Request, v interface{}) error

Send makes a request to the API, the response body will be unmarshaled into v, or if v is an io.Writer, the response will be written to it without decoding

func (*ActClient) SendWithBasicAuth ¶

func (c *ActClient) SendWithBasicAuth(req *http.Request, v interface{}) error

SendWithBasicAuth makes a request to the API using username:password basic auth

func (*ActClient) SetHTTPClient ¶

func (c *ActClient) SetHTTPClient(client *http.Client)

SetHTTPClient sets *http.Client to current client

func (*ActClient) SetLog ¶

func (c *ActClient) SetLog(log io.Writer)

SetLog will set/change the output destination. If log file is set all requests and responses will be logged to this Writer

func (*ActClient) StartProcessInstanceById ¶

func (c *ActClient) StartProcessInstanceById(pid string) (*ActProcessInstance, error)

Start a process instance by process definition id

func (*ActClient) StartProcessInstanceByKey ¶

func (c *ActClient) StartProcessInstanceByKey(key string) (*ActProcessInstance, error)

Start a process instance by process definition key

func (*ActClient) StartProcessInstanceByMessage ¶

func (c *ActClient) StartProcessInstanceByMessage(msg string) (*ActProcessInstance, error)

Start a process instance by process definition message

func (*ActClient) TaskAction ¶

func (c *ActClient) TaskAction(tid string, action TaskAction, assignee string) error

TaskAction complete/claim/delegate/resolve a task in activiti Endpoint: POST runtime/tasks/{taskId}

func (*ActClient) UpdateUser ¶

func (c *ActClient) UpdateUser(u ActUser) (*ActUser, error)

UpdateUser updates a user in activiti Endpoint: PUT identity/users/{userId}

type ActErrorResponse ¶

type ActErrorResponse struct {
	Response *http.Response `json:"-"`
	// contains filtered or unexported fields
}

ErrorResponse https://www.activiti.org/userguide/#_error_response_body

func (*ActErrorResponse) Error ¶

func (r *ActErrorResponse) Error() string

Error method implementation for ErrorResponse struct

type ActProcessDefinition ¶

type ActProcessDefinition struct {
	ID                       string `json:"id,omitempty"`
	URL                      string `json:"url,omitempty"`
	Version                  int    `json:"version,omitempty"`
	Key                      string `json:"key,omitempty"`
	Category                 string `json:"category,omitempty"`
	Suspended                bool   `json:"suspended,omitempty"`
	Name                     string `json:"name,omitempty"`
	Description              string `json:"description,omitempty"`
	DeploymentId             string `json:"deploymentId,omitempty"`
	DeploymentUrl            string `json:"deploymentUrl,omitempty"`
	GraphicalNotationDefined bool   `json:"graphicalNotationDefined,omitempty"`
	Resource                 string `json:"resource,omitempty"`
	DiagramResource          string `json:"diagramResource,omitempty"`
	StartFormDefined         bool   `json:"startFormDefined,omitempty"`
}

type ActProcessDefinitions ¶

type ActProcessDefinitions struct {
	ProcessDefinitions []ActProcessDefinition `json:"data,omitempty"`
	Total              int                    `json:"total,omitempty"`
	Start              int                    `json:"start,omitempty"`
	Sort               string                 `json:"sort,omitempty"`
	Order              string                 `json:"order,omitempty"`
	Size               int                    `json:"size,omitempty"`
}

type ActProcessInstance ¶

type ActProcessInstance struct {
	ID                   string `json:"id,omitempty"`
	URL                  string `json:"url,omitempty"`
	BusinessKey          string `json:"businessKey,omitempty"`
	Suspended            bool   `json:"suspended,omitempty"`
	ProcessDefinitionUrl string `json:"processDefinitionUrl,omitempty"`
	ActivityId           string `json:"activityId,omitempty"`
	TenantId             string `json:"tenantId,omitempty"`
}

type ActProcessInstances ¶

type ActProcessInstances struct {
	ProcessInstances []ActProcessInstance `json:"data,omitempty"`
	Total            int                  `json:"total,omitempty"`
	Start            int                  `json:"start,omitempty"`
	Sort             string               `json:"sort,omitempty"`
	Order            string               `json:"order,omitempty"`
	Size             int                  `json:"size,omitempty"`
}

type ActStartProcessInstance ¶

type ActStartProcessInstance struct {
	ProcessDefinitionId  string        `json:"processDefinitionId,omitempty"`
	ProcessDefinitionKey string        `json:"processDefinitionKey,omitempty"`
	Message              string        `json:"message,omitempty"`
	BusinessKey          string        `json:"businessKey,omitempty"`
	TenantId             string        `json:"tenantId,omitempty"`
	Variables            []ActVariable `json:"variables,omitempty"`
}

type ActTask ¶

type ActTask struct {
	Assignee          string `json:"assignee,omitempty"`
	CreateTime        string `json:"createTime,omitempty"`
	DelegationState   string `json:"delegationState,omitempty"`
	Description       string `json:"description,omitempty"`
	DueDate           string `json:"dueDate,omitempty"`
	Execution         string `json:"execution,omitempty"`
	Dd                string `json:"id,omitempty"`
	Name              string `json:"name,omitempty"`
	Owner             string `json:"owner,omitempty"`
	ParentTask        string `json:"parentTask,omitempty"`
	Priority          int    `json:"priority,omitempty"`
	ProcessDefinition string `json:"processDefinition,omitempty"`
	ProcessInstance   string `json:"processInstance,omitempty"`
	Suspended         bool   `json:"suspended,omitempty"`
	TaskDefinitionKey string `json:"taskDefinitionKey,omitempty"`
	Url               string `json:"url,omitempty"`
	TenantId          string `json:"tenantId,omitempty"`
}

type ActTasks ¶

type ActTasks struct {
	Tasks []ActTask `json:"data,omitempty"`
	Total int       `json:"total,omitempty"`
	Start int       `json:"start,omitempty"`
	Sort  string    `json:"sort,omitempty"`
	Order string    `json:"order,omitempty"`
	Size  int       `json:"size,omitempty"`
}

type ActUser ¶

type ActUser struct {
	ID         string `json:"id,omitempty"`
	FirstName  string `json:"firstName,omitempty"`
	LastName   string `json:"lastName,omitempty"`
	Email      string `json:"email,omitempty"`
	URL        string `json:"url,omitempty"`
	PictureURL string `json:"pictureUrl,omitempty"`
	Password   string `json:"password,omitempty"`
}

type ActUsers ¶

type ActUsers struct {
	Users []ActUser `json:"data,omitempty"`
	Total int       `json:"total,omitempty"`
	Start int       `json:"start,omitempty"`
	Sort  string    `json:"sort,omitempty"`
	Order string    `json:"order,omitempty"`
	Size  int       `json:"size,omitempty"`
}

type ActVariable ¶

type ActVariable struct {
	Name      string `json:"name,omitempty"`
	Value     string `json:"value,omitempty"`
	Operation string `json:"operation,omitempty"`
	Type      string `json:"type,omitempty"`
}

type JSONTime ¶

type JSONTime time.Time

JSONTime overrides MarshalJson method to format in ISO8601

func (JSONTime) MarshalJSON ¶

func (t JSONTime) MarshalJSON() ([]byte, error)

MarshalJSON for JSONTime

type TaskAction ¶

type TaskAction string

const (
	TASK_ACTION_COMPLETE TaskAction = "complete"
	TASK_ACTION_CLAIM    TaskAction = "claim"
	TASK_ACTION_DELEGATE TaskAction = "delegate"
	TASK_ACTION_RESOLVE  TaskAction = "resolve"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL