第1页 / 共76页
第2页 / 共76页
第3页 / 共76页
第4页 / 共76页
第5页 / 共76页
第6页 / 共76页
第7页 / 共76页
第8页 / 共76页
致远A8-M平台API参考手册.pdf
A8-m平台API参考手册
修改记录
1. 服务参考
1.1 概述
1.1.1 启用webservice
1.1.2 配置开发环境
1.1.3 开始编码（Java）
1.1.3.1 生成ADB Client Stub
1.1.3.2 编写客户端代码
1.1.4 开始编码（C#）
1.1.4.1 添加服务引用
1.1.4.2 编写客户端代码
1.1.5 服务列表
1.1.6 服务公共实体
1.1.6.1 服务响应实体（ServiceResponse）
1.1.6.2 服务异常（ServiceException）
1.2 验证服务
1.2.1 登录验证
1.2.1.1 身份验证令牌实体（UserToken）
1.2.1.2 身份验证
1.3 组织模型管理
1.3.1 单位管理
1.3.1.1 单位实体(AccountInfoParam_All)
1.3.1.2 方法列表
1.3.1.3 取得单位ID
1.3.1.4 获取单位信息
1.3.1.5 删除单位
1.3.1.6 修改单位信息
1.3.2 人员管理
1.3.2.1 人员实体（PersonInfoParam_All）
1.3.2.2 方法列表
1.3.2.3 创建人员
1.3.2.4 获取人员信息
1.3.2.5 修改人员信息（按ID）
1.3.2.6 修改人员信息（按登录名）
1.3.2.7 修改人员信息(按编码)
1.3.2.8 删除人员(按ID)
1.3.2.9 删除人员（按登录名）
1.3.2.10 启用/停用人员(按ID)
1.3.2.11 启用/停用人员(按登录名)
1.3.2.12 修改人员密码(按ID)
1.3.2.13 修改人员密码(按登录名)
1.3.2.14 删除人员
1.3.3 部门管理
1.3.3.1 部门实体 （DepartmentInfoParam_All）
1.3.3.2 方法列表
1.3.3.3 创建部门
1.3.3.4 更新部门（按ID）
1.3.3.5 更新部门（按路径名称）
1.3.3.6 修改部门信息(按编码)
1.3.3.7 删除部门（按ID）
1.3.3.8 删除部门（按名称）
1.3.3.9 删除部门（按名称及父部门名称）
1.3.3.10 删除部门（按部门路径名称）
1.3.3.11 删除部门（按编码）
1.3.3.12 启用/禁用部门（按ID）
1.3.3.13 启用/禁用部门（按名称）
1.3.3.14 启用/禁用部门（按名称及父部门名称）
1.3.3.15 启用/禁用部门（按路径名称）
1.3.3.16 移动部门（按ID）
1.3.3.17 移动部门（按名称）
1.3.3.18 获取部门信息
1.3.4 岗位管理
1.3.4.1 岗位实体 （OcupationInfoParam_A8_All）
1.3.4.2 方法列表
1.3.4.3 创建岗位
1.3.4.4 更新岗位（按ID）
1.3.4.5 更新岗位（按名称）
1.3.4.6 修改岗位信息（按编码）
1.3.4.7 删除岗位（按ID）
1.3.4.8 删除岗位（按名称）
1.3.4.9 删除岗位（按编码）
1.3.4.10 启用/禁用岗位（按ID）
1.3.4.11 启用/禁用岗位（按名称）
1.3.4.12 获取岗位信息
1.3.5 职务级别管理
1.3.5.1 职务级别实体 （OtypeInfoParam_A8_All）
1.3.5.2 方法列表
1.3.5.3 创建职务级别
1.3.5.4 更新职务级别（按职务级别ID）
1.3.5.5 更新职务级别（按职务级别名称）
1.3.5.6 删除职务级别（按职务级别ID）
1.3.5.7 删除职务级别（按职务级别名称）
1.3.5.8 启用/禁用职务级别（按职务级别ID）
1.3.5.9 启用/禁用职务级别（按职务级别名称）
1.4 组织模型数据管理
1.4.1 方法列表
1.4.2 导出人员信息
1.4.3 导出部门信息
1.4.4 导出岗位信息
1.4.5 导出职务级别信息
1.4.6 导出组织模型信息
1.4.7 导入组织模型信息
1.5 文档导出
1.5.1 方法列表
1.5.2 文档导出公共实体
1.5.2.1 人员实体（PersonExport）
1.5.2.2 部门实体（DepartmentExport）
1.5.2.3 岗位实体（OcupationExport）
1.5.2.4 职务级别实体（OTypeExport）
1.5.2.5 附件实体（AttachmentExport）
1.5.2.6 正文实体（TextExport）
1.5.2.7 HTML正文实体（TextHtmlExport）
1.5.2.8 附件正文实体（TextAttachmentExport）
1.5.3 协同导出
1.5.3.1 协同实体（FlowExport）
1.5.3.2 协同正文补充实体（AdminicularExport）
1.5.3.3 协同预归档实体（FolderExport）
1.5.3.4 协同节点实体（FlowNodeExport）
1.5.3.5 协同人员实体（NodeMemberExport）
1.5.3.6 协同节点策略实体（NodeTacticsExport）
1.5.3.7 协同回复信息实体（DocBbsExport）
1.5.3.8 协同关联协同实体（RelFlowExport）
1.5.3.9 协同关联项目实体（ProjectExport）
1.5.4 公文导出
1.5.4.1 公文实体（DocumentExport）
1.5.4.2 公文单实体（DocumentFormExport）
1.5.4.3 公文回执实体（EdocSignReceipt）
1.5.4.4 导出可离线查看的公文单
1.5.5 公文导入
1.5.6 公文签收
1.5.7 回写公文状态
1.5.8 新闻导出
1.5.8.1 新闻实体（NewsExport）
1.5.8.2 新闻类型实体（NewsTypeExport）
1.5.9 公告导出
1.5.9.1 公告实体（BulletinExport）
1.5.9.2 公告类型实体（BulletinTypeExport）
1.5.9.3 公告接收者实体（BulletinReceiverExport）
1.5.10 调查导出
1.5.10.1 调查实体（ResearchExport）
1.5.10.2 调查题目实体（ResearchSubjectExport）
1.5.10.3 调查评论实体（ResearchCommentExport）
1.5.10.4 调查类型实体（ResearchTypeExport）
1.5.10.5 调查发布范围实体（ResearchTargetExport）
1.5.10.6 调查答案实体（AnswerExport）
1.5.11 讨论导出
1.5.11.1 讨论实体（BbsExport）
1.5.11.2 讨论回复实体（BbsReplyExport）
1.5.11.3 讨论类型实体（BbsTypeExport）
1.5.11.4 讨论发布范围实体（BbsTargetExport）
1.6 新闻和公告发布
1.6.1 方法列表
1.6.2 新闻发布
1.6.3 公告发布
1.7 表单管理
1.7.1.1 表单实体（FormExport）
1.7.1.2 表单字段定义实体（DefinitionExport）
1.7.1.3 表单从表信息实体（SubordinateFormExport）
1.7.1.4 表单数据值实体（ValueExport）
1.7.1.5 表单从表记录实体（RecordExport）
1.8 BPM集成
1.8.1 方法列表
1.8.2 流程状态
1.8.3 获取模板定义
1.8.4 外部系统发起表单流程
1.8.4.1 表单XML2.0版本
1.8.4.2 获取表单数据定义
1.8.4.3 发起表单流程数据的校验
1.8.4.4 流程日志
1.8.5 外部系统发起html正文流程(不包括office正文)
1.8.6 取得流程运转状态
1.8.7 按时间段查询出多个表单模板已经审批通过和结束的流程
1.9 事项集成
1.9.1 方法列表
1.10 消息服务
1.10.1 方法列表
1.11 文件服务
1.11.1 方法列表
1.11.2 文件下载服务
1.11.3 文件上传服务
2. 附录
2.1.1 服务错误号
致远协创协同办公系统－开发手册
A8-M 平台 API 参考手册
时间：2012.05.04
版本：V3.50
北京致远协创技术有限公司
致远协创协同办公系统－开发手册
A8-M 平台 API 参考手册 ...................................................................................................... 1
修改记录 ........................................................................................................................... 6
1. 服务参考 ...................................................................................................................... 7
1.1 概述 ...................................................................................................................... 7
1.1.1 启用 webservice .......................................................................................... 7
1.1.2 配置开发环境 ............................................................................................... 8
1.1.3 开始编码（Java） ......................................................................................... 8
生成 ADB Client Stub ........................................................................ 8
编写客户端代码 ................................................................................. 9
1.1.4 开始编码（C#） .......................................................................................... 10
添加服务引用 ................................................................................... 10
编写客户端代码 ................................................................................ 13
1.1.5 服务列表 ................................................................................................... 13
1.1.6 服务公共实体 .............................................................................................. 14
服务响应实体（ServiceResponse） ...................................................... 14
服务异常（ServiceException） ............................................................ 14
1.1.4.1
1.1.4.2
1.1.3.1
1.1.3.2
1.1.6.1
1.1.6.2
1.2 验证服务 .............................................................................................................. 15
1.2.1 登录验证 ................................................................................................... 15
身份验证令牌实体（UserToken） .......................................................... 15
身份验证 ........................................................................................ 15
1.2.1.1
1.2.1.2
1.3.1.1
1.3.1.2
1.3.1.3
1.3.1.4
1.3.1.5
1.3.1.6
1.3 组织模型管理 ......................................................................................................... 16
1.3.1 单位管理 ................................................................................................... 16
单位实体(AccountInfoParam_All) ........................................................ 16
方法列表 ........................................................................................ 17
取得单位 ID .................................................................................... 17
获取单位信息 ................................................................................... 17
删除单位 ........................................................................................ 18
修改单位信息 ................................................................................... 18
1.3.2 人员管理 ................................................................................................... 18
人员实体（PersonInfoParam_All） ...................................................... 18
1.3.2.1
方法列表 ........................................................................................ 19
1.3.2.2
创建人员 ........................................................................................ 20
1.3.2.3
获取人员信息 ................................................................................... 20
1.3.2.4
修改人员信息（按 ID） ....................................................................... 20
1.3.2.5
修改人员信息（按登录名） .................................................................. 21
1.3.2.6
修改人员信息(按编码) ........................................................................ 21
1.3.2.7
删除人员(按 ID)................................................................................ 21
1.3.2.8
1.3.2.9
删除人员（按登录名） ........................................................................ 21
1.3.2.10 启用/停用人员(按 ID) ......................................................................... 22
1.3.2.11 启用/停用人员(按登录名) .................................................................... 22
1.3.2.12 修改人员密码(按 ID) .......................................................................... 22
1.3.2.13 修改人员密码(按登录名) ..................................................................... 23
1.3.2.14 删除人员 ........................................................................................ 23
1.3.3 部门管理 ................................................................................................... 23
部门实体 （DepartmentInfoParam_All） .................................................. 23
方法列表 ........................................................................................ 23
创建部门 ........................................................................................ 24
1.3.3.1
1.3.3.2
1.3.3.3
致远协创协同办公系统－开发手册
更新部门（按 ID） ............................................................................. 24
1.3.3.4
更新部门（按路径名称） ..................................................................... 24
1.3.3.5
修改部门信息(按编码) ........................................................................ 25
1.3.3.6
删除部门（按 ID） ............................................................................. 25
1.3.3.7
删除部门（按名称） ........................................................................... 25
1.3.3.8
1.3.3.9
删除部门（按名称及父部门名称） .......................................................... 26
1.3.3.10 删除部门（按部门路径名称） ................................................................ 26
1.3.3.11 删除部门（按编码） ........................................................................... 26
1.3.3.12 启用/禁用部门（按 ID） ...................................................................... 27
1.3.3.13 启用/禁用部门（按名称） .................................................................... 27
1.3.3.14 启用/禁用部门（按名称及父部门名称） ................................................... 27
1.3.3.15 启用/禁用部门（按路径名称） .............................................................. 27
1.3.3.16 移动部门（按 ID） ............................................................................. 28
1.3.3.17 移动部门（按名称） ........................................................................... 28
1.3.3.18 获取部门信息 ................................................................................... 28
1.3.4 岗位管理 ................................................................................................... 29
岗位实体 （OcupationInfoParam_A8_All） ............................................... 29
1.3.4.1
方法列表 ........................................................................................ 29
1.3.4.2
创建岗位 ........................................................................................ 29
1.3.4.3
更新岗位（按 ID） ............................................................................. 30
1.3.4.4
更新岗位（按名称） ........................................................................... 30
1.3.4.5
修改岗位信息（按编码） ..................................................................... 30
1.3.4.6
删除岗位（按 ID） ............................................................................. 31
1.3.4.7
删除岗位（按名称） ........................................................................... 31
1.3.4.8
1.3.4.9
删除岗位（按编码） ........................................................................... 31
1.3.4.10 启用/禁用岗位（按 ID） ...................................................................... 31
1.3.4.11 启用/禁用岗位（按名称） .................................................................... 32
1.3.4.12 获取岗位信息 ................................................................................... 32
1.3.5 职务级别管理 .............................................................................................. 32
职务级别实体 （OtypeInfoParam_A8_All） ............................................... 32
方法列表 ........................................................................................ 33
创建职务级别 ................................................................................... 33
更新职务级别（按职务级别 ID） ............................................................ 33
更新职务级别（按职务级别名称） .......................................................... 33
删除职务级别（按职务级别 ID） ............................................................ 34
删除职务级别（按职务级别名称） .......................................................... 34
启用/禁用职务级别（按职务级别 ID） ...................................................... 34
启用/禁用职务级别（按职务级别名称） ................................................... 35
1.3.5.1
1.3.5.2
1.3.5.3
1.3.5.4
1.3.5.5
1.3.5.6
1.3.5.7
1.3.5.8
1.3.5.9
1.4 组织模型数据管理 ................................................................................................... 35
1.4.1 方法列表 ................................................................................................... 35
1.4.2 导出人员信息 .............................................................................................. 35
1.4.3 导出部门信息 .............................................................................................. 37
1.4.4 导出岗位信息 .............................................................................................. 39
1.4.5 导出职务级别信息 ........................................................................................ 40
1.4.6 导出组织模型信息 ........................................................................................ 41
1.4.7 导入组织模型信息 ........................................................................................ 42
1.5.2.1
1.5.2.2
1.5.2.3
1.5.2.4
1.5.2.5
1.5.2.6
1.5.2.7
1.5.2.8
1.5.3.1
1.5.3.2
1.5.3.3
1.5.3.4
1.5.3.5
1.5.3.6
1.5.3.7
1.5.3.8
1.5.3.9
致远协创协同办公系统－开发手册
1.5 文档导出 .............................................................................................................. 42
1.5.1 方法列表 ................................................................................................... 42
1.5.2 文档导出公共实体 ........................................................................................ 43
人员实体（PersonExport） ................................................................. 43
部门实体（DepartmentExport） .......................................................... 43
岗位实体（OcupationExport） ............................................................ 43
职务级别实体（OTypeExport） ............................................................ 43
附件实体（AttachmentExport） .......................................................... 43
正文实体（TextExport） .................................................................... 44
HTML 正文实体（TextHtmlExport） ..................................................... 44
附件正文实体（TextAttachmentExport） ............................................... 44
1.5.3 协同导出 ................................................................................................... 45
协同实体（FlowExport） .................................................................... 45
协同正文补充实体（AdminicularExport） ................................................. 46
协同预归档实体（FolderExport） ......................................................... 46
协同节点实体（FlowNodeExport） ....................................................... 46
协同人员实体（NodeMemberExport） .................................................. 47
协同节点策略实体（NodeTacticsExport） ............................................... 47
协同回复信息实体（DocBbsExport） ..................................................... 48
协同关联协同实体（RelFlowExport） ..................................................... 48
协同关联项目实体（ProjectExport） ..................................................... 48
1.5.4 公文导出 ................................................................................................... 48
公文实体（DocumentExport） ............................................................ 49
公文单实体（DocumentFormExport） .................................................. 49
公文回执实体（EdocSignReceipt） ....................................................... 51
导出可离线查看的公文单 ..................................................................... 51
1.5.5 公文导入 ................................................................................................... 52
1.5.6 公文签收 ................................................................................................... 53
1.5.7 回写公文状态 .............................................................................................. 53
1.5.8 新闻导出 ................................................................................................... 53
新闻实体（NewsExport） ................................................................... 54
新闻类型实体（NewsTypeExport） ....................................................... 54
1.5.9 公告导出 ................................................................................................... 54
公告实体（BulletinExport） ................................................................ 55
公告类型实体（BulletinTypeExport） .................................................... 55
公告接收者实体（BulletinReceiverExport） ............................................ 55
调查导出 .............................................................................................. 56
1.5.10.1 调查实体（ResearchExport） ............................................................. 56
1.5.10.2 调查题目实体（ResearchSubjectExport） .............................................. 57
1.5.10.3 调查评论实体（ResearchCommentExport） ........................................... 57
1.5.10.4 调查类型实体（ResearchTypeExport） .................................................. 57
1.5.10.5 调查发布范围实体（ResearchTargetExport） .......................................... 57
1.5.10.6 调查答案实体（AnswerExport） .......................................................... 58
讨论导出 .............................................................................................. 58
1.5.11.1 讨论实体（BbsExport） ..................................................................... 58
1.5.11.2 讨论回复实体（BbsReplyExport） ........................................................ 59
1.5.11.3 讨论类型实体（BbsTypeExport） ......................................................... 59
1.5.4.1
1.5.4.2
1.5.4.3
1.5.4.4
1.5.8.1
1.5.8.2
1.5.9.1
1.5.9.2
1.5.9.3
1.5.10
1.5.11
致远协创协同办公系统－开发手册
1.5.11.4 讨论发布范围实体（BbsTargetExport） ................................................. 59
1.6 新闻和公告发布 ...................................................................................................... 60
1.6.1 方法列表 ................................................................................................... 60
1.6.2 新闻发布 ................................................................................................... 60
1.6.3 公告发布 ................................................................................................... 60
1.7 表单管理 .............................................................................................................. 61
表单实体（FormExport） ................................................................... 61
表单字段定义实体（DefinitionExport） .............................................. 61
表单从表信息实体（SubordinateFormExport） ........................................... 62
表单数据值实体（ValueExport） ............................................................ 62
表单从表记录实体（RecordExport） ........................................................ 62
1.7.1.1
1.7.1.2
1.7.1.3
1.7.1.4
1.7.1.5
1.8 BPM 集成 ............................................................................................................. 62
1.8.1 方法列表 ................................................................................................... 63
1.8.2 流程状态 ................................................................................................... 63
1.8.3 获取模板定义 .............................................................................................. 64
1.8.4 外部系统发起表单流程 ................................................................................... 64
表单 XML2.0 版本 ............................................................................. 64
获取表单数据定义 ............................................................................. 66
发起表单流程数据的校验 ..................................................................... 66
流程日志 ........................................................................................ 68
1.8.5 外部系统发起 html 正文流程(不包括 office 正文) .................................................. 68
1.8.6 取得流程运转状态 ........................................................................................ 68
1.8.7 按时间段查询出多个表单模板已经审批通过和结束的流程 .......................................... 69
1.8.4.1
1.8.4.2
1.8.4.3
1.8.4.4
1.9 事项集成 .............................................................................................................. 69
1.9.1 方法列表 ................................................................................................... 69
1.10 消息服务 .............................................................................................................. 70
方法列表 .............................................................................................. 70
1.10.1
1.11.1
1.11.2
1.11.3
1.11 文件服务 .............................................................................................................. 71
方法列表 .............................................................................................. 71
文件下载服务 ........................................................................................ 71
文件上传服务 ........................................................................................ 72
2. 附录 .......................................................................................................................... 74
2.1.1 服务错误号 ................................................................................................. 74
致远协创协同办公系统－开发手册
修修改改记记录录
日期
修改人
修改内容
备注
2008-12-08 王文友
2008-12-15 王文友
2008-12-23 王文友
2008-12-29 王文友
2009-6-16
2009-9-27
张勇
张勇
王文友
2009-9-28
2009-12-15 王文友
2009-12-15 张勇
2010-04-14 张勇
2010-09-04 成才
2012-02-27 李龙
2012-05-03 李龙
创建文档，编写文档模板。
增加了安装服务文档。
增加了文档导出接口例程。
合并刘娜组织模型文档，加入例程；
合并于荒津 BPM 文档。
增加待办事项列表接口
增加跟踪事项列表接口，消息集成
接口，新闻和公告 sso 接口；
增加文件服务，流程支持附件。
增加本地调用方法及示例。
增加 C#开发指南以及 BPM 接口完
善（Schema、XSLT、流程日志）
增加了按时间段导出公告接口，表
单导出增加数据类型定义，增加文
件上传和下载部分的本地示例
增加公文导出自定义公文单元
增加公文导入
增加公文交换发送状态和签收状态
回写 A8
增加表单数据 2.0 规范
修改公文导出接口及导出协同接口
名称
接口通测后，文档细节内容修复
致远协创协同办公系统－开发手册
11.. 服服务务参参考考
1.1 概述
A8 平台提供基于 axis2 1.4 实现的标准 Web service。可以采取多种语言多种方式进行客户端开发。
本指南提供了 Java 和 C#的开发步骤，PHP 建议使用 WSO2 Web Services Framework for PHP 开发。
本指南所有 Java 远程接口例程使用 axis2 的 ADB（Axis2 DataBinding Framework）Stub 方式进行开发。
如果使用 Java 进行与 A8 紧耦合的本地开发：
1、 可以跳过 SOAP，直接调用 Web service 的 Java 本地接口实现。
2、 可以略过下面几节，直接从服务列表开始阅读，在 Java 项目中包含 seeyon-api.jar 和 v3x-services.jar 即
可。
3、 编写的代码必须与 A8 部署在一起（同一虚拟机，同一上下文）。
4、 示例代码参考每一接口的本地调用。
注意：如果使用 ADB Client Stub 方式编写客户端代码，A8 升级以后必须重新生成并更新客户端的 Stub！！！
1.1.1 启用 webservice
A8 安装完毕以后是不能直接使用 webservice 的，需要使用 A8Config 工具启用 webservice 插件。
致远协创协同办公系统－开发手册
确定以后重启 A8 即可使用 webservice。
1.1.2 配置开发环境
启动 A8 服务。
查看特定服务的 WSDL：
http://{host}:{port}/seeyon/services/{serviceName}?wsdl
服务的 EPR（EndPoint Refrence）地址：
http://{host}:{port}/seeyon/services/{serviceName}
1.1.3 开始编码（Java）
下面是使用 Axis2 ADB 方式编写服务客户端代码的步骤：
1.1.3.1 生成 ADB Client Stub
到 http://ws.apache.org/axis2/网站下载 axis2。
进入 axis2/bin 目录，运行
wsdl2java –uri http://{host}:{port}/seeyon/services/{serviceName}?wsdl
-o
src –ns2p
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
