github/dootask
1
0
Fork 0
mirror of https://github.com/kuaifan/dootask.git synced 2026-01-10 07:48:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
dootask/public/docs/swagger.json
ganzizi 150d9f18b4 feat 新增工作流导出
2023-04-20 11:51:39 +08:00

9823 lines
386 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"swagger": "2.0",
"info": {
"title": "DooTask",
"version": "0.25.84"
},
"basePath": "/",
"tags": [
{
"name": "对话",
"description": "对话"
},
{
"name": "文件",
"description": "文件"
},
{
"name": "项目",
"description": "项目"
},
{
"name": "公开",
"description": "公开"
},
{
"name": "汇报",
"description": "汇报"
},
{
"name": "系统",
"description": "系统"
},
{
"name": "会员",
"description": "会员"
},
{
"name": "工作流",
"description": "工作流"
}
],
"schemes": [
"http"
],
"paths": {
"api/dialog/lists": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "01. 对话列表",
"description": "需要token身份",
"parameters": [
{
"name": "timerange",
"in": "query",
"required": false,
"description": "时间范围（如：1678248944,1678248944）\n 第一个时间: 读取在这个时间之后更新的数据\n 第二个时间: 读取在这个时间之后删除的数据ID（第1页附加返回数据: deleted_id）",
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:50，最大:100",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/search": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "02. 搜索会话",
"description": "根据消息关键词搜索相关会话，需要token身份",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"description": "消息关键词",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/one": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "03. 获取单个会话信息",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "对话ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/user": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "04. 获取会话成员",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
},
{
"name": "getuser",
"in": "query",
"required": false,
"description": "获取会员详情（1: 返回会员昵称、邮箱等基本信息，0: 默认不返回）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/todo": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "05. 获取会话待办",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/top": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "06. 会话置顶",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/tel": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "07. 获取对方联系电话",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/open/user": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "08. 打开会话",
"description": "需要token身份",
"parameters": [
{
"name": "userid",
"in": "query",
"required": true,
"description": "对话会员ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/list": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "09. 获取消息列表",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "对话ID",
"type": "number"
},
{
"name": "msg_id",
"in": "query",
"required": false,
"description": "消息ID",
"type": "number"
},
{
"name": "position_id",
"in": "query",
"required": false,
"description": "此消息ID前后的数据",
"type": "number"
},
{
"name": "prev_id",
"in": "query",
"required": false,
"description": "此消息ID之前的数据",
"type": "number"
},
{
"name": "next_id",
"in": "query",
"required": false,
"description": "此消息ID之后的数据\n position_id、prev_id、next_id 只有一个有效，优先循序为：position_id > prev_id > next_id",
"type": "number"
},
{
"name": "msg_type",
"in": "query",
"required": false,
"description": "消息类型\n tag: 标记\n link: 链接\n text: 文本\n image: 图片\n file: 文件\n record: 录音\n meeting: 会议",
"type": "string"
},
{
"name": "take",
"in": "query",
"required": false,
"description": "获取条数，默认:50，最大:100",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/search": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "10. 搜索消息位置",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "对话ID",
"type": "number"
},
{
"name": "key",
"in": "query",
"required": true,
"description": "搜索关键词",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/one": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "11. 获取单条消息",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/read": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "12. 已读聊天消息",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "消息ID（组）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/unread": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "13. 获取未读消息数据",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "对话ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据",
"properties": {
"id": {
"type": "number"
},
"unread": {
"type": "number"
},
"mention": {
"type": "number"
},
"user_at": {
"type": "string"
},
"user_ms": {
"type": "number"
}
}
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/sendtext": {
"post": {
"tags": [
"对话"
],
"consumes": [
"multipart/form-data"
],
"summary": "14. 发送消息",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "对话ID",
"type": "number"
},
{
"name": "text",
"in": "query",
"required": true,
"description": "消息内容",
"type": "string"
},
{
"name": "text_type",
"in": "query",
"required": false,
"description": "消息类型\n html: HTML（默认）\n md: MARKDOWN",
"type": "string"
},
{
"name": "update_id",
"in": "query",
"required": false,
"description": "更新消息ID（优先大于 reply_id）",
"type": "number"
},
{
"name": "reply_id",
"in": "query",
"required": false,
"description": "回复ID",
"type": "number"
},
{
"name": "silence",
"in": "query",
"required": false,
"description": "是否静默发送\n no: 正常发送（默认）\n yes: 静默发送",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/sendrecord": {
"post": {
"tags": [
"对话"
],
"consumes": [
"multipart/form-data"
],
"summary": "15. 发送语音",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "对话ID",
"type": "number"
},
{
"name": "reply_id",
"in": "query",
"required": false,
"description": "回复ID",
"type": "number"
},
{
"name": "base64",
"in": "query",
"required": true,
"description": "语音base64",
"type": "string"
},
{
"name": "duration",
"in": "query",
"required": true,
"description": "语音时长（毫秒）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/sendfile": {
"post": {
"tags": [
"对话"
],
"consumes": [
"multipart/form-data"
],
"summary": "16. 文件上传",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "对话ID",
"type": "number"
},
{
"name": "reply_id",
"in": "query",
"required": false,
"description": "回复ID",
"type": "number"
},
{
"name": "image_attachment",
"in": "query",
"required": false,
"description": "图片是否也存到附件",
"type": "number"
},
{
"name": "filename",
"in": "query",
"required": false,
"description": "post-文件名称",
"type": "string"
},
{
"name": "image64",
"in": "query",
"required": false,
"description": "post-base64图片（二选一）",
"type": "string"
},
{
"name": "files",
"in": "query",
"required": false,
"description": "post-文件对象（二选一）",
"type": "file"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/sendfileid": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "17. 通过文件ID发送文件",
"description": "需要token身份",
"parameters": [
{
"name": "file_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
},
{
"name": "dialogids",
"in": "query",
"required": true,
"description": "转发给的对话ID",
"type": "array"
},
{
"name": "userids",
"in": "query",
"required": true,
"description": "转发给的成员ID",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/sendanon": {
"post": {
"tags": [
"对话"
],
"consumes": [
"multipart/form-data"
],
"summary": "18. 发送匿名消息",
"description": "需要token身份",
"parameters": [
{
"name": "userid",
"in": "query",
"required": true,
"description": "对方会员ID",
"type": "number"
},
{
"name": "text",
"in": "query",
"required": true,
"description": "消息内容",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/readlist": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "19. 获取消息阅读情况",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID（需要是消息的发送人）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/detail": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "20. 消息详情",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
},
{
"name": "only_update_at",
"in": "query",
"required": true,
"description": "仅获取update_at字段\n no (默认)\n yes",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/download": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "21. 文件下载",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
},
{
"name": "down",
"in": "query",
"required": true,
"description": "直接下载\n yes: 下载（默认）\n preview: 转预览地址",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/withdraw": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "22. 聊天消息撤回",
"description": "消息撤回限制24小时内，需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/mark": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "23. 消息标记操作",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
},
{
"name": "type",
"in": "query",
"required": true,
"description": "类型\n read: 已读\n unread: 未读",
"type": "string"
},
{
"name": "after_msg_id",
"in": "query",
"required": false,
"description": "仅标记已读指定之后（含）的消息",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/silence": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "24. 消息免打扰",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
},
{
"name": "type",
"in": "query",
"required": true,
"description": "类型\n set\n cancel",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/forward": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "25. 转发消息给",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
},
{
"name": "dialogids",
"in": "query",
"required": true,
"description": "转发给的对话ID",
"type": "array"
},
{
"name": "userids",
"in": "query",
"required": true,
"description": "转发给的成员ID",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/emoji": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "26. emoji回复",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
},
{
"name": "symbol",
"in": "query",
"required": true,
"description": "回复或取消的emoji表情",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/tag": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "27. 标注/取消标注",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/todo": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "28. 设待办/取消待办",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
},
{
"name": "type",
"in": "query",
"required": true,
"description": "设待办对象\n all: 会话全部成员（默认）\n user: 会话指定成员",
"type": "string"
},
{
"name": "userids",
"in": "query",
"required": true,
"description": "会员ID组（type=user有效，格式: [userid1, userid2, userid3]）",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/todolist": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "29. 获取消息待办情况",
"description": "需要token身份",
"parameters": [
{
"name": "msg_id",
"in": "query",
"required": true,
"description": "消息ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/msg/done": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "30. 完成待办",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "待办数据ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/group/add": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "31. 新增群组",
"description": "需要token身份",
"parameters": [
{
"name": "avatar",
"in": "query",
"required": false,
"description": "群头像",
"type": "string"
},
{
"name": "chat_name",
"in": "query",
"required": false,
"description": "群名称",
"type": "string"
},
{
"name": "userids",
"in": "query",
"required": true,
"description": "群成员，格式: [userid1, userid2, userid3]",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/group/edit": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "32. 修改群组",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
},
{
"name": "avatar",
"in": "query",
"required": false,
"description": "群头像",
"type": "string"
},
{
"name": "chat_name",
"in": "query",
"required": false,
"description": "群名称",
"type": "string"
},
{
"name": "admin",
"in": "query",
"required": false,
"description": "系统管理员操作（1：只判断是不是系统管理员，否则判断是否群管理员）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/group/adduser": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "33. 添加群成员",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
},
{
"name": "userids",
"in": "query",
"required": true,
"description": "新增的群成员，格式: [userid1, userid2, userid3]",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/group/deluser": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "34. 移出（退出）群成员",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
},
{
"name": "userids",
"in": "query",
"required": false,
"description": "移出的群成员，格式: [userid1, userid2, userid3]\n 留空表示自己退出\n 有值表示移出，仅限群主操作",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/group/transfer": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "35. 转让群组",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
},
{
"name": "userid",
"in": "query",
"required": true,
"description": "新的群主",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/group/disband": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "36. 解散群组",
"description": "需要token身份",
"parameters": [
{
"name": "dialog_id",
"in": "query",
"required": true,
"description": "会话ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/dialog/group/searchuser": {
"get": {
"tags": [
"对话"
],
"consumes": [],
"summary": "37. 搜索个人群（仅限管理员）",
"description": "需要token身份，用于创建部门搜索个人群组",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"description": "关键词",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/lists": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "01. 获取文件列表",
"description": "需要token身份",
"parameters": [
{
"name": "pid",
"in": "query",
"required": false,
"description": "父级ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/one": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "02. 获取单条数据",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "id\n Number 文件ID（需要登录）\n String 链接码（不需要登录，用于预览）",
"type": "number|string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/search": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "03. 搜索文件列表",
"description": "需要token身份",
"parameters": [
{
"name": "link",
"in": "query",
"required": false,
"description": "通过分享地址搜索（如：https://t.hitosea.com/single/file/ODcwOCwzOSxpa0JBS2lmVQ==）",
"type": "string"
},
{
"name": "key",
"in": "query",
"required": false,
"description": "关键词",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/add": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "04. 添加、修改文件(夹)",
"description": "需要token身份",
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"description": "项目名称",
"type": "string"
},
{
"name": "type",
"in": "query",
"required": true,
"description": "文件类型",
"type": "string"
},
{
"name": "id",
"in": "query",
"required": false,
"description": "文件ID（赋值修改文件名称）",
"type": "number"
},
{
"name": "pid",
"in": "query",
"required": false,
"description": "父级ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/copy": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "05. 复制文件(夹)",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/move": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "06. 移动文件(夹)",
"description": "需要token身份",
"parameters": [
{
"name": "ids",
"in": "query",
"required": true,
"description": "文件ID（格式：[id1, id2]）",
"type": "numbers"
},
{
"name": "pid",
"in": "query",
"required": true,
"description": "移动到的文件夹ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/remove": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "07. 删除文件(夹)",
"description": "需要token身份",
"parameters": [
{
"name": "ids",
"in": "query",
"required": true,
"description": "文件ID（格式：[id1, id2]）",
"type": "numbers"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/content": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "08. 获取文件内容",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "id\n Number: 文件ID（需要登录）\n String: 链接码（不需要登录，用于预览）",
"type": "number|string"
},
{
"name": "only_update_at",
"in": "query",
"required": true,
"description": "仅获取update_at字段\n no (默认)\n yes",
"type": "string"
},
{
"name": "down",
"in": "query",
"required": true,
"description": "直接下载\n no: 浏览（默认）\n yes: 下载（office文件直接下载，除非是preview）\n preview: 转预览地址",
"type": "string"
},
{
"name": "history_id",
"in": "query",
"required": false,
"description": "读取历史记录ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/content/save": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "09. 保存文件内容",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
},
{
"name": "D",
"in": "query",
"required": false,
"description": "Request Payload 提交\n content: 内容",
"type": "object"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/content/office": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "10. 保存文件内容（office）",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/content/upload": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "11. 保存文件内容（上传文件）",
"description": "需要token身份",
"parameters": [
{
"name": "pid",
"in": "query",
"required": false,
"description": "父级ID",
"type": "number"
},
{
"name": "files",
"in": "query",
"required": false,
"description": "文件名",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/content/history": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "12. 获取内容历史",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:20，最大:100",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/content/restore": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "13. 恢复文件历史",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
},
{
"name": "history_id",
"in": "query",
"required": true,
"description": "历史数据ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/share": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "14. 获取共享信息",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/share/update": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "15. 设置共享",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
},
{
"name": "userids",
"in": "query",
"required": false,
"description": "共享成员，格式: [userid1, userid2, userid3]",
"type": "array"
},
{
"name": "permission",
"in": "query",
"required": false,
"description": "共享方式\n 0：只读\n 1：读写\n -1: 删除",
"type": "number"
},
{
"name": "force",
"in": "query",
"required": false,
"description": "设置共享时是否忽略提醒\n 0：如果子文件夹已存在共享则ret返回-3001（默认）\n 1：忽略提醒",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/share/out": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "16. 退出共享",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/file/link": {
"get": {
"tags": [
"文件"
],
"consumes": [],
"summary": "17. 获取链接",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
},
{
"name": "refresh",
"in": "query",
"required": true,
"description": "刷新链接\n no: 只获取（默认）\n yes: 刷新链接，之前的将失效",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/lists": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "01. 获取项目列表",
"description": "需要token身份",
"parameters": [
{
"name": "all",
"in": "query",
"required": false,
"description": "是否查看所有项目（限制管理员）",
"type": "string"
},
{
"name": "type",
"in": "query",
"required": false,
"description": "项目类型\n all：全部（默认）\n team：团队项目\n personal：个人项目",
"type": "string"
},
{
"name": "archived",
"in": "query",
"required": false,
"description": "归档状态\n all：全部\n no：未归档（默认）\n yes：已归档",
"type": "string"
},
{
"name": "getcolumn",
"in": "query",
"required": false,
"description": "同时取项目列表\n no：不取（默认）\n yes：取列表",
"type": "string"
},
{
"name": "keys",
"in": "query",
"required": false,
"description": "搜索条件\n keys.name: 项目名称",
"type": "object"
},
{
"name": "timerange",
"in": "query",
"required": false,
"description": "时间范围（如：1678248944,1678248944）\n 第一个时间: 读取在这个时间之后更新的数据\n 第二个时间: 读取在这个时间之后删除的数据ID（第1页附加返回数据: deleted_id）",
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:50，最大:100",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/one": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "02. 获取一个项目信息",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/add": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "03. 添加项目",
"description": "需要token身份",
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"description": "项目名称",
"type": "string"
},
{
"name": "desc",
"in": "query",
"required": false,
"description": "项目介绍",
"type": "string"
},
{
"name": "columns",
"in": "query",
"required": false,
"description": "列表，格式：列表名称1,列表名称2",
"type": "string"
},
{
"name": "flow",
"in": "query",
"required": false,
"description": "开启流程\n open: 开启\n close: 关闭（默认）",
"type": "string"
},
{
"name": "personal",
"in": "query",
"required": false,
"description": "个人项目，注册成功时创建（仅支持创建一个个人项目）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/update": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "04. 修改项目",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "name",
"in": "query",
"required": true,
"description": "项目名称",
"type": "string"
},
{
"name": "desc",
"in": "query",
"required": false,
"description": "项目介绍",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/user": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "05. 修改项目成员",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "userid",
"in": "query",
"required": true,
"description": "成员ID 或 成员ID组",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/invite": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "06. 获取邀请链接",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "refresh",
"in": "query",
"required": true,
"description": "刷新链接\n no: 只获取（默认）\n yes: 刷新链接，之前的将失效",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/invite/info": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "07. 通过邀请链接code获取项目信息",
"description": "需要token身份",
"parameters": [
{
"name": "code",
"in": "query",
"required": true,
"description": "code",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/invite/join": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "08. 通过邀请链接code加入项目",
"description": "需要token身份",
"parameters": [
{
"name": "code",
"in": "query",
"required": true,
"description": "code",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/transfer": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "09. 移交项目",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "owner_userid",
"in": "query",
"required": true,
"description": "新的项目负责人ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/sort": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "10. 排序任务",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "sort",
"in": "query",
"required": true,
"description": "排序数据",
"type": "object"
},
{
"name": "only_column",
"in": "query",
"required": false,
"description": "仅更新列表",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/exit": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "11. 退出项目",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/archived": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "12. 归档项目",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "type",
"in": "query",
"required": false,
"description": "类型\n add：归档（默认）\n recovery：还原归档",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/remove": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "13. 删除项目",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/column/lists": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "14. 获取任务列表",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:100，最大:200",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/column/add": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "15. 添加任务列表",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "name",
"in": "query",
"required": true,
"description": "列表名称",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/column/update": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "16. 修改任务列表",
"description": "需要token身份",
"parameters": [
{
"name": "column_id",
"in": "query",
"required": true,
"description": "列表ID",
"type": "number"
},
{
"name": "name",
"in": "query",
"required": false,
"description": "列表名称",
"type": "string"
},
{
"name": "color",
"in": "query",
"required": false,
"description": "颜色",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/column/remove": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "17. 删除任务列表",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "column_id",
"in": "query",
"required": true,
"description": "列表ID（留空为添加列表）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/lists": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "18. 任务列表",
"description": "需要token身份",
"parameters": [
{
"name": "keys",
"in": "query",
"required": false,
"description": "搜索条件\n keys.name: ID、任务名称",
"type": "object"
},
{
"name": "project_id",
"in": "query",
"required": false,
"description": "项目ID",
"type": "number"
},
{
"name": "parent_id",
"in": "query",
"required": false,
"description": "主任务ID（project_id && parent_id ≤ 0 时 仅查询自己参与的任务）\n 大于0：指定主任务下的子任务\n 等于-1：表示仅主任务",
"type": "number"
},
{
"name": "time",
"in": "query",
"required": false,
"description": "指定时间范围，如：['2020-12-12', '2020-12-30']",
"type": "array"
},
{
"name": "timerange",
"in": "query",
"required": false,
"description": "时间范围（如：1678248944,1678248944）\n 第一个时间: 读取在这个时间之后更新的数据\n 第二个时间: 读取在这个时间之后删除的数据ID（第1页附加返回数据: deleted_id）",
"type": "string"
},
{
"name": "archived",
"in": "query",
"required": false,
"description": "归档状态\n all：所有（parent_id > 0 时强制 all）\n yes：已归档\n no：未归档（默认）",
"type": "string"
},
{
"name": "deleted",
"in": "query",
"required": false,
"description": "是否读取已删除\n all：所有\n yes：已删除\n no：未删除（默认）",
"type": "string"
},
{
"name": "sorts",
"in": "query",
"required": false,
"description": "排序方式\n sorts.complete_at 完成时间：asc|desc\n sorts.archived_at 归档时间：asc|desc\n sorts.end_at 到期时间：asc|desc",
"type": "object"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/export": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "19. 导出任务（限管理员）",
"description": "导出指定范围任务（已完成、未完成、已归档），返回下载地址，需要token身份",
"parameters": [
{
"name": "userid",
"in": "query",
"required": false,
"description": "指定会员，如：[1, 2]",
"type": "array"
},
{
"name": "time",
"in": "query",
"required": false,
"description": "指定时间范围，如：['2020-12-12', '2020-12-30']",
"type": "array"
},
{
"name": "[type]",
"in": "query",
"required": true,
"description": "[type]\n createdTime 任务创建时间\n taskTime 任务计划时间（默认）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/exportoverdue": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "20. 导出超期任务（限管理员）",
"description": "导出指定范围任务（已完成、未完成、已归档），返回下载地址，需要token身份",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/down": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "21. 下载导出的任务",
"description": "",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"description": "通过export接口得到的下载钥匙",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "file",
"description": "返回数据（直接下载文件）"
}
},
"required": [
"data"
]
}
}
}
}
},
"api/project/task/one": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "22. 获取单个任务信息",
"description": "需要token身份",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
},
{
"name": "archived",
"in": "query",
"required": false,
"description": "归档状态\n all：所有\n yes：已归档\n no：未归档（默认）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/content": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "23. 获取任务详细描述",
"description": "需要token身份",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/files": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "24. 获取任务文件列表",
"description": "需要token身份",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/filedelete": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "25. 删除任务文件",
"description": "需要token身份（限：项目、任务负责人）",
"parameters": [
{
"name": "file_id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/filedetail": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "26. 获取任务文件详情",
"description": "需要token身份",
"parameters": [
{
"name": "file_id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
},
{
"name": "only_update_at",
"in": "query",
"required": true,
"description": "仅获取update_at字段\n no (默认)\n yes",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/filedown": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "27. 下载任务文件",
"description": "需要token身份",
"parameters": [
{
"name": "file_id",
"in": "query",
"required": true,
"description": "文件ID",
"type": "number"
},
{
"name": "down",
"in": "query",
"required": true,
"description": "直接下载\n yes: 下载（默认）\n preview: 转预览地址",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/add": {
"post": {
"tags": [
"项目"
],
"consumes": [
"multipart/form-data"
],
"summary": "28. 添加任务",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "column_id",
"in": "query",
"required": false,
"description": "列表ID，任意值自动创建，留空取第一个",
"type": "mixed"
},
{
"name": "name",
"in": "query",
"required": true,
"description": "任务描述",
"type": "string"
},
{
"name": "content",
"in": "query",
"required": false,
"description": "任务详情",
"type": "string"
},
{
"name": "times",
"in": "query",
"required": false,
"description": "计划时间（格式：开始时间,结束时间；如：2020-01-01 00:00,2020-01-01 23:59）",
"type": "array"
},
{
"name": "owner",
"in": "query",
"required": false,
"description": "负责人",
"type": "number"
},
{
"name": "subtasks",
"in": "query",
"required": false,
"description": "子任务（格式：[{name,owner,times}]）",
"type": "array"
},
{
"name": "top",
"in": "query",
"required": false,
"description": "添加的任务排到列表最前面",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/addsub": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "29. 添加子任务",
"description": "需要token身份（限：项目、任务负责人）",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
},
{
"name": "name",
"in": "query",
"required": true,
"description": "任务描述",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/update": {
"post": {
"tags": [
"项目"
],
"consumes": [
"multipart/form-data"
],
"summary": "30. 修改任务、子任务",
"description": "需要token身份（限：项目、任务负责人）",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
},
{
"name": "name",
"in": "query",
"required": false,
"description": "任务描述",
"type": "string"
},
{
"name": "times",
"in": "query",
"required": false,
"description": "计划时间（格式：开始时间,结束时间；如：2020-01-01 00:00,2020-01-01 23:59）",
"type": "array"
},
{
"name": "loop",
"in": "query",
"required": false,
"description": "重复周期，数字代表天数（子任务不支持）",
"type": "string"
},
{
"name": "owner",
"in": "query",
"required": false,
"description": "修改负责人",
"type": "array"
},
{
"name": "content",
"in": "query",
"required": false,
"description": "任务详情（子任务不支持）",
"type": "string"
},
{
"name": "color",
"in": "query",
"required": false,
"description": "背景色（子任务不支持）",
"type": "string"
},
{
"name": "assist",
"in": "query",
"required": false,
"description": "修改协助人员（子任务不支持）",
"type": "array"
},
{
"name": "p_level",
"in": "query",
"required": false,
"description": "优先级相关（子任务不支持）",
"type": "number"
},
{
"name": "p_name",
"in": "query",
"required": false,
"description": "优先级相关（子任务不支持）",
"type": "string"
},
{
"name": "p_color",
"in": "query",
"required": false,
"description": "优先级相关（子任务不支持）",
"type": "string"
},
{
"name": "flow_item_id",
"in": "query",
"required": false,
"description": "任务状态，工作流状态ID",
"type": "number"
},
{
"name": "complete_at",
"in": "query",
"required": false,
"description": "完成时间（如：2020-01-01 00:00，false表示未完成）",
"type": "string|false"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/dialog": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "31. 创建/获取聊天室",
"description": "需要token身份",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/archived": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "32. 归档任务",
"description": "需要token身份（限：项目、任务负责人）",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
},
{
"name": "type",
"in": "query",
"required": false,
"description": "类型\n add：归档（默认）\n recovery：还原归档",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/remove": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "33. 删除任务",
"description": "需要token身份（限：项目、任务负责人）",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
},
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n recovery: 还原\n delete: 删除（默认）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/resetfromlog": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "34. 根据日志重置任务",
"description": "需要token身份（限：项目、任务负责人）",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/task/flow": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "35. 任务工作流信息",
"description": "需要token身份",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/flow/list": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "36. 工作流列表",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/flow/save": {
"post": {
"tags": [
"项目"
],
"consumes": [
"multipart/form-data"
],
"summary": "37. 保存工作流",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "flows",
"in": "query",
"required": true,
"description": "工作流数据",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/flow/delete": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "38. 删除工作流",
"description": "需要token身份（限：项目负责人）",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/log/lists": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "39. 获取项目、任务日志",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
},
{
"name": "task_id",
"in": "query",
"required": true,
"description": "任务ID（与 项目ID 二选一，任务ID优先）",
"type": "number"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:20，最大:100",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/project/top": {
"get": {
"tags": [
"项目"
],
"consumes": [],
"summary": "40. 项目置顶",
"description": "需要token身份",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "项目ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/my": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "01. 我发送的汇报",
"description": "",
"parameters": [
{
"name": "keys",
"in": "query",
"required": false,
"description": "搜索条件\n keys.type: 汇报类型，weekly:周报，daily:日报\n keys.created_at: 汇报时间",
"type": "object"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:20，最大:50",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/receive": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "02. 我接收的汇报",
"description": "",
"parameters": [
{
"name": "keys",
"in": "query",
"required": false,
"description": "搜索条件\n keys.key: 关键词\n keys.type: 汇报类型，weekly:周报，daily:日报\n keys.created_at: 汇报时间",
"type": "object"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:20，最大:50",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/store": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "03. 保存并发送工作汇报",
"description": "",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "汇报ID，0为新建",
"type": "number"
},
{
"name": "sign",
"in": "query",
"required": false,
"description": "唯一签名，通过[api/report/template]接口返回",
"type": "string"
},
{
"name": "title",
"in": "query",
"required": true,
"description": "汇报标题",
"type": "string"
},
{
"name": "type",
"in": "query",
"required": true,
"description": "汇报类型，weekly:周报，daily:日报",
"type": "array"
},
{
"name": "content",
"in": "query",
"required": true,
"description": "内容",
"type": "number"
},
{
"name": "receive",
"in": "query",
"required": false,
"description": "汇报对象",
"type": "number"
},
{
"name": "offset",
"in": "query",
"required": true,
"description": "时间偏移量",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/template": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "04. 生成汇报模板",
"description": "",
"parameters": [
{
"name": "type",
"in": "query",
"required": false,
"description": "汇报类型，weekly:周报，daily:日报",
"type": "array"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "偏移量",
"type": "number"
},
{
"name": "date",
"in": "query",
"required": false,
"description": "时间",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/detail": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "05. 报告详情",
"description": "",
"parameters": [
{
"name": "id",
"in": "query",
"required": false,
"description": "报告id",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/mark": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "06. 标记已读/未读",
"description": "",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "报告id（组）",
"type": "number"
},
{
"name": "action",
"in": "query",
"required": true,
"description": "操作\n read: 标记已读（默认）\n unread: 标记未读",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/last_submitter": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "07. 获取最后一次提交的接收人",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/unread": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "08. 获取未读",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/report/read": {
"get": {
"tags": [
"汇报"
],
"consumes": [],
"summary": "09. 标记汇报已读，可批量",
"description": "",
"parameters": [
{
"name": "ids",
"in": "query",
"required": false,
"description": "报告id",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/setting": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "01. 获取设置、保存设置",
"description": "",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取（默认）\n all: 获取所有（需要管理员权限）\n save: 保存设置（参数：['reg', 'reg_identity', 'reg_invite', 'login_code', 'password_policy', 'project_invite', 'chat_information', 'anon_message', 'auto_archived', 'archived_day', 'all_group_mute', 'all_group_autoin', 'image_compress', 'image_save_local', 'start_home', 'home_footer']）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/setting/email": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "02. 获取邮箱设置、保存邮箱设置（限管理员）",
"description": "",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取（默认）\n save: 保存设置（参数：['smtp_server', 'port', 'account', 'password', 'reg_verify', 'notice_msg', 'msg_unread_user_minute', 'msg_unread_group_minute', 'ignore_addr']）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/setting/meeting": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "03. 获取会议设置、保存会议设置（限管理员）",
"description": "",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取（默认）\n save: 保存设置（参数：['open', 'appid', 'app_certificate']）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/setting/checkin": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "04. 获取签到设置、保存签到设置（限管理员）",
"description": "",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取（默认）\n save: 保存设置（参数：['open', 'time', 'advance', 'delay', 'remindin', 'remindexceed', 'edit', 'key']）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/setting/apppush": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "05. 获取APP推送设置、保存APP推送设置（限管理员）",
"description": "",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取（默认）\n save: 保存设置（参数：['push', 'ios_key', 'ios_secret', 'android_key', 'android_secret']）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/setting/thirdaccess": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "06. 第三方帐号（限管理员）",
"description": "",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取（默认）\n save: 保存设置（参数：['ldap_open', 'ldap_host', 'ldap_port', 'ldap_password', 'ldap_user_dn', 'ldap_base_dn', 'ldap_sync_local']）\n testldap: 测试ldap连接",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/demo": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "07. 获取演示帐号",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/priority": {
"post": {
"tags": [
"系统"
],
"consumes": [
"multipart/form-data"
],
"summary": "08. 任务优先级",
"description": "获取任务优先级、保存任务优先级",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取（默认）\n save: 保存（限管理员）",
"type": "string"
},
{
"name": "list",
"in": "query",
"required": true,
"description": "优先级数据，格式：[{name,color,days,priority}]",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/column/template": {
"post": {
"tags": [
"系统"
],
"consumes": [
"multipart/form-data"
],
"summary": "09. 创建项目模板",
"description": "获取创建项目模板、保存创建项目模板",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取（默认）\n save: 保存（限管理员）",
"type": "string"
},
{
"name": "list",
"in": "query",
"required": true,
"description": "优先级数据，格式：[{name,columns}]",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/license": {
"post": {
"tags": [
"系统"
],
"consumes": [
"multipart/form-data"
],
"summary": "10. License",
"description": "获取License信息、保存License（限管理员）",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "type\n get: 获取\n save: 保存",
"type": "string"
},
{
"name": "license",
"in": "query",
"required": true,
"description": "License 原文",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/get/info": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "11. 获取终端详细信息",
"description": "",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"description": "key值",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/get/ip": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "12. 获取IP地址",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/get/cnip": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "13. 是否中国IP地址",
"description": "",
"parameters": [
{
"name": "ip",
"in": "query",
"required": true,
"description": "IP值",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/get/ipgcj02": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "14. 获取IP地址经纬度",
"description": "",
"parameters": [
{
"name": "ip",
"in": "query",
"required": true,
"description": "IP值",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/get/ipinfo": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "15. 获取IP地址详细信息",
"description": "",
"parameters": [
{
"name": "ip",
"in": "query",
"required": true,
"description": "IP值",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/imgupload": {
"post": {
"tags": [
"系统"
],
"consumes": [
"multipart/form-data"
],
"summary": "16. 上传图片",
"description": "需要token身份",
"parameters": [
{
"name": "image",
"in": "query",
"required": true,
"description": "post-图片对象",
"type": "file"
},
{
"name": "image64",
"in": "query",
"required": false,
"description": "post-图片base64（与'image'二选一）",
"type": "string"
},
{
"name": "filename",
"in": "query",
"required": true,
"description": "post-文件名",
"type": "string"
},
{
"name": "width",
"in": "query",
"required": false,
"description": "压缩图片宽（默认0）",
"type": "number"
},
{
"name": "height",
"in": "query",
"required": false,
"description": "压缩图片高（默认0）",
"type": "number"
},
{
"name": "whcut",
"in": "query",
"required": false,
"description": "压缩方式\n 1：裁切（默认，宽、高非0有效）\n 0：缩放\n -1或'auto'：保持等比裁切",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/get/imgview": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "17. 浏览图片空间",
"description": "需要token身份",
"parameters": [
{
"name": "path",
"in": "query",
"required": true,
"description": "路径",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/fileupload": {
"post": {
"tags": [
"系统"
],
"consumes": [
"multipart/form-data"
],
"summary": "18. 上传文件",
"description": "需要token身份",
"parameters": [
{
"name": "image64",
"in": "query",
"required": false,
"description": "图片base64",
"type": "string"
},
{
"name": "filename",
"in": "query",
"required": true,
"description": "文件名",
"type": "string"
},
{
"name": "files",
"in": "query",
"required": false,
"description": "文件名",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/get/showitem": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "19. 首页显示ITEM",
"description": "用于判断首页是否显示：pro、github、更新日志...",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/get/starthome": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "20. 启动首页设置信息",
"description": "用于判断注册是否需要启动首页",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/email/check": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "21. 邮件发送测试（限管理员）",
"description": "测试配置邮箱是否能发送邮件",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/checkin/export": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "22. 导出签到数据（限管理员）",
"description": "",
"parameters": [
{
"name": "userid",
"in": "query",
"required": false,
"description": "指定会员，如：[1, 2]",
"type": "array"
},
{
"name": "date",
"in": "query",
"required": false,
"description": "指定日期范围，如：['2020-12-12', '2020-12-30']",
"type": "array"
},
{
"name": "time",
"in": "query",
"required": false,
"description": "指定时间范围，如：['09:00', '18:00']",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/system/checkin/down": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "23. 下载导出的签到数据",
"description": "",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"description": "通过export接口得到的下载钥匙",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "file",
"description": "返回数据（直接下载文件）"
}
},
"required": [
"data"
]
}
}
}
}
},
"api/system/version": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "24. 获取版本号",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "version"
},
"publish": {
"type": "string",
"description": "publish"
}
},
"required": [
"version",
"publish"
]
}
}
}
}
},
"api/users/login": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "01. 登录、注册",
"description": "需要token身份",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "类型\n login:登录（默认）\n reg:注册",
"type": "string"
},
{
"name": "email",
"in": "query",
"required": true,
"description": "邮箱",
"type": "string"
},
{
"name": "password",
"in": "query",
"required": true,
"description": "密码",
"type": "string"
},
{
"name": "code",
"in": "query",
"required": false,
"description": "登录验证码",
"type": "string"
},
{
"name": "invite",
"in": "query",
"required": false,
"description": "注册邀请码",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据（同\"获取我的信息\"接口）"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/login/qrcode": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "02. 二维码登录",
"description": "通过二维码code登录 (或：是否登录成功)",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "类型\n login: 登录（用于：app登录）\n status: 状态 (默认，用于：网页、客户端获取)",
"type": "string"
},
{
"name": "code",
"in": "query",
"required": true,
"description": "二维码 code",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1需要、0不需要）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/login/needcode": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "03. 是否需要验证码",
"description": "用于判断是否需要登录验证码",
"parameters": [
{
"name": "email",
"in": "query",
"required": true,
"description": "用户名",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1需要、0不需要）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/login/codeimg": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "04. 验证码图片",
"description": "用于判断是否需要登录验证码",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "image",
"description": "返回数据（直接输出图片）"
}
},
"required": [
"data"
]
}
}
}
}
},
"api/users/login/codejson": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "05. 验证码json",
"description": "用于判断是否需要登录验证码",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/reg/needinvite": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "06. 是否需要邀请码",
"description": "用于判断注册是否需要邀请码",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/info": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "07. 获取我的信息",
"description": "需要token身份",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据",
"properties": {
"userid": {
"type": "number"
},
"identity": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"department": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"az": {
"type": "string"
},
"email": {
"type": "string"
},
"nickname": {
"type": "string"
},
"userimg": {
"type": "string"
},
"login_num": {
"type": "number"
},
"changepass": {
"type": "number"
},
"last_ip": {
"type": "string"
},
"last_at": {
"type": "string"
},
"line_ip": {
"type": "string"
},
"line_at": {
"type": "string"
},
"created_ip": {
"type": "string"
}
}
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/editdata": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "08. 修改自己的资料",
"description": "需要token身份",
"parameters": [
{
"name": "userimg",
"in": "query",
"required": false,
"description": "会员头像（地址）",
"type": "object"
},
{
"name": "tel",
"in": "query",
"required": false,
"description": "电话",
"type": "string"
},
{
"name": "nickname",
"in": "query",
"required": false,
"description": "昵称",
"type": "string"
},
{
"name": "profession",
"in": "query",
"required": false,
"description": "职位/职称",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据（同\"获取我的信息\"接口）"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/editpass": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "09. 修改自己的密码",
"description": "需要token身份",
"parameters": [
{
"name": "oldpass",
"in": "query",
"required": true,
"description": "旧密码",
"type": "string"
},
{
"name": "newpass",
"in": "query",
"required": true,
"description": "新密码",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据（同\"获取我的信息\"接口）"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/search": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "10. 搜索会员列表",
"description": "搜索会员列表",
"parameters": [
{
"name": "keys",
"in": "query",
"required": true,
"description": "搜索条件\n keys.key 昵称、拼音、邮箱关键字\n keys.disable 0-排除禁止（默认），1-仅禁止，2-含禁止\n keys.bot 0-排除机器人（默认），1-仅机器人，2-含机器人\n keys.project_id 在指定项目ID\n keys.no_project_id 不在指定项目ID\n keys.dialog_id 在指定对话ID",
"type": "object"
},
{
"name": "sorts",
"in": "query",
"required": true,
"description": "排序方式\n sorts.az 按字母：asc|desc",
"type": "object"
},
{
"name": "updated_time",
"in": "query",
"required": true,
"description": "在这个时间戳之后更新的",
"type": "number"
},
{
"name": "state",
"in": "query",
"required": true,
"description": "获取在线状态\n 0: 不获取（默认）\n 1: 获取会员在线状态，返回数据多一个online值",
"type": "number"
},
{
"name": "take",
"in": "query",
"required": false,
"description": "获取数量，10-100",
"type": "number"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1（赋值分页模式，take参数无效）",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:10，最大:100",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/basic": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "11. 获取指定会员基础信息",
"description": "需要token身份",
"parameters": [
{
"name": "userid",
"in": "query",
"required": true,
"description": "会员ID(多个格式：jsonArray，一次最多50个)",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/lists": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "12. 会员列表（限管理员）",
"description": "需要token身份",
"parameters": [
{
"name": "keys",
"in": "query",
"required": false,
"description": "搜索条件\n keys.key 邮箱/电话/昵称/职位（赋值后keys.email、keys.tel、keys.nickname、keys.profession失效）\n keys.email 邮箱\n keys.tel 电话\n keys.nickname 昵称\n keys.profession 职位\n keys.identity 身份（如：admin、noadmin）\n keys.disable 是否离职\n yes: 仅离职\n all: 全部\n 其他值: 仅在职（默认）\n keys.email_verity 邮箱是否认证\n yes: 已认证\n no: 未认证\n 其他值: 全部（默认）\n keys.bot 是否包含机器人\n yes: 仅机器人\n all: 全部\n 其他值: 非机器人（默认）\n keys.department 部门ID（0表示默认部门，不赋值获取所有部门）\n keys.checkin_mac 签到mac地址（get_checkin_mac=1时有效）",
"type": "object"
},
{
"name": "get_checkin_mac",
"in": "query",
"required": false,
"description": "获取签到mac地址\n 0: 不获取（默认）\n 1: 获取",
"type": "number"
},
{
"name": "page",
"in": "query",
"required": false,
"description": "当前页，默认:1",
"type": "number"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"description": "每页显示数量，默认:20，最大:50",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/operation": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "13. 操作会员（限管理员）",
"description": "需要token身份",
"parameters": [
{
"name": "userid",
"in": "query",
"required": true,
"description": "会员ID",
"type": "number"
},
{
"name": "type",
"in": "query",
"required": false,
"description": "操作\n setadmin 设为管理员\n clearadmin 取消管理员\n settemp 设为临时帐号\n cleartemp 取消临时身份（取消临时帐号）\n checkin_macs 修改自动签到mac地址（需要参数 checkin_macs）\n department 修改部门（需要参数 department）\n setdisable 设为离职（需要参数 disable_time、transfer_userid）\n cleardisable 取消离职\n delete 删除会员（需要参数 delete_reason）",
"type": "string"
},
{
"name": "email",
"in": "query",
"required": false,
"description": "邮箱地址",
"type": "string"
},
{
"name": "tel",
"in": "query",
"required": false,
"description": "联系电话",
"type": "string"
},
{
"name": "password",
"in": "query",
"required": false,
"description": "新的密码",
"type": "string"
},
{
"name": "nickname",
"in": "query",
"required": false,
"description": "昵称",
"type": "string"
},
{
"name": "profession",
"in": "query",
"required": false,
"description": "职位",
"type": "string"
},
{
"name": "checkin_macs",
"in": "query",
"required": false,
"description": "自动签到mac地址",
"type": "string"
},
{
"name": "department",
"in": "query",
"required": false,
"description": "部门",
"type": "string"
},
{
"name": "disable_time",
"in": "query",
"required": false,
"description": "离职时间",
"type": "string"
},
{
"name": "transfer_userid",
"in": "query",
"required": false,
"description": "离职交接人",
"type": "string"
},
{
"name": "delete_reason",
"in": "query",
"required": false,
"description": "删除原因",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/email/verification": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "14. 邮箱验证",
"description": "不需要token身份",
"parameters": [
{
"name": "code",
"in": "query",
"required": true,
"description": "验证参数",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/umeng/alias": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "15. 设置友盟别名",
"description": "需要token身份",
"parameters": [
{
"name": "alias",
"in": "query",
"required": true,
"description": "别名",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/meeting/open": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "16. 【会议】创建会议、加入会议",
"description": "需要token身份",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "类型\n create: 创建会议，有效参数：name、userids\n join: 加入会议，有效参数：meetingid (必填)",
"type": "string"
},
{
"name": "meetingid",
"in": "query",
"required": false,
"description": "频道ID（不是数字）",
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"description": "会话ID",
"type": "string"
},
{
"name": "userids",
"in": "query",
"required": false,
"description": "邀请成员",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/meeting/invitation": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "17. 【会议】发送邀请",
"description": "需要token身份",
"parameters": [
{
"name": "meetingid",
"in": "query",
"required": true,
"description": "频道ID（不是数字）",
"type": "string"
},
{
"name": "userids",
"in": "query",
"required": true,
"description": "邀请成员",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/email/send": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "18. 发送邮箱验证码",
"description": "需要token身份",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"description": "邮件类型",
"type": "number"
},
{
"name": "email",
"in": "query",
"required": true,
"description": "邮箱地址",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/email/edit": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "19. 修改邮箱",
"description": "需要token身份",
"parameters": [
{
"name": "newEmail",
"in": "query",
"required": true,
"description": "新邮箱地址",
"type": "string"
},
{
"name": "code",
"in": "query",
"required": true,
"description": "邮箱验证码",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/delete/account": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "20. 删除帐号",
"description": "需要token身份",
"parameters": [
{
"name": "email",
"in": "query",
"required": true,
"description": "帐号邮箱",
"type": "string"
},
{
"name": "code",
"in": "query",
"required": true,
"description": "邮箱验证码",
"type": "string"
},
{
"name": "reason",
"in": "query",
"required": true,
"description": "注销理由",
"type": "string"
},
{
"name": "password",
"in": "query",
"required": true,
"description": "登录密码",
"type": "string"
},
{
"name": "type",
"in": "query",
"required": true,
"description": "类型\n warning: 提交校验\n confirm: 确认删除",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/department/list": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "21. 部门列表（限管理员）",
"description": "需要token身份",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/department/add": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "22. 新建、修改部门（限管理员）",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": false,
"description": "部门id，留空为创建部门",
"type": "number"
},
{
"name": "name",
"in": "query",
"required": true,
"description": "部门名称",
"type": "string"
},
{
"name": "parent_id",
"in": "query",
"required": false,
"description": "上级部门ID",
"type": "number"
},
{
"name": "owner_userid",
"in": "query",
"required": true,
"description": "部门负责人ID",
"type": "number"
},
{
"name": "dialog_group",
"in": "query",
"required": false,
"description": "部门群（仅创建部门时有效）\n new: 创建（默认）\n use: 使用现有群",
"type": "string"
},
{
"name": "dialog_useid",
"in": "query",
"required": false,
"description": "使用现有群ID（dialog_group=use时有效）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/department/del": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "23. 删除部门（限管理员）",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "部门id",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/checkin/get": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "24. 获取签到设置",
"description": "需要token身份",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/checkin/save": {
"post": {
"tags": [
"会员"
],
"consumes": [
"multipart/form-data"
],
"summary": "25. 保存签到设置",
"description": "需要token身份",
"parameters": [
{
"name": "list",
"in": "query",
"required": true,
"description": "优先级数据，格式：[{mac,remark}]",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/checkin/list": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "26. 获取签到数据",
"description": "需要token身份",
"parameters": [
{
"name": "ym",
"in": "query",
"required": true,
"description": "年-月（如：2020-01）",
"type": "string"
},
{
"name": "before",
"in": "query",
"required": false,
"description": "取月份之前的数据（单位：月数，最大3）",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/socket/status": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "27. 获取socket状态",
"description": "需要token身份",
"parameters": [
{
"name": "[fd]",
"in": "query",
"required": true,
"description": "[fd]",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/key/client": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "28. 客户端KEY",
"description": "获取客户端KEY，用于加密数据发送给服务端",
"parameters": [
{
"name": "client_id",
"in": "query",
"required": false,
"description": "客户端ID（希望不变的，除非清除浏览器缓存或者卸载应用）",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/bot/info": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "29. 机器人信息",
"description": "需要token身份，获取我的机器人信息",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "机器人ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/users/bot/edit": {
"post": {
"tags": [
"会员"
],
"consumes": [
"multipart/form-data"
],
"summary": "30. 编辑机器人",
"description": "需要token身份，编辑我的机器人信息",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "机器人ID",
"type": "number"
},
{
"name": "name",
"in": "query",
"required": false,
"description": "机器人名称",
"type": "string"
},
{
"name": "avatar",
"in": "query",
"required": false,
"description": "机器人头像",
"type": "string"
},
{
"name": "clear_day",
"in": "query",
"required": false,
"description": "清理天数",
"type": "number"
},
{
"name": "webhook_url",
"in": "query",
"required": false,
"description": "Webhook地址",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/verifyToken": {
"get": {
"tags": [
"会员"
],
"consumes": [],
"summary": "01. 验证APi登录",
"description": "",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "version"
},
"publish": {
"type": "string",
"description": "publish"
}
},
"required": [
"version",
"publish"
]
}
}
}
}
},
"api/workflow/user/department": {
"get": {
"tags": [
"工作流"
],
"consumes": [],
"summary": "02. 获取当前用户部门",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "流程ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/procdef/all": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "03. 查询流程定义",
"description": "需要token身份",
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"description": "流程名称",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/procdef/del": {
"get": {
"tags": [
"工作流"
],
"consumes": [],
"summary": "04. 删除流程定义",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "流程ID",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/process/start": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "05. 启动流程（审批中）",
"description": "需要token身份",
"parameters": [
{
"name": "proc_name",
"in": "query",
"required": true,
"description": "流程名称",
"type": "string"
},
{
"name": "department_id",
"in": "query",
"required": true,
"description": "部门ID",
"type": "number"
},
{
"name": "var",
"in": "query",
"required": false,
"description": "启动流程类型信息（格式：[{type,startTime,endTime,description}]）",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/task/complete": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "06. 审批",
"description": "需要token身份",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "流程ID",
"type": "number"
},
{
"name": "pass",
"in": "query",
"required": true,
"description": "标题 [true-通过，false-拒绝]",
"type": "string"
},
{
"name": "comment",
"in": "query",
"required": true,
"description": "评论",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/task/withdraw": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "07. 撤回",
"description": "需要token身份",
"parameters": [
{
"name": "task_id",
"in": "query",
"required": true,
"description": "流程ID",
"type": "number"
},
{
"name": "proc_inst_id",
"in": "query",
"required": true,
"description": "流程实例ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/process/findTask": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "08. 查询需要我审批的流程（审批中）",
"description": "需要token身份",
"parameters": [
{
"name": "proc_def_name",
"in": "query",
"required": true,
"description": "流程名称",
"type": "string"
},
{
"name": "sort",
"in": "query",
"required": true,
"description": "排序[asc升序，desc降序]",
"type": "string"
},
{
"name": "page",
"in": "query",
"required": true,
"description": "页码",
"type": "number"
},
{
"name": "page_size",
"in": "query",
"required": true,
"description": "每页条数",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/process/startByMyselfAll": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "09. 查询我启动的流程（全部）",
"description": "需要token身份",
"parameters": [
{
"name": "proc_def_name",
"in": "query",
"required": true,
"description": "流程分类",
"type": "string"
},
{
"name": "state",
"in": "query",
"required": true,
"description": "流程状态[0全部，1审批中，2通过，3拒绝，4撤回]",
"type": "string"
},
{
"name": "page",
"in": "query",
"required": true,
"description": "页码",
"type": "number"
},
{
"name": "page_size",
"in": "query",
"required": true,
"description": "每页条数",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/process/startByMyself": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "10. 查询我启动的流程（审批中）",
"description": "需要token身份",
"parameters": [
{
"name": "page",
"in": "query",
"required": true,
"description": "页码",
"type": "number"
},
{
"name": "page_size",
"in": "query",
"required": true,
"description": "每页条数",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/process/findProcNotify": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "11. 查询抄送我的流程（审批中）",
"description": "需要token身份",
"parameters": [
{
"name": "userid",
"in": "query",
"required": true,
"description": "用户ID",
"type": "number"
},
{
"name": "proc_def_name",
"in": "query",
"required": true,
"description": "流程分类",
"type": "string"
},
{
"name": "sort",
"in": "query",
"required": true,
"description": "排序[asc升序，desc降序]",
"type": "string"
},
{
"name": "page",
"in": "query",
"required": true,
"description": "页码",
"type": "number"
},
{
"name": "page_size",
"in": "query",
"required": true,
"description": "每页条数",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/identitylink/findParticipant": {
"get": {
"tags": [
"工作流"
],
"consumes": [],
"summary": "12. 查询流程实例的参与者（审批中）",
"description": "需要token身份",
"parameters": [
{
"name": "proc_inst_id",
"in": "query",
"required": true,
"description": "流程实例ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/procHistory/findTask": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "13. 查询需要我审批的流程（已结束）",
"description": "需要token身份",
"parameters": [
{
"name": "proc_def_name",
"in": "query",
"required": true,
"description": "流程分类",
"type": "string"
},
{
"name": "sort",
"in": "query",
"required": true,
"description": "排序[asc升序，desc降序]",
"type": "string"
},
{
"name": "page",
"in": "query",
"required": true,
"description": "页码",
"type": "number"
},
{
"name": "page_size",
"in": "query",
"required": true,
"description": "每页条数",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/procHistory/startByMyself": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "14. 查询我启动的流程（已结束）",
"description": "需要token身份",
"parameters": [
{
"name": "page",
"in": "query",
"required": true,
"description": "页码",
"type": "number"
},
{
"name": "page_size",
"in": "query",
"required": true,
"description": "每页条数",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/procHistory/findProcNotify": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "15. 查询抄送我的流程（已结束）",
"description": "需要token身份",
"parameters": [
{
"name": "proc_def_name",
"in": "query",
"required": true,
"description": "流程分类",
"type": "string"
},
{
"name": "sort",
"in": "query",
"required": true,
"description": "排序[asc升序，desc降序]",
"type": "string"
},
{
"name": "page",
"in": "query",
"required": true,
"description": "页码",
"type": "number"
},
{
"name": "page_size",
"in": "query",
"required": true,
"description": "每页条数",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/identitylinkHistory/findParticipant": {
"get": {
"tags": [
"工作流"
],
"consumes": [],
"summary": "16. 查询流程实例的参与者（已结束）",
"description": "需要token身份",
"parameters": [
{
"name": "proc_inst_id",
"in": "query",
"required": true,
"description": "流程实例ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/process/detail": {
"get": {
"tags": [
"工作流"
],
"consumes": [],
"summary": "17. 根据流程ID查询流程详情",
"description": "需要token身份",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"description": "流程ID",
"type": "number"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/export": {
"post": {
"tags": [
"工作流"
],
"consumes": [
"multipart/form-data"
],
"summary": "18. 导出数据",
"description": "需要token身份",
"parameters": [
{
"name": "proc_def_name",
"in": "query",
"required": true,
"description": "流程分类",
"type": "string"
},
{
"name": "state",
"in": "query",
"required": true,
"description": "流程状态[0全部，1审批中，2通过，3拒绝，4撤回]",
"type": "string"
},
{
"name": "is_finished",
"in": "query",
"required": true,
"description": "是否完成",
"type": "string"
},
{
"name": "date",
"in": "query",
"required": false,
"description": "指定日期范围，如：['2020-12-12', '2020-12-30']",
"type": "array"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ret": {
"type": "number",
"description": "返回状态码（1正确、0错误）"
},
"msg": {
"type": "string",
"description": "返回信息（错误描述）"
},
"data": {
"type": "object",
"description": "返回数据"
}
},
"required": [
"ret",
"msg",
"data"
]
}
}
}
}
},
"api/workflow/down": {
"get": {
"tags": [
"系统"
],
"consumes": [],
"summary": "19. 下载导出的审批数据",
"description": "",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"description": "通过export接口得到的下载钥匙",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "file",
"description": "返回数据（直接下载文件）"
}
},
"required": [
"data"
]
}
}
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink