web service接口—Java
1 接口详细说明
1.1 接口服务器地址说明
接口参考地址,具体地址和端口需要根据项目实际ip和端口进行配置
地址 | |
组织架构接口 | http://127.0.0.1:21110/Portal/WebServices/Organization?wsdl |
流程接口 | http://127.0.0.1:21112/Portal/WebServices/BPMService?wsdl |
流程节点接口 | http://127.0.0.1:21113/Portal/WebServices/ActivityInfoService?wsdl |
单点登陆接口 | http://127.0.0.1:21111/Portal/WebServices/SSOService?wsdl |
2 Organization接口
2.1 添加OU
接口地址:/WebServices/Organization
方法名称:AddOrgUnit
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
Modifier | 字符串 | 是 | 添加者 | |
ObjectID | 字符串 | 主键(36位) | ||
WeChatID | 整型 | -1 | 微信部门ID | |
DingTalkID | 整型 | -1 | 钉钉ID | |
WorkflowCode | 字符串 | 流程模板编码 | ||
CategoryCode | 字符串 | 组织类型编码 | ||
Name | 字符串 | 是 | 名称 | |
Description | 字符串 | 描述 | ||
CostCenter | 字符串 | 成本中心 | ||
ParentID | 字符串 | 是 | 所属组织ID(36位) | |
ManagerID | 字符串 | 主管ID(36位) | ||
CreatedTime | 日期 | 当前时间 | 创建时间 | |
ModifiedTime | 日期 | 当前时间 | 修改时间 | |
SortKey | 整型 | 100 | 排序值 | |
State | 整型 | 1 | 状态 0 禁用 1 启用 | |
Visibility | 整型 | 5 | 可见类型 1普通可见 2管理员可见 4本组织范围可见 5 全部可见 | |
SourceID | 字符串 | 身份证号码 | ||
CalendarID | 字符串 | 工作日历ID | ||
Extend1 | 字符串 | 扩展1 | ||
Extend2 | 字符串 | 扩展2 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 |
例子:
例子(java) |
String modifier = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 添加者 orgUnit.setObjectID("b862a8cb-bb1b-4ca7-81e1-3f49b008a0f7"); |
2.2 添加组
接口地址:/WebServices/Organization
方法名称:AddGroup
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
Modifier | 字符串 | 是 | 添加者 | |
ObjectID | 字符串 | 主键(36位) | ||
Name | 字符串 | 是 | 组名称 | |
Description | 字符串 | 描述 | ||
CostCenter | 字符串 | 成本中心 | ||
ParentID | 字符串 | 是 | 所属机构(36位) | |
ManagerID | 字符串 | 主管(36位) | ||
CreatedTime | 日期 | 当前时间 | 创建时间 | |
ModifiedTime | 日期 | 当前时间 | 修改时间 | |
SortKey | 整型 | 100 | 排序值 | |
State | 整型 | 1 | 状态 0 禁用 1 启用 | |
Visibility | 整型 | 5 | 可见类型 1普通可见 2管理员可见 4本组织范围可见 5 全部可见 | |
SourceID | 字符串 | 数据源ID(36位) | ||
CalendarID | 字符串 | 工作日历ID(36位) | ||
Extend1 | 字符串 | 扩展1 | ||
Extend2 | 字符串 | 扩展2 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 |
例子:
例子(java) |
String modifier = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 添加者 group.setObjectID("f07360f8-babc-438a-b7d3-349f953b8867"); |
2.3 添加用户
接口地址:/WebServices/Organization
方法名称:AddUser
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
Modifier | 字符串 | 是 | 添加者 | |
ObjectID | 字符串 | 主键(36位) | ||
Code | 字符串 | 是 | 用户编码/登录名(以字母开始,添加成功后不能被修改) | |
Password | 字符串 | 系统默认 | 密码 | |
Appellation | 字符串 | 称谓 | ||
EmployeeNumber | 字符串 | 员工编号 | ||
EmployeeRank | 整型 | 0 | 职级 | |
secretaryID | 字符串 | 秘书 | ||
EntryDate | 日期 | 当前时间 | 入职日期 | |
DepartureDate | 日期 | 当前时间 | 离职日期 | |
ServiceState | 整型 | 0 | 用户服务状态 0在职 1实习 2离职 | |
PrivacyLevel | 整型 | 0 | 隐私级别 0对所有成员开放 1对本部门开放 3完全私密仅管理员和自己查看 | |
IDNumber | 字符串 | 身份证号 | ||
Gender | 整型 | 0 | 性别 0待知 1男 2女 | |
ImageID | 字符串 | 图片ID | ||
ImageUrl | 字符串 | 图片URL | ||
Birthday | 日期 | 当前时间 | 生日 | |
BankProvince | 字符串 | 开户行所在省 | ||
BankCity | 字符串 | 开户行所在城市 | ||
BankName | 字符串 | 开户行名称 | ||
BankAccount | 字符串 | 开户账号 | ||
字符串 | 邮箱 | |||
Mobile | 字符串 | 手机 | ||
WeChatAccount | 字符串 | 微信号 | ||
DingTalkAccount | 字符串 | 钉钉账号 | ||
DingTalkID | 字符串 | DingTalkID | ||
OfficePhone | 字符串 | 办公室电话 | ||
RTX | 字符串 | RTX | ||
字符串 | ||||
Skype | 字符串 | Skype | ||
FacsimileTelephoneNumber | 字符串 | 传真 | ||
PostOfficeBox | 字符串 | 联系地址 | ||
PostalCode | 字符串 | 邮编 | ||
IsAdministrator | 布尔型 | false | 是否管理员 | |
IsConsoleUser | 布尔型 | false | 是否可以登录后台 | |
IsSystemUser | 布尔型 | false | 是否系统内置账户 | |
IsVirtualUser | 布尔型 | false | 是否虚拟用户 | |
RelationUserID | 字符串 | 关联用户(36位) | ||
DoLock | 布尔型 | false | 是否锁住 | |
SID | 字符串 | SID | ||
MobileType | 整型 | 0 | 手机系统类型 0待指定 1安卓 2 IOS 10 其他 | |
JPushID | 字符串 | JPushID | ||
MobileToken | 字符串 | 用户单点登录密钥 | ||
NotifyType | 整型 | 65535 | 接收通知消息类型 0 不接收 1 邮件 2 短信 4 微信 8 APP 16 钉钉 65535 全部 | |
DefaultLanguage | 字符串 | 默认语言 | ||
Name | 字符串 | 姓名 | ||
Description | 字符串 | 描述 | ||
CostCenter | 字符串 | 成本中心 | ||
ParentID | 字符串 | 是 | 所属组织(OU) | |
ManagerID | 字符串 | 主管 | ||
CreatedTime | 日期 | 当前时间 | 创建时间 | |
ModifiedTime | 日期 | 当前时间 | 修改时间 | |
SortKey | 整型 | 排序值 | ||
State | 整型 | 1 | 状态 0 禁用 1 启用 | |
Visibility | 整型 | 5 | 可见类型 1普通可见 2管理员可见 4本组织范围可见 5 全部可见 | |
SourceID | 字符串 | SourceID | ||
CalendarID | 字符串 | 工作日历ID | ||
Extend1 | 字符串 | 扩展1 | ||
Extend2 | 字符串 | 扩展2 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 |
例子:
例子(java) |
User user = new User(); |
2.4 获得OU全名
接口地址:/WebServices/Organization
方法名称:GetFullName
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
unitId | 字符串 | 是 | 组织机构id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 | 成功返回:OU的全名;失败返回:空字符串 |
例子:
例子(java) |
输入:b862a8cb-bb1b-4ca7-81e1-3f49b008a0f7 返回:研发总部 |
2.5 获得OU主管
接口地址:/WebServices/Organization
方法名称:GetManager
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
unitId | 字符串 | 是 | 组织机构id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 | 成功返回:用户的id;失败返回:null |
例子:
例子(java) |
输入:b862a8cb-bb1b-4ca7-81e1-3f49b008a0f7 返回:4d970a34-502c-449e-8d04-4fb88a50a502 |
2.6 获取OU/组/人员的名称
接口地址:/WebServices/Organization
方法名称:GetName
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
unitId | 字符串 | 是 | ou/组/人员id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 | 成功返回:名称;失败返回:null |
例子:
例子(java) |
输入:f07360f8-babc-438a-b7d3-349f953b8867 返回:研发一组 |
2.7 获取上级OU
接口地址:/WebServices/Organization
方法名称:GetParent
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
unitId | 字符串 | 是 | ou/组/人员id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 | 成功返回:上级ou的id;失败返回:null |
例子:
例子(java) |
输入:f07360f8-babc-438a-b7d3-349f953b8867 返回:b862a8cb-bb1b-4ca7-81e1-3f49b008a0f7 |
2.8 判断一个组织是否另一个组织的父级
接口地址:/WebServices/Organization
方法名称:IsAncestor
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
childID | 字符串 | 是 | ou/组/人员id | |
ancestorID | 字符串 | 是 | ou/组id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 | 成功返回:true;失败返回:false |
例子:
例子(java) |
输入:f07360f8-babc-438a-b7d3-349f953b8867,b862a8cb-bb1b-4ca7-81e1-3f49b008a0f7 返回:true |
2.9 添加角色
接口地址:/WebServices/Organization
方法名称:addOrgPost
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
code | 字符串 | 是 | 角色编码(字母开头) | |
name | 字符串 | 是 | 角色名称 | |
modifier | 字符串 | 是 | 添加者 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 | 成功返回:true;失败返回:false |
例子:
例子(java) |
OrgPostView orgPost = new OrgPostView(); |
2.10 更新OU
接口地址:/WebServices/Organization
方法名称:updateOrgUnit
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
ObjectID | 字符串 | 是 | 主键(36位) | |
WeChatID | 整型 | 微信部门ID | ||
DingTalkID | 整型 | 钉钉ID | ||
WorkflowCode | 字符串 | 流程模板编码 | ||
CategoryCode | 字符串 | 组织类型编码 | ||
Name | 字符串 | 是 | 名称 | |
Description | 字符串 | 描述 | ||
CostCenter | 字符串 | 成本中心 | ||
ParentID | 字符串 | 所属组织ID(36位) | ||
ManagerID | 字符串 | 主管ID(36位) | ||
CreatedTime | 日期 | 创建时间 | ||
ModifiedTime | 日期 | 修改时间 | ||
SortKey | 整型 | 排序值 | ||
State | 整型 | 状态 0 禁用 1 启用 | ||
Visibility | 整型 | 可见类型 1普通可见 2管理员可见 4本组织范围可见 5 全部可见 | ||
SourceID | 字符串 | 身份证号码 | ||
CalendarID | 字符串 | 工作日历ID | ||
Extend1 | 字符串 | 扩展1 | ||
Extend2 | 字符串 | 扩展2 |
输出数据描述:
属性名称 | 类型 | 说明 |
code | 整型 | 0成功 -1失败 |
msg | 字符串 | |
data | 对象 |
例子:
例子(java) |
String modifier = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 添加者 orgUnit.setObjectID("b862a8cb-bb1b-4ca7-81e1-3f49b008a0f7"); |
2.11 更新用户
接口地址:/WebServices/Organization
方法名称:updateUser
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
ObjectID | 字符串 | 是 | 主键(36位) | |
Code | 字符串 | 是 | 用户编码/登录名(以字母开始,添加成功后不能被修改) | |
Password | 字符串 | 密码 | ||
Appellation | 字符串 | 称谓 | ||
EmployeeNumber | 字符串 | 员工编号 | ||
EmployeeRank | 整型 | 职级 | ||
secretaryID | 字符串 | 秘书 | ||
EntryDate | 日期 | 入职日期 | ||
DepartureDate | 日期 | 离职日期 | ||
ServiceState | 整型 | 用户服务状态 0在职 1实习 2离职 | ||
PrivacyLevel | 整型 | 隐私级别 0对所有成员开放 1对本部门开放 3完全私密仅管理员和自己查看 | ||
IDNumber | 字符串 | 身份证号 | ||
Gender | 整型 | 性别 0待知 1男 2女 | ||
ImageID | 字符串 | 图片ID | ||
ImageUrl | 字符串 | 图片URL | ||
Birthday | 日期 | 生日 | ||
BankProvince | 字符串 | 开户行所在省 | ||
BankCity | 字符串 | 开户行所在城市 | ||
BankName | 字符串 | 开户行名称 | ||
BankAccount | 字符串 | 开户账号 | ||
字符串 | 邮箱 | |||
Mobile | 字符串 | 手机 | ||
WeChatAccount | 字符串 | 微信号 | ||
DingTalkAccount | 字符串 | 钉钉账号 | ||
DingTalkID | 字符串 | DingTalkID | ||
OfficePhone | 字符串 | 办公室电话 | ||
RTX | 字符串 | RTX | ||
字符串 | ||||
Skype | 字符串 | Skype | ||
FacsimileTelephoneNumber | 字符串 | 传真 | ||
PostOfficeBox | 字符串 | 联系地址 | ||
PostalCode | 字符串 | 邮编 | ||
IsAdministrator | 布尔型 | 是否管理员 | ||
IsConsoleUser | 布尔型 | 是否可以登录后台 | ||
IsSystemUser | 布尔型 | 是否系统内置账户 | ||
IsVirtualUser | 布尔型 | 是否虚拟用户 | ||
RelationUserID | 字符串 | 关联用户(36位) | ||
DoLock | 布尔型 | 是否锁住 | ||
SID | 字符串 | SID | ||
MobileType | 整型 | 手机系统类型 0待指定 1安卓 2 IOS 10 其他 | ||
JPushID | 字符串 | JPushID | ||
MobileToken | 字符串 | 用户单点登录密钥 | ||
NotifyType | 整型 | 接收通知消息类型 0 不接收 1 邮件 2 短信 4 微信 8 APP 16 钉钉 65535 全部 | ||
DefaultLanguage | 字符串 | 默认语言 | ||
Name | 字符串 | 姓名 | ||
Description | 字符串 | 描述 | ||
CostCenter | 字符串 | 成本中心 | ||
ParentID | 字符串 | 所属组织(OU) | ||
ManagerID | 字符串 | 主管 | ||
CreatedTime | 日期 | 创建时间 | ||
ModifiedTime | 日期 | 修改时间 | ||
SortKey | 整型 | 排序值 | ||
State | 整型 | 状态 0 禁用 1 启用 | ||
Visibility | 整型 | 可见类型 1普通可见 2管理员可见 4本组织范围可见 5 全部可见 | ||
SourceID | 字符串 | SourceID | ||
CalendarID | 字符串 | 工作日历ID | ||
Extend1 | 字符串 | 扩展1 | ||
Extend2 | 字符串 | 扩展2 |
输出数据描述:
属性名称 | 类型 | 说明 |
code | 整型 | 0成功 -1失败 |
msg | 字符串 | |
data | 对象 |
例子:
例子(java) |
User user = new User(); |
3 BPMService 接口
3.1 启动H3流程实例,设置主键数据项的值
接口地址:/WebServices/BPMService
方法名称:StartWorkflowWithKey
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
workflowCode | 字符串 | 是 | 流程模板编码 | |
userCode | 字符串 | 是 | 启动流程的用户编码 | |
finishStart | 罗辑型 | 是 | 是否结束第一个活动 | |
keyName | 字符串 | 数据项 | ||
keyValue | 字符串 | 数据项值 |
输出数据描述:
属性名称 | 类型 | 说明 |
success | 罗辑型 | true 成功 fale 失败 |
instanceId | 字符串 | 流程实例id |
message | 字符串 | 消息 |
workItemId | 字符串 | 任务id |
workItemUrl | 字符串 | 任务url |
sequenceNo | 字符串 | 流水号 |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 输出: {"success":true,"instanceId":"3dc1192f-312a-4f85-b292-1548fb3b93b7","message":"流程实例启动成功!","workItemId":null,"workItemUrl":"","sequenceNo":null} |
3.2 激活指定的活动节点
接口地址:/WebServices/BPMService
方法名称:ActiveToken
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
instanceId | 字符串 | 是 | 流程实例ID | |
activityCode | 字符串 | 是 | 活动节点 | |
participants | 字符串 | 指定参与者(参与者编码以逗号分割),如果为空那么取流程默认配置 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 罗辑型 | true 成功 fale 失败 |
例子:
例子(java) |
String systemCode = "H3"; // 系统编码 |
3.3 取消指定的活动节点
接口地址:/WebServices/BPMService
方法名称:CancelToken
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
instanceId | 字符串 | 是 | 流程实例ID | |
activityCode | 字符串 | 是 | 活动节点 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 罗辑型 | true 成功 fale 失败 |
例子:
例子(java) |
String systemCode = "H3"; // 系统编码 |
3.4 获取用户的已办任务总数
接口地址:/WebServices/BPMService
方法名称:GetUserFinishedWorkItemCount
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户ID |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 整型 | 返回已办任务总数 |
例子:
例子(java) |
String systemCode = "H3"; // 系统编码 String userId = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 用户id |
3.5 获取用户的待办任务总数
接口地址:/WebServices/BPMService
方法名称:GetUserUnfinishedWorkItemCount
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户ID |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 整型 | 返回待办任务总数 |
例子:
例子(java) |
String systemCode = "H3"; // 系统编码 String userId = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 用户id |
3.6 获取发起流程模板
接口地址:/WebServices/BPMService
方法名称:GetWorkfowNodeByUser
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userCode | 字符串 | 是 | 用户编码 | |
showFavorite | 逻辑型 | 是 | 是否常用 | |
isMobile | 逻辑型 | 是 | 是否移动端 | |
parentCode | 字符串 | 父流程编码 | ||
searchKey | 字符串 | 搜索关键字 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 | 返回JSON字符串(List<WorkflowNode>) |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String userCode = "administrator"; // 用户编码 输出: [{"children":null,"DisplayName":"表单控件","Version":1,"Icon":"icon-liuchengmoxing","PublishedTime":"2019/01/07","Code":"bdkj","IsLeaf":true,"IconFileName":null,"ObjectID":"5f775a46-4278-4ed6-b68d-6fd005cd0069","Frequent":0}] |
3.7 获取用户待阅任务
方法名称:GetUnReadWorkItems
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户ID | |
startTime | 日期 | 是 | 开始时间 | |
endTime | 日期 | 是 | 结束时间 | |
startIndex | 整型 | 是 | 开始索引 >0 (或-1) | |
endIndex | 整型 | 是 | 结束索引 >0 (或-1) | |
workflowCode | 字符串 | 流程模板编码 | ||
instanceName | 字符串 | 流程实例名称 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 列表 | List<CirculateItemViewModel> |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String userId = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 用户id Calendar calendar = Calendar.getInstance(); 输出: [{"assistantFinished":false,"assisted":false,"baseObjectID":"d9abecdf-85d1-4eb3-98ea-2b6c7d8ec5e3","circulateCreator":"18f923a7-5a5e-426d-94ae-a55ad1a4b239","circulateCreatorName":"系统管理员","consultantFinished":false,"consulted":false,"displayName":"传阅","displayWorkflowCode":false,"finishTime":"1970-01-01 00:00","instanceCreatedTime":"2019-02-01 16:56:59","instanceId":"d2b7d9b5-cac8-45ec-9d19-9b4e5928f681","instanceName":"测试中文.12","instanceSequenceNo":"2019TD0000000030","instanceState":"2","itemCount":"","originator":"18f923a7-5a5e-426d-94ae-a55ad1a4b239","originatorName":"系统管理员","originatorOUName":"我的公司","participant":"18f923a7-5a5e-426d-94ae-a55ad1a4b239","participantName":"系统管理员","planFinishTime":"","priority":"","receiveTime":"2019-02-01 16:57","state":0,"stayTime":{"days":0,"hours":0,"milliseconds":0,"minutes":0,"seconds":0,"ticks":0},"urged":false,"workflowCode":"TD","workflowName":""}] |
3.8 输出日志至引擎服务器
接口地址:/WebServices/BPMService
方法名称:WriteLog
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
message | 字符串 | 是 | 日志信息 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 |
例子:
例子(java) |
String systemCode = "H3"; // 系统编码 |
3.9 激活流程
接口地址:/WebServices/BPMService
方法名称:ActiveInstance
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
instanceId | 字符串 | 是 | 流程实例id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 罗辑型 | true 成功 fale 失败 |
例子:
例子(java) |
String systemCode = "H3"; // 系统编码 |
3.10 获取用户已阅任务总数
接口地址:/WebServices/BPMService
方法名称:GetUserReadedWorkItemCount
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 流程实例id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 整型 |
例子:
例子(java) |
String systemCode = "H3"; // 系统编码 String userId = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 用户id |
3.11 获取用户待阅任务总数
接口地址:/WebServices/BPMService
方法名称:GetUserUnReadWorkItemCount
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 流程实例id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 整型 |
例子:
例子(java) |
String systemCode = "H3"; // 系统编码 String userId = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 用户id |
3.12 查询用户已阅任务
接口地址:/WebServices/BPMService
方法名称:GetReadWorkItems
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户ID | |
startTime | 日期 | 是 | 开始时间 | |
endTime | 日期 | 是 | 结束时间 | |
startIndex | 整型 | 是 | 开始索引 >0 (或-1) | |
endIndex | 整型 | 是 | 结束索引 >0 (或-1) | |
workflowCode | 字符串 | 流程模板编码 | ||
instanceName | 字符串 | 流程实例名称 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 列表 | List<CirculateItemViewModel> |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String userId = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 用户id Calendar calendar = Calendar.getInstance(); 输出: [{"assistantFinished":false,"assisted":false,"baseObjectID":"49ab125c-7009-4699-af2e-a9a8b5be0af4","circulateCreator":"7a6d4da8-d22f-439d-9f71-0572c365eacd","circulateCreatorName":"员工B","consultantFinished":false,"consulted":false,"displayName":"审批","displayWorkflowCode":false,"finishTime":"2019-01-04 10:51","instanceCreatedTime":"2019-01-04 10:46:12","instanceId":"c6dfb9e3-2e46-4023-9b76-d380da54cece","instanceName":"流程显示.3","instanceSequenceNo":"2019test010000000001","instanceState":"2","itemCount":"","originator":"7a6d4da8-d22f-439d-9f71-0572c365eacd","originatorName":"员工B","originatorOUName":"我的公司","participant":"18f923a7-5a5e-426d-94ae-a55ad1a4b239","participantName":"系统管理员","planFinishTime":"","priority":"","receiveTime":"2019-01-04 10:50","state":0,"stayTime":{"days":0,"hours":0,"milliseconds":0,"minutes":0,"seconds":0,"ticks":0},"urged":false,"workflowCode":"test01","workflowName":""}] |
3.13 获取两个日期之间的总天数
接口地址:/WebServices/BPMService
方法名称:GetDays
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
startDate | 日期 | 是 | 开始日期 | |
endDate | 日期 | 是 | 结束日期 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 浮点型 |
3.14 查询用户已办任务
接口地址:/WebServices/BPMService
方法名称:GetFinishWorkItems
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户ID | |
startTime | 日期 | 是 | 开始时间 | |
endTime | 日期 | 是 | 结束时间 | |
startIndex | 整型 | 是 | 开始索引 >0 (或-1) | |
endIndex | 整型 | 是 | 结束索引 >0 (或-1) | |
workflowCode | 字符串 | 流程模板编码 | ||
instanceName | 字符串 | 流程实例名称 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 列表 | List<WorkItemViewModel> |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String userId = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 用户id Calendar calendar = Calendar.getInstance(); 输出: [{"activityCode":"Activity2","assistantFinished":false,"assisted":false,"baseObjectID":"add01151-8390-486e-875c-4d8d6f7fb1ba","circulateCreator":"","circulateCreatorName":"","consultantFinished":false,"consulted":false,"displayName":"手工","displayWorkflowCode":false,"finishTime":"2019-02-01 16:57:00","instanceCreatedTime":"2019-02-01 16:56:59","instanceId":"d2b7d9b5-cac8-45ec-9d19-9b4e5928f681","instanceName":"测试中文.12","instanceSequenceNo":"2019TD0000000030","instanceState":"2","itemCount":"","itemSummary":"","originator":"18f923a7-5a5e-426d-94ae-a55ad1a4b239","originatorName":"系统管理员","originatorOUName":"我的公司","participant":"18f923a7-5a5e-426d-94ae-a55ad1a4b239","participantName":"系统管理员","planFinishTime":"9998-12-31 00:00:00","priority":"1","receiveTime":"2019-02-01 16:57","state":0,"stayTime":{"days":2914602,"hours":4,"milliseconds":0,"minutes":13,"seconds":53,"ticks":2518216280330000000},"urged":false,"workflowCode":"TD","workflowName":"测试中文"}] |
3.15 发起流程
接口地址:/WebServices/BPMService
方法名称:StartWorkflowNew
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
workflowCode | 字符串 | 是 | 流程模板编码 | |
userCode | 字符串 | 是 | 用户编码 | |
finishStart | 字符串 | 是 | 是否结束第一个活动 | |
paramValues | 字符串 | 流程实例启动初始化数据项集合(JSON格式) |
输出数据描述:
属性名称 | 类型 | 说明 |
success | 逻辑型 | 流程启动是否成功 |
instanceID | 字符串 | 启动的流程实例ID |
message | 字符串 | 系统返回消息 |
workItemID | 字符串 | 任务id |
workItemUrl | 字符串 | 任务url |
sequenceNo | 字符串 | 流水号 |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 输出: {"instanceId":"8ac2386a-7846-411a-bbd1-a538f4e666d3","message":"流程实例启动成功!","sequenceNo":"","success":true,"workItemId":"","workItemUrl":""} |
3.16 结束流程
接口地址:/WebServices/BPMService
方法名称:FinishInstance
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
instanceID | 字符串 | 是 | 流程实例id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 逻辑型 | true为成功,false为不成功 |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 输出: true |
3.17 提交工作任务
接口地址:/WebServices/BPMService
方法名称:SubmitWorkItem
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户id | |
workItemId | 字符串 | 是 | 工作任务节点的id | |
commentText | 字符串 | 提交的内容 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 逻辑型 | true为成功,false为不成功 |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 输出: true |
3.18 获取待办任务
接口地址:/WebServices/BPMService
方法名称:GetUnFinishWorkItems
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户ID | |
startTime | 日期 | 是 | 开始时间 | |
endTime | 日期 | 是 | 结束时间 | |
startIndex | 整型 | 是 | 开始索引 >0 (或-1) | |
endIndex | 整型 | 是 | 结束索引 >0 (或-1) | |
workflowCode | 字符串 | 流程模板编码 | ||
instanceName | 字符串 | 流程实例名称 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 列表 | List<WorkItemViewModel> |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String userId = "18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 用户id Calendar calendar = Calendar.getInstance(); 输出: [{"activityCode":"Activity2","assistantFinished":false,"assisted":false,"baseObjectID":"70937e72-6474-4a1f-929a-b32b45ab39e8","circulateCreator":"","circulateCreatorName":"","consultantFinished":false,"consulted":false,"displayName":"手工","displayWorkflowCode":false,"finishTime":"1970-01-01 00:00:00","instanceCreatedTime":"2019-01-26 16:37:31","instanceId":"a37c0322-ebdd-4c63-a327-fe27d9e57d1d","instanceName":"","instanceSequenceNo":"20190000000008","instanceState":"2","itemCount":"","itemSummary":"","originator":"18f923a7-5a5e-426d-94ae-a55ad1a4b239","originatorName":"系统管理员","originatorOUName":"我的公司","participant":"18f923a7-5a5e-426d-94ae-a55ad1a4b239","participantName":"系统管理员","planFinishTime":"9998-12-31 00:00:00","priority":"1","receiveTime":"2019-01-26 16:37","state":0,"stayTime":{"days":2914602,"hours":3,"milliseconds":0,"minutes":12,"seconds":30,"ticks":2518216243500000000},"urged":false,"workflowCode":"bdkj","workflowName":"表单控件"}] |
3.19 设置单个流程数据项的值
接口地址:/WebServices/BPMService
方法名称:SetItemValue
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户id(36位) | |
bizObjectSchemaCode | 字符串 | 是 | 业务编码 | |
bizObjectId | 字符串 | 是 | 业务实例id | |
keyName | 字符串 | 是 | 数据项 | |
keyValue | 字符串 | 是 | 数据项的值 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 逻辑型 | 是否更新成功(true为成功,false为不成功) |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 输出: true |
3.20 设置批量流程数据项的值
接口地址:/WebServices/BPMService
方法名称:SetItemValues
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户id(36位) | |
bizObjectSchemaCode | 字符串 | 是 | 业务编码 | |
bizObjectId | 字符串 | 是 | 业务实例id | |
keyValues | 集合 | 是 | 数据项,List<DataItemParam>对象 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 逻辑型 | 是否更新成功(true为成功,false为不成功) |
例子:
例子(java) |
输入: String modifier="18f923a7-5a5e-426d-94ae-a55ad1a4b239"; // 添加者 String bizObjectId = "842b2470-4647-4de2-b901-a4b720a03f21"; // 业务实例id List<DataItemParam> keyValues = new ArrayList<>(); keyValues.add(new DataItemParam("days", 2)); 输出: true |
3.21 取回工作任务
接口地址:/WebServices/BPMService
方法名称:RetrieveWorkItem
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户id | |
workItemId | 字符串 | 是 | 工作任务节点的id |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 逻辑型 | true为成功,false为不成功 |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 输出: true |
3.22 驳回工作任务
接口地址:/WebServices/BPMService
方法名称:ReturnWorkItem
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
userId | 字符串 | 是 | 用户id | |
workItemId | 字符串 | 是 | 工作任务节点的id | |
commentText | 字符串 | 提交的内容 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 逻辑型 | true为成功,false为不成功 |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 输出: true |
3.23 上传附件
接口地址:/WebServices/BPMService
方法名称:UploadAttachmentFile
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码 | |
secret | 字符串 | 是 | 系统秘钥 | |
createId | 字符串 | 是 | 用户id(36位) | |
bizObjectSchemaCode | 字符串 | 是 | 业务编码 | |
bizObjectId | 字符串 | 是 | 业务实例id | |
dataField | 字符串 | 是 | 业务模型字段 | |
fileName | 字符串 | 是 | 文件名 | |
contentType | 字符串 | 是 | 文件类型(image/jpeg) | |
size | 整型 | 是 | 文件大小 | |
content | 数组 | 是 | 文件的内容数组bytes |
输出数据描述:
属性名称 | 类型 | 说明 |
code | 整型 | 0成功 -1失败 |
msg | 字符串 | 错误消息 |
data | 对象 | 成功返回文件的ObjectID |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String fileName = "葫芦娃.jpg"; String contentType = "image/jpeg"; //文件类型(image/jpeg, image/png等) int size = 23258; 输出: code=0, msg=null, data="20befd68-fba7-4608-9355-0147346e7351" |
4 ActivityInfoService 接口
4.1 获取所有流程节点信息
接口地址:/WebServices/ActivityInfoService
方法名称:GetAllActivityInfo
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码(由SSO服务提供) | |
secret | 字符串 | 是 | 系统秘钥 | |
instanceId | 字符串 | 是 | 流程实例id |
输出数据描述:
属性名称 | 类型 | 说明 |
code | 整型 | 0成功 -1失败 |
msg | 字符串 | 错误消息 |
data | 对象 | 成功时返回List<RouteInfo> |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String instanceId = "a440806a-3ea7-4d2f-b8e1-22551d25e1df"; // 流程实例Id 输出: {"code":0,"data":"[{\\\"activityCode\\\":\\\"Activity2\\\",\\\"activityName\\\":\\\"手工\\\",\\\"participantName\\\":\\\"系统管理员\\\",\\\"startActivity\\\":false},{\\\"activityCode\\\":\\\"Activity3\\\",\\\"activityName\\\":\\\"审批\\\",\\\"participantName\\\":\\\"系统管理员\\\",\\\"startActivity\\\":false},{\\\"activityCode\\\":\\\"Activity4\\\",\\\"activityName\\\":\\\"结束\\\",\\\"startActivity\\\":false}]","msg":""} |
4.2 获取下一个活动节点信息
接口地址:/WebServices/ActivityInfoService
方法名称:GetNextActivityInfo
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码(由SSO服务提供) | |
secret | 字符串 | 是 | 系统秘钥 | |
instanceId | 字符串 | 是 | 流程实例id |
输出数据描述:
属性名称 | 类型 | 说明 |
code | 整型 | 0成功 -1失败 |
msg | 字符串 | 错误消息 |
data | 对象 | 成功时返回List<RouteInfo> |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String instanceId = "a440806a-3ea7-4d2f-b8e1-22551d25e1df"; // 流程实例Id 输出: {"code":0,"data":"{\\\"activityCode\\\":\\\"Activity4\\\",\\\"activityName\\\":\\\"结束\\\",\\\"startActivity\\\":false}","msg":""} |
4.3 查询流程节点信息
接口地址:/WebServices/ActivityInfoService
方法名称:GetActivityInfo
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码(由SSO服务提供) | |
secret | 字符串 | 是 | 系统秘钥 | |
instanceId | 字符串 | 是 | 流程实例id |
输出数据描述:
属性名称 | 类型 | 说明 |
code | 整型 | 0成功 -1失败 |
msg | 字符串 | 错误消息 |
data | 对象 | 成功时返回List<RouteInfo> |
例子:
例子(java) |
输入: String systemCode = "H3"; // 系统编码 String instanceId = "a440806a-3ea7-4d2f-b8e1-22551d25e1df"; // 流程实例Id String activityCode = "Activity3"; // 节点编码 输出: {"code":0,"data":"{\\\"activityCode\\\":\\\"Activity3\\\",\\\"activityName\\\":\\\"审批\\\",\\\"participantName\\\":\\\"系统管理员\\\",\\\"startActivity\\\":false}","msg":""} |
5 SSOService接口
5.1 用户登陆验证
接口地址:/WebServices/SSOService
方法名称:ValidateUser
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码(由SSO服务提供) | |
secret | 字符串 | 是 | 系统秘钥 | |
userName | 字符串 | 是 | 登陆账号 | |
password | 字符串 | 是 | 登陆密码(MD5加密) |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 逻辑型 | 是否更新成功(true为成功,false为不成功) |
5.2 根据Token获取用户信息
接口地址:/WebServices/SSOService
方法名称:GetAuthenticationUser
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码(由SSO服务提供) | |
secret | 字符串 | 是 | 系统秘钥 | |
token | 字符串 | 是 | 单点登录信息 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 | 成功返回用户userCode |
5.3 更新密钥
接口地址:/WebServices/SSOService
方法名称:UpdateSec
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码(由SSO服务提供) | |
secret | 字符串 | 是 | 系统秘钥 | |
newSecret | 字符串 | 是 | 新密钥 |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 逻辑型 | 是否更新成功(true为成功,false为不成功) |
5.4 获取可以单点登陆到其他系统的URL
接口地址:/WebServices/SSOService
方法名称:SSOSystemUrl
输入参数描述:
参数名称 | 类型 | 必填 | 默认值 | 说明 |
systemCode | 字符串 | 是 | 系统编码(由SSO服务提供) | |
secret | 字符串 | 是 | 系统秘钥 | |
userCode | 字符串 | 是 | 当前已认证的系统用户帐号 | |
targetsystemCode | 字符串 | 是 | 目标系统编码 | |
targetUrl | 字符串 | 是 | 目标url |
输出数据描述:
属性名称 | 类型 | 说明 |
返回值 | 字符串 |
6 消息码
序号 | 消息码 | 说明 |
1 | SUCCESS | 成功 |
2 | PARAM_IS_NULL | 参数为空 |
3 | CODE_INVALID | 编码字段不合法 |
4 | ID_REDUPLICATE | ID重复 |
5 | ID_INVALIDATE | ID不合法 |
6 | GUID_REDUPLICATE | Guid重复 |
7 | EXTERNAL_ID_REDUPLICATE | ExternalID重复 |
8 | MANAGER_INVALIDATE | 管理员属性不合法 |
9 | VICE_MANAGER_INVALIDATE | 副管理员不合法 |
10 | SECRETARY_INVALIDATE | 秘书不合法 |
11 | PARENT_NULL | 父属性不合法,为空或者不存在 |
12 | COMPANY_INVALIDATE | 公司属性不合法,为空或者不存在 |
13 | GROUP_CHILD_INVALIDATE | GROUP中包含的子单元不合法 |
14 | UNIT_ID_INVALIDATE | Unit的ID不合法 |
15 | ORGANIZATION_UNIT_CYCLE_INVALIDATE | 组织单元形成了环,不合法 |
16 | CANNT_ITERATE_TO_COMPANY | 无法路由的根 |
17 | COMPANY_INCONSISTENT | 公司不一致 |
18 | COMPANY_NOT_EXIST | 公司不存在 |
19 | TITLE_NAME_NULL | 头衔的名称为空 |
20 | UNIT_NOT_EXIST | 组织不存在 |
21 | TITLE_NAME_DUPLICATE | 头衔名称重复 |
22 | NOT_SUPPORT_UNIT | 不支持的类型 |
23 | ACTIVE_DIRECTORY_NOT_CONNECTED | 无法连接活动目录 |
24 | ACTIVE_DIRECTORY_ROOT_SHOULD_BE_DNS_OR_OU | 要导入的AD根节点必须是DNS或者OU |
25 | LOGIN_ACTIVE_DIRECTORY_FAILED | 登录活动目录失败 |
26 | UNKNOWN_ERROR | 待知的错误 |
27 | SYNCHRONING | 正在同步 |
28 | CYCLE_INVALIDATE | 存在环 |
29 | CHILD_NOT_ALLOW_BELONG_TO_MULTI_GROUP | 子元素不允许同时存在多个组中 |
30 | USER_ALIAS_NOT_EXIST_IN_AD | 用户在AD中不存在 |
31 | NAME_INVALID | 名称不合法 |
32 | NAME_REDUPLICATE | 名称重复 |
33 | PARENT_MUST_BE_OU_OR_COMPANY | 父对象必须为OU或公司 |
34 | CODE_DUPLICATE | 组织的编码存在重复 |
35 | CODE_IS_NULL | 组织的编码为空 |
36 | EMPLOYEE_NUMBER_DUPLICATE | 员工编号存在重复 |
37 | POST_NOT_EXIST | 岗位不存在 |
38 | POST_TEMPLATE_NOT_EXIST | 职位不存在 |
39 | POST_TEMPLATE_DUPLICATED | 职位定义重复 |
40 | POST_DUPLICATED | 岗位重复 |
41 | STAFF_PARENT_MUST_BE_POST | 编制的父组织必须是岗位 |
42 | STATE_VALUE | 状态码错误 |
43 | VISIBLE_TYPE_VALUE | 可见码错误 |
44 | GENDER_VALUE | 性别码错误 |
45 | MOBILE_TYPE_VALUE | 移动码错误 |
46 | PRIVACY_LEVEL_VALUE | 隐私码错误 |
47 | USER_SERVICE_STATE_VALUE | 用户状态码错误 |
48 | USERCODE_NOT_EQUALS | 用户编码不一致 |
49 | PARENTID_IS_NULL | 父节点为空 |
50 | OU_NOT_EXISTS | OU不存在 |
51 | OPERATE_ERROR | 操作错误 |
52 | CODE_ERROT_UNIT_EXIST | 单元已经存在 |
7 WorkflowNode
属性 | 类型 | 说明 |
ObjectID | 字符串 | 节点Id |
Code | 字符串 | 节点编码 |
DisplayName | 字符串 | 节点显示名称 |
PublishedTime | 日期 | 流程发布时间 |
Version | 整型 | 流程版本号 |
Frequent | 整型 | 是否常用流程(0 否,1 是) |
IconFileName | 字符串 | 图标文件名称 |
Icon | 字符串 | 图标字体 |
IsLeaf | 布尔值 | 是否流程节点(0:否,1 是) |
children | 列表 | List<WorkflowNode> |
8 CirculateItemViewModel
属性 | 类型 | 说明 |
Participant | 字符串 | 参与者id |
ParticipantName | 字符串 | 参与者名称 |
Originator | 字符串 | 流程发起人 |
OriginatorName | 字符串 | 发起人姓名 |
OriginatorOUName | 字符串 | 发起人所在OU名称 |
InstanceName | 字符串 | 流程实例名称 |
DisplayName | 字符串 | 活动名称 |
ReceiveTime | 日期 | 工作任务接收时间 |
PlanFinishTime | 日期 | 工作任务计划完成时间 |
FinishTime | 日期 | 工作任务完成时间 |
InstanceId | 字符串 | 流程实例ID |
InstanceCreatedTime | 日期 | 流程创建时间 |
WorkflowCode | 字符串 | 流程模板编码WorkflowCode |
WorkflowName | 字符串 | 流程实例WorkflowName |
ItemCount | 字符串 | 流程模板的流程数(待办任务分组模式) |
DisplayWorkflowCode | 布尔值 | 表中表是否展示(待办任务分组模式) |
Priority | 字符串 | 工作任务紧急程度 |
State | 数字 | 工作任务状态 |
Urged | 布尔值 | 当前任务是否被催办 |
Assisted | 布尔值 | 当前任务是否有协办 |
AssistantFinished | 布尔值 | 当前任务是否协办已完成 |
Consulted | 布尔值 | 当前任务是否有征询意见 |
ConsultantFinished | 布尔值 | 当前任务是否征询已完成 |
CirculateCreator | 字符串 | 传阅人ID |
CirculateCreatorName | 字符串 | 传阅人Name |
StayTime | 字符串 | 流程实例运行时长(滞留时间) |
AssistantFinished | 布尔值 | 当前任务是否协办已完成 |
Assisted | 布尔值 | 当前任务是否有协办 |
BaseObjectID | 字符串 | 任务ID |
9 WorkItemViewModel
属性 | 类型 | 说明 |
Participant | 字符串 | 参与者id |
ParticipantName | 字符串 | 参与者名称 |
Originator | 字符串 | 流程发起人 |
OriginatorName | 字符串 | 发起人姓名 |
OriginatorOUName | 字符串 | 发起人所在OU名称 |
InstanceName | 字符串 | 流程实例名称 |
ActivityCode | 字符串 | 活动编码 |
DisplayName | 字符串 | 活动名称 |
ReceiveTime | 日期 | 工作任务接收时间 |
PlanFinishTime | 日期 | 工作任务计划完成时间 |
FinishTime | 日期 | 工作任务完成时间 |
InstanceId | 字符串 | 流程实例ID |
InstanceCreatedTime | 日期 | 流程创建时间 |
WorkflowCode | 字符串 | 流程模板编码WorkflowCode |
WorkflowName | 字符串 | 流程实例WorkflowName |
ItemCount | 字符串 | 流程模板的流程数(待办任务分组模式) |
DisplayWorkflowCode | 布尔值 | 表中表是否展示(待办任务分组模式) |
Priority | 字符串 | 工作任务紧急程度 -1 Unspecified,待指定的优先级,这个主要是为了方便查询; 0 Low,低优先级; 1 Normal,普通优先级; 2 High,高优先级; |
State | 数字 | 工作任务状态 -1 Unspecified,待指定的状态,这个主要是为了方便查询; 0 Waiting,处于等待的状态; 1 处于正在工作中的状态; 2 Finished,处于完成状态; 3 Canceled,已经被取消; 4 Unfinished,这个并不属于WorkItem本身的状态,只是为了方便进行查询,他指Waiting或者Working状态; 5 NotCanceled,这个并不属于WorkItem本身的状态,只是为了方便进行查询,待被取消的状态,指Waiting、Working或者Finished状态 |
Urged | 布尔值 | 当前任务是否被催办 |
Assisted | 布尔值 | 当前任务是否有协办 |
AssistantFinished | 布尔值 | 当前任务是否协办已完成 |
Consulted | 布尔值 | 当前任务是否有征询意见 |
ConsultantFinished | 布尔值 | 当前任务是否征询已完成 |
CirculateCreator | 字符串 | 传阅人ID |
CirculateCreatorName | 字符串 | 传阅人Name |
StayTime | 字符串 | 流程实例运行时长(滞留时间) |
ItemSummary | 字符串 | 任务节点摘要信息 |
AssistantFinished | 布尔值 | 当前任务是否协办已完成 |
Assisted | 布尔值 | 当前任务是否有协办 |
BaseObjectID | 字符串 | 任务ID |
10 DataItemParam
属性 | 类型 | 说明 |
itemName | 字符串 | 数据项名称 |
itemValue | 对象 | 数据项的值 |
11 RouteInfo
属性 | 类型 | 说明 |
ActivityCode | 字符串 | 节点编码 |
ActivityName | 字符串 | 节点名称 |
ParticipantName | 字符串 | 参与者姓名 |
startActivity | 罗辑型 | 是否第一个节点 |