# 公文服务管理
# 接口调用方式
本接口为主OA Http Rest,允许被异构系统远程调用,调用前需要调用Rest接口文档 (opens new window)获取Restful token身份凭证。
# 公文对象
# 公文待签收对象实例
{
"summaryId" : -7544685618623263599,
"subject" : "测试签收标题",
"importantLevel" : 1,
"startUserId" : 1359726818181166176,
"startUserName" : "测试人员姓名",
"createPerson" : "测试人员姓名",
"issuer" : null,
"signingDate" : null,
"contentType" : 10,
"createTime" : 1573795094000,
"startTime" : 1573795440000,
"completeTime" : 1573795440000,
"summaryDeadline" : -1,
"summaryDeadlineDatetime" : null,
"summaryDeadLineName" : "无",
"summaryIsCoverTime" : false,
"summaryState" : 3,
"summaryTransferStatus" : null,
"summaryTransferStatusName" : "已结束",
"orgAccountId" : 2234457701907909455,
"orgDepartmentId" : null,
"isQuickSend" : false,
"caseId" : 770674455657362079,
"processId" : 4336604878864797075,
"templeteId" : null,
"hasArchive" : false,
"hasArchiveTxt" : null,
"archiveId" : null,
"archiveName" : null,
"govdocType" : 4,
"edocType" : 1,
"docMark" : null,
"docMark2" : null,
"serialNo" : null,
"hastenTimes" : 0,
"exchangeSendAffairId" : null,
"currentNodesInfo" : '已结束',
"printUnit" : null,
"printer" : null,
"copies" : null,
"copies2" : null,
"phone" : null,
"auditor" : null,
"review" : null,
"undertaker" : null,
"undertakenoffice" : null,
"receiveUnit" : null,
"signPerson" : "测试人员姓名",
"signMark" : null,
"distributer" : null,
"packTime" : 1573795440000,
"receiptDate" : null,
"registrationDate" : null,
"secretLevel" : null,
"urgentLevel" : null,
"unitLevel" : null,
"keepPeriod" : null,
"keepPeriodTxt" : null,
"docType" : null,
"sendType" : null,
"sendTo" : null,
"sendTo2" : null,
"sendToId" : null,
"sendToId2" : null,
"copyTo" : null,
"copyTo2" : null,
"copyToId" : null,
"copyToId2" : null,
"reportTo" : null,
"reportTo2" : null,
"reportToId" : null,
"reportToId2" : null,
"sendUnit" : null,
"sendUnit2" : null,
"sendUnitId" : null,
"sendUnitId2" : null,
"sendDepartment" : null,
"sendDepartment2" : null,
"sendDepartmentId" : null,
"sendDepartmentId2" : null,
"affairId" : 7069254775174614776,
"affairState" : 3,
"affairSubState" : 12,
"affairReadState" : 1,
"affairTrack" : 0,
"affairMemberId" : 1359726818181166176,
"affairTransactorId" : null,
"affairNodePolicy" : "oldqianshou",
"affairObjectId" : 2307995958816716320,
"affairSubObjectId" : 6732623812014751600,
"affairActivityId" : null,
"affairArchiveId" : null,
"affairSubject" : "测试签收标题",
"affairForwardMember" : null,
"affairBackFromId" : null,
"affairApp" : 4,
"affairSubApp" : 23,
"affairFinish" : false,
"affairHastenTimes" : null,
"affairIsCoverTime" : false,
"affairRemindDate" : null,
"affairDeadlineDate" : null,
"affairDeadLineName" : "无",
"affairReceiveTime" : 1573795449000,
"affairCompleteTime" : null,
"affairCreateDate" : 1573795449000,
"affairUpdateDate" : 1573795449000,
"affairExpectedProcessTime" : null,
"affairPreApprover" : null,
"affairSenderId" : 1359726818181166176,
"surplusTime" : null,
"hasAtt" : false,
"proxy" : false,
"proxyName" : null,
"agentDeal" : false,
"leaderCommondNo" : null,
"fromType" : 0,
"autoRun" : false,
"proxyMemberId" : null,
"competitionType" : 0
}
# 公文待签收对象属性说明
参数 | 说明 |
---|---|
summaryId | 公文ID |
subject | 标题 |
importantLevel | 重要程度 |
startUserId | 发起人ID |
startUserName | 发起人姓名 |
createPerson | 拟稿人姓名 |
issuer | 签发人 |
signingDate | 签发日期 |
contentType | 正文类型 |
createTime | 创建时间 |
startTime | 拟稿日期 |
completeTime | 完成时间 |
summaryDeadline | 流程期限时间段 |
summaryDeadlineDatetime | 流程期限时间点 |
summaryDeadLineName | 流程期限描述 |
summaryIsCoverTime | 流程是否超期 |
summaryState | 流程状态 |
summaryTransferStatus | 公文交换状态 |
summaryTransferStatusName | 公文交换状态描述 |
orgAccountId | 单位ID |
orgDepartmentId | 部门ID |
isQuickSend | 是否快速发文 |
caseId | 流程实例ID |
processId | 流程ID |
templeteId | 模板ID |
hasArchive | 是否归档 |
hasArchiveTxt | 是否归档描述 |
archiveId | 归档ID |
archiveName | 归档路径 |
govdocType | 公文类型 |
edocType | 公文类别 |
docMark | 公文文号 |
docMark2 | 公文文号B |
serialNo | 内部文号 |
hastenTimes | 催办次数 |
exchangeSendAffairId | 分送affairId |
currentNodesInfo | 当前待办人 |
printUnit | 印发单位 |
printer | 打印人 |
copies | 印发分数 |
copies2 | 印发分数B |
phone | 联系电话 |
auditor | 审批人 |
review | 复核人 |
undertaker | 承办人 |
undertakenoffice | 承办机构 |
receiveUnit | 接收单位 |
signPerson | 签收人 |
signMark | 签收编号 |
distributer | 分办人 |
packTime | 分送日期 |
receiptDate | 签收日期 |
registrationDate | 登记日期 |
secretLevel | 密级 |
urgentLevel | 紧急程度 |
unitLevel | 公文级别 |
keepPeriod | 保密期限 |
keepPeriodTxt | 保密期限描述 |
docType | 公文种类 |
sendType | 行文类型 |
sendTo | 主送单位 |
sendTo2 | 主送单位B |
sendToId | 主单位ID |
sendToId2 | 主送单位B ID |
copyTo | 抄送单位 |
copyTo2 | 抄送单位B |
copyToId | 抄送单位ID |
copyToId2 | 抄送单位B ID |
reportTo | 抄报单位 |
reportTo2 | 抄报单位B |
reportToId | 抄报单位ID |
reportToId2 | 抄报单位B ID |
sendUnit | 发文单位 |
sendUnit2 | 发文单位B |
sendUnitId | 发文单位ID |
sendUnitId2 | 发文单位B ID |
sendDepartment | 发文部门 |
sendDepartment2 | 发文部门B |
sendDepartmentId | 发文部门ID |
sendDepartmentId2 | 发文部门B ID |
affairId | 事项ID |
affairState | 事项状态 |
affairSubState | 事项子状态 |
affairReadState | 事项已读状态 |
affairTrack | 跟踪类型 |
affairMemberId | 人员ID |
affairTransactorId | 处理人ID |
affairNodePolicy | 节点权限 |
affairObjectId | 主应用ID |
affairSubObjectId | 对应workitem_id |
affairActivityId | 工作流节点Id |
affairArchiveId | 归档ID |
affairSubject | 标题 |
affairForwardMember | 转发人 |
affairBackFromId | 回退、指定回退,来源人的Id |
affairApp | 应用ID |
affairSubApp | 子应用ID |
affairFinish | 是否结束 |
affairHastenTimes | 催办次数 |
affairIsCoverTime | 是否超期 |
affairRemindDate | 提醒时间 |
affairDeadlineDate | 节点期限 |
affairDeadLineName | 节点期限描述 |
affairReceiveTime | 接收时间 |
affairCompleteTime | 完成时间 |
affairCreateDate | 创建时间 |
affairUpdateDate | 更新时间 |
affairExpectedProcessTime | 预期处理时间点 |
affairPreApprover | 上一处理人 |
affairSenderId | 发起人ID |
surplusTime | 办理剩余时间 |
hasAtt | 是否有附件 |
proxy | 是否代理 |
proxyName | 代理人姓名 |
agentDeal | 被代理人自己处理 |
leaderCommondNo | 领导批示编号展示字段 |
fromType | 公文来源 |
autoRun | 是否自动发起 |
proxyMemberId | 代理ID |
competitionType | 抢单状态 |
# 公文待登记对象实例
{
"id" : -1838887671290443796,
"identifier" : "00000000000000000000",
"recieveId" : -8038691098682897209,
"edocId" : -8969186673481202719,
"edocType" : 1,
"registerType" : 1,
"createUserId" : -3941577936688034522,
"createUserName" : "李世民",
"createTime" : 1488880575000,
"updateTime" : 1488880575000,
"sendUnit" : "V61",
"sendUnitId" : 5269865115340261356,
"sendUnitType" : 1,
"edocUnit" : "V61",
"edocUnitId" : "Account|5269865115340261356",
"edocDate" : null,
"registerUserId" : -3941577936688034522,
"registerUserName" : "李世民",
"registerDate" : "2017-03-07",
"issuerId" : -1,
"issuer" : null,
"issueDate" : null,
"signer" : null,
"distributerId" : -3941577936688034522,
"proxy" : false,
"proxyId" : null,
"proxyName" : null,
"proxyLabel" : null,
"proxyUserId" : null,
"distributer" : "李世民",
"distributeDate" : null,
"distributeState" : 1,
"distributeEdocId" : -1,
"subject" : "登记标题",
"docType" : null,
"sendType" : "",
"docMark" : "XX〔2017〕0002号",
"serialNo" : "",
"secretLevel" : "",
"urgentLevel" : "",
"keepPeriod" : null,
"sendTo" : "V61",
"sendToId" : "Account|5269865115340261356",
"copyTo" : null,
"copyToId" : null,
"keywords" : null,
"copies" : null,
"noteAppend" : null,
"attNote" : null,
"state" : 2,
"orgAccountId" : 5269865115340261356,
"recTime" : 1488880575000,
"exchangeType" : 0,
"exchangeOrgId" : 0,
"hasAttachments" : false,
"unitLevel" : null,
"exchangeSendTime" : 1488880567000,
"exchangeMode" : 0,
"attachmentList" : [ ],
"registerBody" : null,
"isRetreat" : 0,
"autoRegister" : 1,
"recieveUserId" : -3941577936688034522,
"recieveUserName" : "李世民",
"new" : false
}
# 公文待登记对象属性说明
参数 | 说明 |
---|---|
Id | edoc_register表ID |
identifier | 标志位 |
recieveId | 标志位 |
edocId | 来文公文ID |
edocType | 登记单类型 0发文登记 1收文登记 |
registerType | 登记方式 1电子公文登记 2纸质公文登记 3纸质公文登记 |
createUserId | 创建人ID |
createUserName | 创建人 |
createTime | 创建时间 |
updateTime | 修改时间 |
sendUnit | 来文单位 |
sendUnitId | 来文单位JD |
sendUnitType | 来文类型 1内部单位 2外部单位 |
edocUnit | 成文单位 |
edocUnitId | 成文单位ID |
edocDate | 成文日期 |
registerUserId | 登记人ID |
registerUserName | 登记人 |
registerDate | 登记日期 |
issuerId | 签发人ID |
issuer | 签发人 |
issueDate | 签发日期 |
signer | 会签人 |
distributerId | 分发人ID |
distributer | 分发人 |
distributeState | 分发状态 0草稿箱 1待分发 2已分发 |
distributeEdocId | 分发关联公文ID |
subject | 标题 |
docType | 公文类型 |
sendType | 发文类型 |
docMark | 来文字号 |
serialNo | 收文编号 |
secretLevel | 文件密级 1 普通2 秘密3 机密4 绝密 |
urgentLevel | 紧急程度 1 普通2 平急3 加急4 特急5 特提 |
keepPeriod | 保密期限 |
sendTo | 主送单位 |
sendToId | 主送单位ID |
copyTo | 抄送单位 |
copyToId | 抄送单位ID |
keywords | 主题词 |
copies | 印发份数 |
noteAppend | 附注 |
attNote | 附件说明 |
state | 登记状态 0草稿箱 1待登记 2已登记 3退回给签收 4被退回 5删除 |
orgAccountId | 登记单位 |
recTime | 签收时间 |
exchangeType | 交换类型 |
exchangeOrgId | 交换单位或部门ID |
exchangeMode | 交换模式 0 - 内部(致远)公文交换, 1 - 书生公文交换 |
isRetreat | 是否被退回 0-未回退, 1-回退 |
autoRegister | 是否自动登记 0-否,1-是 |
recieveUserId | 签收人ID |
# 流程期限枚举
枚举值 | 说明 |
---|---|
60 | 1小时 |
120 | 2小时 |
180 | 3小时 |
240 | 4小时 |
300 | 5小时 |
360 | 6小时 |
420 | 7小时 |
1440 | 1天 |
2880 | 2天 |
4320 | 3天 |
5760 | 4天 |
7200 | 5天 |
8640 | 6天 |
14400 | 10天 |
10080 | 1周 |
20160 | 2周 |
30240 | 3周 |
21600 | 半个月 |
43200 | 1个月 |
86400 | 2个月 |
129600 | 3个月 |
# 正文文件类型
枚举值 | 说明 |
---|---|
msword | Word类型 |
wordprocessingml.document | Word类型 |
msoffice | WPS正文类型 |
PDF类型 | |
ms-excel | Excel类型 |
spreadsheetml.template | Excel类型 |
# 导出公文数据接口(CAP3新公文,老企业公文)
开发者可以通过公文的summaryId和指定导出路径来获取公文信息(包括流程附件)。
注意:在V6.0及其以上版本调用此接口,在获取token时请绑定OA人员登录名。
CTPRestClient client = clientManager.getRestClient();
client.bindUser("{OA人员登录名}");
接口请求说明:
http请求方式:POST
http://ip:port/seeyon/rest/edoc/export
注:请求需要携带token,否则无法使用,获取并传递token方法参考:https://open.seeyoncloud.com/seeyonapi/781/
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
String[] summaryid | 是 | 公文summaryid数组 |
folder | 是 | 导出路径 |
返回说明
正常情况下,在指定的folder路径下产生公文单的HTML文件以及样式文件(包括流程附件)。
# 导入公文数据接口(CAP3新公文)
# 接口描述
开发者可以通过指定xml格式数据,导入默认公文收文单模板。
# 基础信息
请求地址:http(s)://ip:port/seeyon/rest/edoc/import
请求方式:POST
返回类型:String
注:请求需要携带token,否则无法使用,获取并传递token方法参考:https://open.seeyoncloud.com/seeyonapi/781/
文档更新时间:2024年7月12日
# 请求体
body参数
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
xmlData | 是 | String | xml结构字符串 |
xml结构字符串说明
- 结构示例
<?xml version="1.0" encoding="utf-8"?>
<DataPojo>
<DataProperty propertyname="documentId" value="670869647114347"/>
<DataProperty propertyname="docTitle">导入公文_test</DataProperty>
<DataProperty propertyname="docCreatePerson">
<DataPojo type="PersonExport">
<DataProperty propertyname="id" value="-5507400652895663271"></DataProperty>
<DataProperty propertyname="name">张三</DataProperty>
</DataPojo>
</DataProperty>
<DataProperty propertyname="notifyTime" value="60"/>
<DataProperty propertyname="attachmentList">
<DataPojo type="AttachmentExport">
<DataProperty propertyname="id" value="-5147011038331123963"/>
</DataPojo>
<DataPojo type="AttachmentExport">
<DataProperty propertyname="id" value="-5764288994515005534"/>
</DataPojo>
</DataProperty>
<DataProperty propertyname="flowContent_att">
<DataPojo type="TextAttachmentExport">
<DataProperty propertyname="id" value="4874939414099938956"/>
</DataPojo>
</DataProperty>
<DataProperty propertyname="formElementList">
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">docType</DataProperty>
<DataProperty propertyname="value">401111</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">docMark</DataProperty>
<DataProperty propertyname="value">川-字-2023第一号</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">secretLevel</DataProperty>
<DataProperty propertyname="value">416</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">urgentLevel</DataProperty>
<DataProperty propertyname="value">426</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">issuer</DataProperty>
<DataProperty propertyname="value">李四</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">copies</DataProperty>
<DataProperty propertyname="value">5</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">date1</DataProperty>
<DataProperty propertyname="value">2024-7-12</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">integer1</DataProperty>
<DataProperty propertyname="value">11</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">decimal1</DataProperty>
<DataProperty propertyname="value">22</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">list1</DataProperty>
<DataProperty propertyname="value">-9219461800538716501</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">text1</DataProperty>
<DataProperty propertyname="value">文本</DataProperty>
</DataPojo>
</DataProperty>
</DataPojo>
propertyname属性 | 说明 | 数据类型 | 是否必填 | 默认值 | 填写位置 | 备注 |
---|---|---|---|---|---|---|
documentId | 文档ID | Long | 否 | UUID | value 属性 | |
docTitle | 公文流程标题 | String | 是 | - | 标签描述 | |
docCreatePerson.id | 创建人ID | Long | 是 | - | value 属性 | 系统中的人员ID,org_member.id |
docCreatePerson.name | 创建人姓名 | String | 是 | - | 标签描述 | 系统中的人员姓名,org_member.name |
notifyTime | 流程期限 | Integer | 否 | 0 | value 属性 | 单位(分钟),可选范围见 流程期限枚举 |
attachmentList.id | 附件列表 | Long | 否 | - | value 属性 | 使用系统中已有的ctp_file.id数据,将会与其他附件对象共用此文件 |
flowContent_att.id | 正文 | Long | 否 | 空白Html正文 | value 属性 | 使用系统中已有的ctp_file.id数据,将会与其他附件对象共用此文件,ctp_file.mime_type支持范围见 正文文件类型 |
formElementList | 公文元素列表 | 是 | - | 即使不需要导入公文元素,此结构也必须存在 |
- formElementList 中元素说明
1、数据结构
<DataProperty propertyname="formElementList">
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">key1</DataProperty>
<DataProperty propertyname="value">value1</DataProperty>
</DataPojo>
<DataPojo type="DocumentFormExport">
<DataProperty propertyname="attributeName">key2</DataProperty>
<DataProperty propertyname="value">value2</DataProperty>
</DataPojo>
</DataProperty>
2、key支持清单
key | 说明 | 数据类型 | 默认值 | 备注 |
---|---|---|---|---|
docType | 公文种类 | Long | - | 取系统枚举中"公文种类"枚举ID |
docMark | 公文文号 | String | - | |
secretLevel | 文件密级 | Long | - | 取系统枚举中"文件密集"枚举ID |
urgentLevel | 紧急程度 | Long | - | 取系统枚举中"紧急程度"枚举ID |
issuer | 签发人 | String | - | |
copies | 印发份数 | Integer | - | |
date1……date20 | 扩展字段-日期类型 | Date | - | 支持日期格式(yyyy-MM-dd) |
integer1……integer20 | 扩展字段-数字类型 | Integer | - | |
decimal1……decimal20 | 扩展字段-数字类型 | Double | - | |
text1……text20 | 扩展字段-文本类型 | String | - | text11无效 |
list1……list20 | 扩展字段-枚举类型 | Long | - | 系统中的枚举ID,需要是文单绑定的枚举,否则无法显示 |
# 请求示例
请求地址:http://localhost/seeyon/rest/edoc/import
{
"xmlData" : "<?xml version=\"1.0\" encoding=\"utf-8\"?><DataPojo><DataProperty propertyname=\"documentId\" value=\"670869647114347\"/><DataProperty propertyname=\"docTitle\">导入公文_test</DataProperty><DataProperty propertyname=\"docCreatePerson\"><DataPojo type=\"PersonExport\"><DataProperty propertyname=\"id\" value=\"-5507400652895663271\"></DataProperty><DataProperty propertyname=\"name\">张三</DataProperty></DataPojo></DataProperty><DataProperty propertyname=\"formElementList\"><DataPojo type=\"DocumentFormExport\"><DataProperty propertyname=\"attributeName\">docType</DataProperty><DataProperty propertyname=\"value\">401111</DataProperty></DataPojo><DataPojo type=\"DocumentFormExport\"><DataProperty propertyname=\"attributeName\">docMark</DataProperty><DataProperty propertyname=\"value\">川-字-2023第一号</DataProperty></DataPojo></DataProperty></DataPojo>"
}
# 返回体
返回公文ID
# 导入公文数据接口(v8.1sp2级以后版本)
接口说明: 开发者可以通过指定的JSON格式数据,导入默认公文收文/发文单模板。
基础信息
请求方式: POST
http://ip:port/seeyon/rest/govdoc/api/v1/importer
注:请求需要携带token,否则无法使用,获取并传递token方法参考:https://open.seeyoncloud.com/seeyonapi/781/
请求示例 Body 请求参数
{
"sendUnit": null,
"resourceId": null,
"receiveUnit": {
"unitType": "fugiat minim laboris enim mollit",
"unitId": "88",
"accountId": "41",
"unitName": "交议变组石第"
},
"summaryData": {
"templateModuleType": 98,
"subject": "dolor ex",
"createUserId": "69",
"deadline": 40,
"templateCode": "send001",
"keywords": "Ut in reprehenderit"
},
"formFieldDataList": [
{
"value": "adipisicing",
"dataType": null,
"elementCode": "77"
},
{
"value": "eu ea in consequat sint",
"elementCode": "41",
"dataType": "id fugiat ea"
},
{
"dataType": "occaecat dolor quis magna",
"elementCode": "97",
"value": "nisi"
}
],
"attachments": [
"fileId":"9827589427845792257",//文件的id
"fileName":"测试.docx",
"area":"1", //0标题区 1表单区 2附言区 3意见区
"formFieldName":"field0016", ///公文元素可填映射字段,非公文元素填数据库字段
"sort":"0"
],
"contentFileData": null
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Content-Type | header | string | 否 | none |
token | header | string | 否 | none |
body | body | object | 否 | none |
» sendUnit | body | object¦null | 否 | 公文交换-发送方单位 |
»» unitType | body | string | 否 | 单位类型Account、Department |
»» unitId | body | string | 否 | 单位id |
»» accountId | body | string | 否 | 所属单位id |
»» unitName | body | string | 否 | 单位名称 |
» resourceId | body | string¦null | 否 | 公文交换-发送方对应的资源id |
» receiveUnit | body | object¦null | 否 | 公文交换-接收方单位 Account、Department |
»» unitType | body | string | 否 | 单位类型Account、Department |
»» unitId | body | string | 否 | 单位id |
»» accountId | body | string | 否 | 所属单位id |
»» unitName | body | string | 否 | 单位名称 |
» summaryData | body | object | 是 | 公文主数据 |
»» templateModuleType | body | integer | 是 | 公文模板类型 |
»» subject | body | string | 是 | 公文标题 |
»» createUserId | body | string | 是 | 公文发起人id |
»» deadline | body | integer | 否 | 公文流程超期期限 单位:分钟 |
»» templateCode | body | string | 否 | 要调用的模板的编号 |
»» keywords | body | string | 否 | none |
» formFieldDataList | body | [object] | 是 | 表单字段数据集合 |
»» dataType | body | string¦null | 否 | 控件类型(暂时无用) |
»» elementCode | body | string | 是 | 公文元素code |
»» value | body | string | 是 | 表单子字段值 |
» attachments | body | [object]¦null | 否 | 标题区附件数据 |
»» fileId | body | string | 否 | 附件文件id |
»» fileName | body | string | 否 | 附件名称 |
»» area | body | integer | 否 | 附件所在区域 |
»» formFieldName | body | string | 否 | 绑定到表单的动态表字段名称 例如field00xx等 |
»» sort | body | integer | 是 | 排序 |
» contentFileData | body | object¦null | 否 | 正文数据 |
»» fileId | body | string¦null | 否 | 正文文件id,可为空 |
»» content | body | string | 否 | 正文内容,用于为html格式的正文时 |
»» type | body | integer | 否 | 正文类型 有如下: |
# 详细说明
»» templateModuleType: 公文模板类型
- 401:"表单公文-发文",
- 402:"表单公文-收文",
- 403:"表单公文-交换公文",
- 404:"表单公文-签报"
»» templateCode: 要调用的模板的编号 若不进行绑定模板编号,则会去取发起人有授权的 模板数据 依次优先级是:模板编号>个人授权>部门授权>单位授权
»» elementCode: 公文元素code
# 支持导入的公文元素(前提是表单中配置映射了对应的公文元素)
枚举类公文元素(参数说明:目标OA系统中的枚举值)
- doc_type -> 公文种类
- send_type -> 行文类型
- keep_period -> 保密期限
- secret_level -> 文件密级
- urgent_level -> 紧急程度
- unit_level -> 公文级别
选人公文元素(单选)(参数说明:目标OA系统中的人员id)
- create_person -> 拟稿人
- issuer -> 签发人
- printer -> 打印人
- auditor -> 审批人
- review -> 复核人
- undertaker -> 承办人
- sign_person -> 签收人
多单位多部门公文元素(参数说明:"Derpartment|1123123123123131、手写单位名称、Account|1231234323423424")
- send_unit -> 发文单位
- send_to -> 主送单位
- copy_to -> 抄送单位
- report_to -> 抄报单位
- print_unit -> 印发单位
- send_to2 -> 主送机关B
- copy_to2 -> 抄送单位B
- report_to2 -> 抄报单位B
- send_unit2 -> 发文单位B
- send_department -> 发文部门
- send_department2 -> 发文部门B
- undertakenoffice -> 承办机构
- receive_unit -> 接收单位
日期控件公文元素(参数说明:Long型时间戳)
- createdate -> 拟稿日期
- packdate -> 分送日期
- receipt_date -> 签收日期
- registration_date -> 登记日期
- signing_date -> 签发日期
- Printing_Date -> 印发日期
文本型公文元素(参数说明:字符串数据)
- subject -> 公文标题
- doc_mark -> 公文文号(手写文号)
- serial_no -> 内部文号(手写文号)
- sign_mark -> 签收编号(手写文号)
- filesm -> 附件说明
- filefz -> 附注
- phone -> 联系电话
- Serial_Number_Of_Copies -> 份号
- Signature_of_Document_Issuing_Agency -> 发文机关或签发人署名
- Release_Level -> 发布层次
- copies -> 印发份数
- copies2 -> 印发份数B
附件类公文元素
- fileId -> 文件的id, attachment的FileUrl
- fileName -> 文件名称
- area -> 文件区域 0标题区 1表单区 2附言区 3意见区
- sort -> 排序
- formFieldName -> 公文元素可填映射字段,非公文元素填数据库字段
其他自定义公文元素
string1 -> 单行文本1
string2 -> 单行文本2
string3 -> 单行文本3
string4 -> 单行文本4
string5 -> 单行文本5
string6 -> 单行文本6
string7 -> 单行文本7
string8 -> 单行文本8
string9 -> 单行文本9
string10 -> 单行文本10
string11 -> 单行文本11
string12 -> 单行文本12
string13 -> 单行文本13
string14 -> 单行文本14
string15 -> 单行文本15
string16 -> 单行文本16
string17 -> 单行文本17
string18 -> 单行文本18
string19 -> 单行文本19
string20 -> 单行文本20
string21 -> 单行文本21
string22 -> 单行文本22
string23 -> 单行文本23
string24 -> 单行文本24
string25 -> 单行文本25
string26 -> 单行文本26
string27 -> 单行文本27
string28 -> 单行文本28
string29 -> 单行文本29
string30 -> 单行文本30
text1 -> 多行文本1
text2 -> 多行文本2
text3 -> 多行文本3
text4 -> 多行文本4
text5 -> 多行文本5
text6 -> 多行文本6
text7 -> 多行文本7
text8 -> 多行文本8
text9 -> 多行文本9
text10 -> 多行文本10
text11 -> 多行文本11
text12 -> 多行文本12
text13 -> 多行文本13
text14 -> 多行文本14
text15 -> 多行文本15
integer1 -> 整数类型1
integer2 -> 整数类型2
integer3 -> 整数类型3
integer4 -> 整数类型4
integer5 -> 整数类型5
integer6 -> 整数类型6
integer7 -> 整数类型7
integer8 -> 整数类型8
integer9 -> 整数类型9
integer10 -> 整数类型10
integer11 -> 整数类型11
integer12 -> 整数类型12
integer13 -> 整数类型13
integer14 -> 整数类型14
integer15 -> 整数类型15
integer16 -> 整数类型16
integer17 -> 整数类型17
integer18 -> 整数类型18
integer19 -> 整数类型19
integer20 -> 整数类型20
decimal1 -> 小数类型1
decimal2 -> 小数类型2
decimal3 -> 小数类型3
decimal4 -> 小数类型4
decimal5 -> 小数类型5
decimal6 -> 小数类型6
decimal7 -> 小数类型7
decimal8 -> 小数类型8
decimal9 -> 小数类型9
decimal10 -> 小数类型10
decimal11 -> 小数类型11
decimal12 -> 小数类型12
decimal13 -> 小数类型13
decimal14 -> 小数类型14
decimal15 -> 小数类型15
decimal16 -> 小数类型16
decimal17 -> 小数类型17
decimal18 -> 小数类型18
decimal19 -> 小数类型19
decimal20 -> 小数类型20
自定义枚举类公文元素(参数说明:目标OA系统中的枚举值)
- list1 -> 列表类型1
- list2 -> 列表类型2
- list3 -> 列表类型3
- list4 -> 列表类型4
- list5 -> 列表类型5
- list6 -> 列表类型6
- list7 -> 列表类型7
- list8 -> 列表类型8
- list9 -> 列表类型9
- list10 -> 列表类型10
- list11 -> 列表类型11
- list12 -> 列表类型12
- list13 -> 列表类型13
- list14 -> 列表类型14
- list15 -> 列表类型15
- list16 -> 列表类型16
- list17 -> 列表类型17
- list18 -> 列表类型18
- list19 -> 列表类型19
- list20 -> 列表类型20
自定义日期控件公文元素(参数说明:Long型时间戳)
- date1 -> 日期类型1
- date2 -> 日期类型2
- date3 -> 日期类型3
- date4 -> 日期类型4
- date5 -> 日期类型5
- date6 -> 日期类型6
- date7 -> 日期类型7
- date8 -> 日期类型8
- date9 -> 日期类型9
- date10 -> 日期类型10
- date11 -> 日期类型11
- date12 -> 日期类型12
- date13 -> 日期类型13
- date14 -> 日期类型14
- date15 -> 日期类型15
- date16 -> 日期类型16
- date17 -> 日期类型17
- date18 -> 日期类型18
- date19 -> 日期类型19
- date20 -> 日期类型20
»» area: 附件所在区域
- 0: "标题区",
- 1: "表单区",
- 2: "附言区",
- 3: "意见区";
»» type: 正文类型 有如下:
- HTML,10;
- OfficeWord,41;
- OfficeExcel,42;
- WpsWord,43;
- WpsExcel,44;
- Pdf,45;
- Ofd,46;
调用成功返回示例
{
"code": 200,
"message": "",
"data": {
"id" : 1099497990625710012,
"currentNodesInfo" : "-2655621118598823338;7628993646175145209;-6490053838053553176;-5864651325128490804",
"state" : 0,
"subject" : "2222222222222222",
"autoRun" : false,
"identifier" : "00000000000000000000",
"hasArchive" : false,
"edocType" : 0,
"deadline" : 0,
"deadlineTemplate" : null,
"canTrack" : false,
"processId" : "5603617609782872485",
"caseId" : 5526934150817204532,
"formId" : null,
"createTime" : 1653372193716,
"startUserId" : -5864651325128490804,
"startTime" : null,
"createPerson" : "test",
"completeTime" : null,
"docType" : null,
"sendType" : null,
"docMark" : null,
"serialNo" : null,
"secretLevel" : null,
"urgentLevel" : null,
"sendUnit" : null,
"sendUnitId" : null,
"issuer" : null,
"signingDate" : null,
"sendTo" : null,
"sendToId" : null,
"copyTo" : null,
"copyToId" : null,
"reportTo" : null,
"reportToId" : null,
"keywords" : "",
"printUnit" : null,
"printUnitId" : null,
"copies" : null,
"printer" : null,
"advanceRemind" : 0,
"templeteId" : -4778958472653683768,
"workflowRule" : null,
"packTime" : null,
"isunit" : false,
"docMark2" : null,
"sendUnit2" : null,
"sendUnitId2" : null,
"sendTo2" : null,
"sendToId2" : null,
"copyTo2" : null,
"copyToId2" : null,
"reportTo2" : null,
"reportToId2" : null,
"copies2" : null,
"orgDepartmentId" : -5269880793745700530,
"orgAccountId" : 1625384582942966097,
"updateTime" : 1653372193716,
"archiveId" : null,
"subEdocType" : null,
"filesm" : null,
"filefz" : null,
"party" : null,
"administrative" : null,
"sendDepartment" : null,
"sendDepartmentId" : null,
"sendDepartment2" : null,
"sendDepartmentId2" : null,
"attachments" : null,
"overWorkTime" : null,
"runWorkTime" : null,
"overTime" : null,
"runTime" : null,
"keepPeriod" : null,
"coverTime" : false,
"receiptDate" : null,
"registrationDate" : null,
"auditor" : null,
"review" : null,
"undertaker" : null,
"phone" : null,
"deadlineDatetime" : null,
"isQuickSend" : false,
"undertakenoffice" : null,
"undertakenofficeId" : null,
"unitLevel" : null,
"transferStatus" : 0,
"govdocType" : 1,
"signPerson" : null,
"signAccountId" : null,
"edocSecretLevel" : null,
"jianbanType" : 1,
"govcode" : null,
"toEdocLibFlag" : false,
"toEdocLibType" : "",
"sendDate" : null,
"receiveUnit" : null,
"receiveUnitId" : null,
"checkPerson" : null,
"proxyDate" : null,
"pishiNo" : null,
"pishiName" : null,
"pishiYear" : null,
"pishiLeaderName" : null,
"publicInfo" : null,
"formAppid" : -5455061860699387135,
"newflowType" : 0,
"attachmentArchiveId" : null,
"canModify" : true,
"formRecordid" : 3354957804421990648,
"audited" : false,
"vouch" : 0,
"bodyType" : "10",
"exchangeType" : 0,
"canArchive" : true,
"exchangeSendAffairId" : null,
"canEditAttachment" : true,
"canMergeDeal" : false,
"canAnyMerge" : false,
"canEdit" : false,
"processType" : 1,
"fromType" : 1,
"mergeDealType" : "{\"MERGE_ATTITUDE\":\"\",\"MERGE_CONTENT\":\"\"}",
"processTermType" : null,
"remindInterval" : null,
"dealSuggestion" : null,
"canDeleteNode" : true,
"dynamicSubject" : null,
"documentIdentifier" : null,
"serialNumberOfCopies" : null,
"securityClassificationAndDuration" : null,
"signOfDocIssuingAgency" : null,
"printingDate" : null,
"releaseLevel" : null,
"identificationofDocumentIssuer" : null,
"issuerlevelname" : null,
"issuerlevelID" : null,
"issuerId" : null,
"docTemplateId" : null,
"_taohongTemplateSign" : null,
"edocElementSubject" : null,
"date1" : null,
"date2" : null,
"date3" : null,
"date4" : null,
"date5" : null,
"date6" : null,
"date7" : null,
"date8" : null,
"date9" : null,
"date10" : null,
"date11" : null,
"date20" : null,
"date12" : null,
"date13" : null,
"date14" : null,
"date15" : null,
"date16" : null,
"date17" : null,
"date18" : null,
"date19" : null,
"decimal1" : null,
"decimal2" : null,
"decimal3" : null,
"decimal4" : null,
"decimal5" : null,
"decimal6" : null,
"decimal7" : null,
"decimal8" : null,
"decimal9" : null,
"decimal10" : null,
"decimal11" : null,
"decimal12" : null,
"decimal13" : null,
"decimal14" : null,
"decimal15" : null,
"decimal16" : null,
"decimal17" : null,
"decimal18" : null,
"decimal19" : null,
"decimal20" : null,
"integer1" : null,
"integer2" : null,
"integer3" : null,
"integer4" : null,
"integer5" : null,
"integer6" : null,
"integer7" : null,
"integer8" : null,
"integer9" : null,
"integer10" : null,
"integer11" : null,
"integer12" : null,
"integer13" : null,
"integer14" : null,
"integer15" : null,
"integer16" : null,
"integer17" : null,
"integer18" : null,
"integer19" : null,
"integer20" : null,
"list1" : null,
"list2" : null,
"list3" : null,
"list4" : null,
"list5" : null,
"list6" : null,
"list7" : null,
"list8" : null,
"list9" : null,
"list10" : null,
"list11" : null,
"list12" : null,
"list13" : null,
"list14" : null,
"list15" : null,
"list16" : null,
"list17" : null,
"list18" : null,
"list19" : null,
"list20" : null,
"text1" : null,
"text2" : null,
"text3" : null,
"text4" : null,
"text5" : null,
"text6" : null,
"text7" : null,
"text8" : null,
"text9" : null,
"text10" : null,
"text11" : null,
"text12" : null,
"text13" : null,
"text14" : null,
"text15" : null,
"varchar1" : null,
"varchar2" : null,
"varchar3" : null,
"varchar4" : null,
"varchar5" : null,
"varchar6" : null,
"varchar7" : null,
"varchar8" : null,
"varchar9" : null,
"varchar10" : null,
"varchar11" : null,
"varchar12" : null,
"varchar13" : null,
"varchar14" : null,
"varchar15" : null,
"varchar16" : null,
"varchar17" : null,
"varchar18" : null,
"varchar19" : null,
"varchar20" : null,
"varchar21" : null,
"varchar22" : null,
"varchar23" : null,
"varchar24" : null,
"varchar25" : null,
"varchar26" : null,
"varchar27" : null,
"varchar28" : null,
"varchar29" : null,
"varchar30" : null,
"canForward" : false,
"canDueReminder" : false,
"canAutostopflow" : false,
"updateSubject" : false,
"superviseMap" : { },
"worklfowTimeout" : false,
"finished" : false,
"isRetreat" : 0,
"contentOpenType" : "1",
"canAddComment" : true,
"importantLevel" : null,
"undertakerDep" : null,
"undertakerAccount" : null,
"comment" : null,
"sendTime" : null,
"parentformSummaryid" : null,
"projectId" : null,
"advancePigeonhole" : null,
"fontSize" : null,
"awakeDate" : null,
"isCustomDealWith" : null,
"customDealWithNode" : null,
"customDealWithMemberId" : null,
"customDealWithMemberName" : null,
"supervisorsId" : null,
"resentTime" : null,
"workitemId" : null,
"edocTypeEnum" : null,
"from" : null,
"affairId" : null,
"originalContentId" : null,
"startMember" : null,
"hasAttachments" : false,
"extraDataContainer" : { },
"extraMap" : { },
"subjectA" : "2222222222222222",
"subjectB" : "2222222222222222[发文B]"
}
}
# 返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
# 返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 说明 |
---|---|---|---|---|
» code | integer | true | none | none |
» message | string | true | none | none |
» data | object | true | none | none |
»» id | string | true | none | 生成的公文id |
# 获取公文待签收列表
Since:V61 (CAP3新公文,老企业公文)
开发者可以通过人员ID(公文交换管理员)获取公文待签收列表。
接口请求说明:
http请求方式:GET
http://ip:port/seeyon/rest/edocResource/signed?memberId={memberId}
注:请求需要携带token,否则无法使用,获取并传递token方法参考:https://open.seeyoncloud.com/seeyonapi/781/
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
memberId | 是 | 人员ID |
返回说明
请求正确,返回待签收公文JSON信息。公文待签收对象实例
# 获取公文待登记列表
Since:V61 (老企业公文)
开发者可以通过人员ID(公文交换管理员)获取公文待登记列表。
接口请求说明:
http请求方式:GET
http://ip:port/seeyon/rest/edocResource/registered?memberId={memberId}
注:请求需要携带token,否则无法使用,获取并传递token方法参考:https://open.seeyoncloud.com/seeyonapi/781/
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
memberId | 是 | 人员ID |
返回说明
请求正确,返回待登记公文JSON信息。公文待登记对象实例
# 导出MHT公文单
Since:V61 (CAP3新公文,老企业公文)
开发者可以公文ID(edoc_summary表ID)导出mht格式公文单。
接口请求说明:
http请求方式:POST
http://ip:port/seeyon/rest/edoc/id/exportmht
注:请求需要携带token,否则无法使用,获取并传递token方法参考:https://open.seeyoncloud.com/seeyonapi/781/
参数示例:
Map res = new HashMap();
String[] SummaryId={"-7993161577072146191"};
res.put("summaryid", SummaryId);
res.put("folder", "F:\UFSeeyon\folder\");
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
summaryid | 是 | edoc_summary表ID,数组 |
folder | 是 | 导出路径 |
返回说明
请求正确,在指定folder路径下产生公文单HTML与MHT文件。 folder导出路径为服务器路径,导出的文件在服务器上。
# 导出公文花脸与正文
Since:V61 (CAP3新公文,老企业公文)
开发者可以公文ID(edoc_summary表ID)导出公文正文与花脸。
接口请求说明:
http请求方式:POST
http://ip:port/seeyon/rest/edocResource/exportFile
注:请求需要携带token,否则无法使用,获取并传递token方法参考:https://open.seeyoncloud.com/seeyonapi/781/
参数示例:
Map res = new HashMap();
res.put("summaryid", 7993161577072146191);
res.put("exportType", 0);
res.put("folder", "F:\UFSeeyon\folder\");
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
summaryid | 是 | edoc_summary表ID |
folder | 是 | 导出路径 |
exportType | 是 | 0-全部;1-文单;2-正文(含花脸) |
返回说明
请求正确,在指定folder路径下产生公文单正文与花脸文件。 folder导出路径为服务器路径,导出的文件在服务器上。
# 公文签收回执接口
Since:V61 (老企业公文)
外部系统签收公文后向协同平台发送签收回执。
接口请求说明:
http请求方式:POST
http://ip:port/seeyon/rest/edoc/signedoc
注:请求需要携带token,否则无法使用,获取并传递token方法参考:https://open.seeyoncloud.com/seeyonapi/781/
参数示例:
String edocSendId="";// edocSendId对应的是edoc_exchange_send_detail表ID
Map res = new HashMap();
res.put("edocSendId", edocSendId);
Map res2 = new HashMap();
res2.put("opinion", "签收意见:OK");//签收意见
res2.put("receipient", "签收人姓名:王凯");//签收人姓名
res2.put("signUnit", "签收单位(部门)名称:政务部");//签收单位名称,如果是部门签收,则为部门名称
res.put("edocSignReceipt", res2);
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
edocSendId | 是 | edoc_exchange_send_detail表ID |
opinion | 否 | 签收意见 |
receipient | 否 | 签收人姓名 |
signUnit | 否 | 签收单位名称 |
返回说明
0未回执成功 1回执成功。