1. 工作计划服务管理
1.1. 工作计划对象
1.1.1. 计划对象示例
{
"id": 2805223632050538000,
"contentType": 20,
"refProjectId": -4472934417232279000,
"refDepartmentId": 887536619485610900,
"refAccountId": -5964772578102723000,
"createUserId": -2295828016161864200,
"createTime": 1401333817000,
"refPigeonholeId": null,
"title": "计划标题",
"startTime": 1401033600000,
"endTime": 1401465599000,
"type": "2",
"publishStatus": "2",
"planStatus": "1",
"planBody": null,
"finishRatio": null,
"hasAttachments": false,
"planMainSenders": null,
"planSubSenders": null,
"planTellUsers": null,
"planSummary": null,
"planReply": null,
"updateTime": null,
"templateId": -4289571832169738000,
"new": false,
"extraMap": { }
}
1.1.2. 计划列表对象示例
{
"data": [
{
"id": -4068546853163808300,
"contentType": 20,
"refProjectId": null,
"refDepartmentId": null,
"refAccountId": null,
"createUserId": -2295828016161864200,
"createTime": 1401348810000,
"refPigeonholeId": null,
"title": "日计划标题",
"startTime": 1401292800000,
"endTime": 1401379199000,
"type": "1",
"publishStatus": "2",
"planStatus": "1",
"planBody": null,
"finishRatio": 0,
"hasAttachments": false,
"planMainSenders": null,
"planSubSenders": null,
"planTellUsers": null,
"planSummary": null,
"planReply": null,
"updateTime": null,
"templateId": 6197134353762174000,
"planId": "-4068546853163808027",
"viewTitle": "",
"createUserName": "人员A",
"planStatusName": "未开始",
"publishStatusName": "已发布",
"relateProject": -1,
"relateDepartment": null,
"relateDepartmentName": null,
"relatePigeonhole": null,
"planToMainUser": "",
"planToMainUserName": "",
"planSubMainUser": "",
"planSubMainUserName": "",
"planTellUser": "",
"planTellUserName": "",
"isModify": null,
"hasAttatchment": false,
"process": 0,
"createTimeStr": "2014-05-29 15:33",
"updateTimeStr": null,
"relType": null,
"referType": null,
"isMentioned": 0,
"new": false,
"extraMap": { }
}
],
"page": 1,
"size": 20, 【分页信息】
"needTotal": true,
"total": 1,
"sortField": null,
"sortOrder": null,
"params": null,
"pages": 1,
"startAt": 0,
"dataCount": 1
}
1.1.3. 计划属性说明
id | 主键ID |
---|---|
contentType | 正文类型 |
refProjectId | 关联项目id |
refDepartmentId | 关联部门ID |
refAccountId | 单位id |
createUserId | 创建者id |
createTime | 创建时间 |
refPigeonholeId | 归档目录id |
title | 标题 |
startTime | 计划开始时间 |
endTime | 计划结束时间 |
type | 计划类型 |
publishStatus | |
planStatus | 计划状态 |
planBody | |
finishRatio | 计划完成率 |
hasAttachments | 附件标识 |
planMainSenders | |
planSubSenders | |
planTellUsers | |
planSummary | |
planReply | |
updateTime | 最后修改时间 |
templateId | 正文类型ID |
new | - |
1.2. 按计划Id取得计划
开发者可以通过【计划ID】来获取计划信息。
接口请求说明:
http请求方式:GET
http://ip:port/seeyon/rest/plan/{id}
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
id | 是 | 计划ID |
返回说明
正常情况下,会返回的是JSON格式计划信息,JSON数据包参考:计划对象示例
参数说明 请参考:计划属性说明
1.3. 我的计划列表/他人计划列表
开发者可以通过【人员ID(V7.1之前可用),计划类型,列表类型,计划发起时间,计划结束时间】来获取计划信息。
接口升级说明:
从V7.1起请求接口中取消了人员ID参数,所以升级到7.1后,调用此接口的地方需要进行修改。
修改方式:将接口中人员ID参数去掉,改为在token中绑定人员信息。
接口请求说明:
http请求方式:GET
// 接口地址(V7.1之前)
http://ip:port/seeyon/rest/plans/{userId}/{planType}/{userType}?startTime={startTime}&endTime={endTime}
// 接口地址(Since:V7.1)
http://ip:port/seeyon/rest/plans/{planType}/{userType}?startTime={startTime}&endTime={endTime}
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
userId | 是 | 人员ID。从V7.1起废弃userId参数,改为在token中绑定人员信息。 |
planType | 是 | 计划类型【1=日计划 、2=周计划、3=月计划、4=任意期计划 】 |
userType | 是 | 列表类型【4=我的计划、5=他人计划】 |
startTime | 是 | 计划发起时间【当计划类型为4(任意期计划)时此参数有效,示例2014-05-29 00:00:59】 (注意:V6.0版本开始,此参数传递时间的Long值,不再使用字符串的时间格式) |
endTime | 是 | 计划结束时间【当计划类型为4(任意期计划)时此参数有效,示例2014-05-29 23:59:59】 (注意:V6.0版本开始,此参数传递时间的Long值,不再使用字符串的时间格式) |
返回说明
正常情况下,会返回的是JSON格式计划信息,JSON数据包参考:计划列表对象示例
参数说明 请参考:计划属性说明
1.4. 总结计划
开发者可以将计划相关参数组装为JSON类型,来创建计划总结信息。
接口请求说明:
http请求方式:POST
http://ip:port/seeyon/rest/plan/summary
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
Long planId | 是 | 总结计划对应ID【plan_info表ID】 |
Long refUserId | 是 | 总结人员ID |
String refUserName | 是 | 总结人员姓名 |
String summaryText | 是 | 总结内容 |
Float finishRatio | 是 | 计划完成率 |
Date createTime | 是 | 计划总结时间 |
返回说明
正常情况下,创建成功会返回成功的标识true;
如果岗位创建失败,同样会返回失败的标识false;
1.5. 回复计划
开发者可以将计划相关参数组装为JSON类型,来创建计划回复信息。
接口请求说明:
http请求方式:POST
http://ip:port/seeyon/rest/plan/reply
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
Long createId | 是 | 回复人ID |
Date createDate | 是 | 回复时间 |
String path | 是 | 设置当前用户访问来源设备 如:String path="pc" |
String showToId | 是 | 隐藏时公开者ID 如:String showToId=null |
Boolean hidden | 是 | 是否隐藏,0否;1是 如:Boolean hidden=false |
Integer forwardCount | 是 | 转发次数 |
Integer ctype | 是 | 类型:-2为草稿;-1为发起人附言;0为评论;1为回复,计划回复应该是0 |
Integer moduleType | 是 | 回复类型 应该是5。 |
Long moduleId | 是 | 计划ID |
String content | 是 | 回复内容 |
Long pid | 是 | 计划ID,初次回复应该为0,如:Long pid=0L |
Integer clevel | 是 | 当前节点层级,顶级为1, 如:Integer clevel=1 |
返回说明
如果没有找到对应的计划ID则返回delete;
如果计划已经总结over;
正常情况下,创建成功会返回创建的回复JSON信息,如下;
{
"parent": null,
"id": "-4534056719296542144",
"path": "pc",
"hidden": false,
"content": "回复内容",
"children": [ ],
"moduleType": 5,
"title": null,
"createDate": "2014-06-06 17:13",
"moduleId": "1378328433440933803",
"showToId": null,
"extAtt1": null,
"extAtt2": null,
"pid": "0",
"createId": "-2295828016161864209",
"modifyDate": null,
"ctype": 0,
"extAtt3": null,
"clevel": 1,
"relateInfo": null,
"forwardCount": 0,
"affairId": null,
"escapedContent": "回复内容",
"canView": true,
"m1Info": "",
"maxChildPath": 1,
"childrenCount": 0,
"createDateStr": "2014-06-06 17:13",
"createName": "创建者名称",
"attachList": [ ],
"hasRelateAttach": false,
"hasRelateDocument": false,
"pushMessageToMembersList": [ ],
"pushMessage": null,
"pushMessageToMembers": null
}