title: myApps.5.0trunk v1.0.0
language_tabs:
- shell: Shell
- http: HTTP
- javascript: JavaScript
- ruby: Ruby
- python: Python
- php: PHP
- java: Java
- go: Go
toc_footers: []
includes: []
search: true
code_clipboard: true
highlight_theme: darkula
headingLevel: 2
generator: “@tarslib/widdershins v4.0.17”
myApps.5.0trunk
v1.0.0
Base URLs:
myApps消息中心/评论
POST 发表评论
POST /api/message/comment
Body 请求参数
{
"attachment": "",
"content": "我评论了",
"lazyLoad": true,
"messageId": "8Q9Jl0JXICP6s95ZRuD",
"read": false,
"toContent": "我发布公告了",
"toUser": "CCC",
"toUserId": "pyVVlAIzdRkiw6QZWTT",
"version": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| body | body | object | 否 | none |
| » attachment | body | string | 是 | none |
| » content | body | string | 是 | none |
| » lazyLoad | body | boolean | 是 | none |
| » messageId | body | string | 是 | none |
| » read | body | boolean | 是 | none |
| » toContent | body | string | 是 | none |
| » toUser | body | string | 是 | none |
| » toUserId | body | string | 是 | none |
| » version | body | integer | 是 | none |
返回示例
成功
{
"attachment": "",
"content": "我评论了",
"id": "125e4c44-20e4-431d-a2c8-9f68dba19783",
"lazyLoad": true,
"messageId": "8Q9Jl0JXICP6s95ZRuD",
"read": false,
"toContent": "我发布公告了",
"toUser": "CCC",
"toUserId": "pyVVlAIzdRkiw6QZWTT",
"version": 0
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » attachment | string | false | none | none | |
| » content | string | false | none | none | |
| » id | string | false | none | none | |
| » lazyLoad | boolean | false | none | none | |
| » messageId | string | false | none | none | |
| » read | boolean | false | none | none | |
| » toContent | string | false | none | none | |
| » toUser | string | false | none | none | |
| » toUserId | string | false | none | none | |
| » version | integer | false | none | none |
DELETE 删除评论
DELETE /api/message/comment
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| commentId | query | string | 是 | 评论id |
| messageId | query | string | 是 | none |
返回示例
成功
{
"message": "删除成功",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » message | string | true | none | none | |
| » status | integer | true | none | none |
GET 消息下的评论列表
GET /api/message/comment
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"data": {
"rowCount": 1,
"linesPerPage": 30,
"pageNo": 1,
"datas": [
{
"id": "qeNwg5s4irW35PIn6Du",
"content": "回复 @CCC jljljljlj",
"attachment": "",
"createTime": "2019-10-17 09:51:50",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"messageId": "8Q9Jl0JXICP6s95ZRuD",
"commentId": "BHQKA5KxtSEes4Tq75p",
"toUser": "CCC",
"toUserId": "pyVVlAIzdRkiw6QZWTT",
"toContent": "sssq",
"module": null,
"read": true
}
],
"pageCount": 1
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | 企业域集合 | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | false | none | none | |
| »»» id | string | false | none | none | |
| »»» content | string | false | none | none | |
| »»» attachment | null | false | none | none | |
| »»» createTime | string | false | none | none | |
| »»» sender | string | false | none | none | |
| »»» senderId | string | false | none | none | |
| »»» messageId | string | false | none | none | |
| »»» commentId | null | false | none | none | |
| »»» toUser | string | false | none | none | |
| »»» toUserId | string | false | none | none | |
| »»» toContent | string | false | none | none | |
| »»» module | null | false | none | none | |
| »»» read | boolean | false | none | none | |
| »» pageCount | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
GET 我回复的评论
GET /api/message/comment/my/reply
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| telephone | query | string | 是 | 测试手机号码 |
| domainid | query | string | 是 | 企业域id |
返回示例
成功
{
"data": {
"rowCount": 1,
"linesPerPage": 30,
"pageNo": 1,
"datas": [
{
"id": "qeNwg5s4irW35PIn6Du",
"content": "回复 @CCC jljljljlj",
"attachment": "",
"createTime": "2019-10-17 09:51:50",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"messageId": "8Q9Jl0JXICP6s95ZRuD",
"commentId": "BHQKA5KxtSEes4Tq75p",
"toUser": "CCC",
"toUserId": "pyVVlAIzdRkiw6QZWTT",
"toContent": "sssq",
"module": null,
"read": true
}
],
"pageCount": 1
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | false | none | 企业域集合 | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» content | string | false | none | none | |
| »»» attachment | string | false | none | none | |
| »»» createTime | string | false | none | none | |
| »»» sender | string | false | none | none | |
| »»» senderId | string | false | none | none | |
| »»» messageId | string | false | none | none | |
| »»» commentId | string | false | none | none | |
| »»» toUser | string | false | none | none | |
| »»» toUserId | string | false | none | none | |
| »»» toContent | string | false | none | none | |
| »»» module | null | false | none | none | |
| »»» read | boolean | false | none | none | |
| »» pageCount | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
GET 回复我的评论
GET /api/message/comment/my/receive
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| _currpage | query | string | 否 | 页长度 |
| _rowcount | query | string | 否 | 当前页码 |
返回示例
成功
{
"data": {
"rowCount": 1,
"linesPerPage": 30,
"pageNo": 1,
"datas": [
{
"id": "qeNwg5s4irW35PIn6Du",
"content": "回复 @CCC jljljljlj",
"attachment": "",
"createTime": "2019-10-17 09:51:50",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"messageId": "8Q9Jl0JXICP6s95ZRuD",
"commentId": "BHQKA5KxtSEes4Tq75p",
"toUser": "CCC",
"toUserId": "pyVVlAIzdRkiw6QZWTT",
"toContent": "sssq",
"module": null,
"read": true
}
],
"pageCount": 1
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | 企业域集合 | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» content | string | false | none | none | |
| »»» attachment | string | false | none | none | |
| »»» createTime | string | false | none | none | |
| »»» sender | string | false | none | none | |
| »»» senderId | string | false | none | none | |
| »»» messageId | string | false | none | none | |
| »»» commentId | string | false | none | none | |
| »»» toUser | string | false | none | none | |
| »»» toUserId | string | false | none | none | |
| »»» toContent | string | false | none | none | |
| »»» module | null | false | none | none | |
| »»» read | boolean | false | none | none | |
| »» pageCount | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
myApps消息中心/消息
POST 发布消息
POST /api/message/messages
Body 请求参数
{
"comment": false,
"commentCount": 0,
"content": "我发布消息",
"lazyLoad": true,
"receiverInfo": "{\"user\":[],\"dept\":[{\"deptId\":\"8h1xHsPjXW0qb7OSQo8\",\"deptName\":\"市场部\"}]}",
"scope": 2,
"sticky": false,
"type": 0,
"version": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| body | body | object | 否 | none |
| » comment | body | boolean | 是 | none |
| » commentCount | body | integer | 是 | none |
| » content | body | string | 是 | none |
| » lazyLoad | body | boolean | 是 | none |
| » receiverInfo | body | string | 是 | none |
| » scope | body | integer | 是 | none |
| » sticky | body | boolean | 是 | none |
| » type | body | integer | 是 | none |
| » version | body | integer | 是 | none |
返回示例
成功
{
"data": {
"id": "zXNIojbhzLGqUWta4cn",
"title": null,
"content": "lk",
"attachment": "[]",
"createTime": "2019-10-17 14:34:09",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"senderDept": "newDepartment",
"senderDeptId": "2GRc9uflP5C0Vw9eCO5",
"scope": 2,
"receiverInfo": "{\"user\":[],\"dept\":[{\"deptId\":\"8h1xHsPjXW0qb7OSQo8\",\"deptName\":\"市场部\"}]}",
"receiverId": "ZUNHIPmke4EDKJjhzmp",
"receiverDeptId": "8h1xHsPjXW0qb7OSQo8",
"commentCount": 0,
"type": 0,
"sticky": false,
"comment": true,
"module": null
},
"message": "发布成功",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | false | none | 企业域集合 | |
| »» id | string | true | none | none | |
| »» title | null | true | none | none | |
| »» content | string | true | none | none | |
| »» attachment | string | true | none | none | |
| »» createTime | string | true | none | none | |
| »» sender | string | true | none | none | |
| »» senderId | string | true | none | none | |
| »» senderDept | string | true | none | none | |
| »» senderDeptId | string | true | none | none | |
| »» scope | integer | true | none | none | |
| »» receiverInfo | string | true | none | none | |
| »» receiverId | string | true | none | none | |
| »» receiverDeptId | string | true | none | none | |
| »» commentCount | integer | true | none | none | |
| »» type | integer | true | none | none | |
| »» sticky | boolean | true | none | none | |
| »» comment | boolean | true | none | none | |
| »» module | null | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
GET 获取消息以及评论内容
GET /api/message/messages
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| messageId | query | string | 否 | 消息id |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
DELETE 删除信息
DELETE /api/message/messages
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| messageId | query | string | 是 | 消息id |
返回示例
成功
{
"message": "删除成功",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » message | string | true | none | none | |
| » status | integer | true | none | none |
POST 发布公告
POST /api/message/messages/announcement
Body 请求参数
{
"comment": false,
"commentCount": 0,
"content": "我发布公告",
"lazyLoad": true,
"receiverInfo": "{\"user\":[],\"dept\":[{\"deptId\":\"8h1xHsPjXW0qb7OSQo8\",\"deptName\":\"市场部\"}]}",
"scope": 1,
"sticky": false,
"type": 0,
"version": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| body | body | object | 否 | none |
| » comment | body | boolean | 是 | none |
| » commentCount | body | integer | 是 | none |
| » content | body | string | 是 | none |
| » lazyLoad | body | boolean | 是 | none |
| » receiverInfo | body | string | 是 | none |
| » scope | body | integer | 是 | none |
| » sticky | body | boolean | 是 | none |
| » type | body | integer | 是 | none |
| » version | body | integer | 是 | none |
返回示例
成功
{
"data": {
"id": "SH0zO8Tau0gT4xpjcQY",
"title": "jkkkkkkkk",
"content": "<p>jjkjkjjjjjjj</p>",
"attachment": "",
"createTime": "2019-10-17 14:44:29",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"senderDept": "newDepartment",
"senderDeptId": "2GRc9uflP5C0Vw9eCO5",
"scope": 2,
"receiverInfo": null,
"receiverId": "ZUNHIPmke4EDKJjhzmp",
"receiverDeptId": "8h1xHsPjXW0qb7OSQo8",
"commentCount": 0,
"type": 1,
"sticky": false,
"comment": false,
"module": null
},
"message": "发布成功",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | false | none | 部门详情 | |
| »» id | string | true | none | none | |
| »» title | string | true | none | none | |
| »» content | string | true | none | none | |
| »» attachment | string | true | none | none | |
| »» createTime | string | true | none | none | |
| »» sender | string | true | none | none | |
| »» senderId | string | true | none | none | |
| »» senderDept | string | true | none | none | |
| »» senderDeptId | string | true | none | none | |
| »» scope | integer | true | none | none | |
| »» receiverInfo | null | true | none | none | |
| »» receiverId | string | true | none | none | |
| »» receiverDeptId | string | true | none | none | |
| »» commentCount | integer | true | none | none | |
| »» type | integer | true | none | none | |
| »» sticky | boolean | true | none | none | |
| »» comment | boolean | true | none | none | |
| »» module | null | true | none | none | |
| » message | null | true | none | none | |
| » status | integer | true | none | none |
GET 查询公告型消息列表(包含条件)
GET /api/message/messages/announcement
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| content | query | string | 是 | 内容 |
| linesPerPage | query | string | 是 | 每页条数 |
| pageNo | query | string | 是 | 页数 |
返回示例
成功
{
"data": {
"rowCount": 1,
"linesPerPage": 30,
"pageNo": 1,
"datas": [
{
"id": "X1D0GIwdtnjtfm0nyZ9",
"title": "klk",
"content": "<p>klk</p>",
"attachment": "",
"createTime": "2019-10-17 15:03:11",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"senderDept": "newDepartment",
"senderDeptId": "2GRc9uflP5C0Vw9eCO5",
"scope": 2,
"receiverInfo": null,
"receiverId": "ZUNHIPmke4EDKJjhzmp",
"receiverDeptId": "8h1xHsPjXW0qb7OSQo8",
"commentCount": 0,
"type": 1,
"sticky": false,
"comment": false,
"module": null
}
],
"pageCount": 1
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» title | string | false | none | none | |
| »»» content | string | false | none | none | |
| »»» attachment | string | false | none | none | |
| »»» createTime | string | false | none | none | |
| »»» sender | string | false | none | none | |
| »»» senderId | string | false | none | none | |
| »»» senderDept | string | false | none | none | |
| »»» senderDeptId | string | false | none | none | |
| »»» scope | integer | false | none | none | |
| »»» receiverInfo | null | false | none | none | |
| »»» receiverId | string | false | none | none | |
| »»» receiverDeptId | string | false | none | none | |
| »»» commentCount | integer | false | none | none | |
| »»» type | integer | false | none | none | |
| »»» sticky | boolean | false | none | none | |
| »»» comment | boolean | false | none | none | |
| »»» module | null | false | none | none | |
| »» pageCount | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
GET 查询消息列表查询(包含条件)
GET /api/message/messages/list
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| content | query | string | 是 | 内容 |
| linesPerPage | query | string | 是 | 每页条数 |
| pageNo | query | string | 是 | 页数 |
返回示例
成功
{
"data": {
"rowCount": 3,
"linesPerPage": 30,
"pageNo": 1,
"datas": [
{
"id": "4ZEArcbWtwWAIxLIjVO",
"title": null,
"content": "kjkjkj",
"attachment": "[]",
"createTime": "2019-10-17 14:35:29",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"senderDept": "newDepartment",
"senderDeptId": "2GRc9uflP5C0Vw9eCO5",
"scope": 2,
"receiverInfo": "{\"user\":[],\"dept\":[{\"deptId\":\"QRciJ526QiqnfcdLFQ3\",\"deptName\":\"CCCC\"}]}",
"receiverId": "",
"receiverDeptId": "",
"commentCount": 0,
"type": 0,
"sticky": false,
"comment": true,
"module": null
},
{
"id": "81jv12SQjCS2EcVdb7g",
"title": null,
"content": "kklklk",
"attachment": "[]",
"createTime": "2019-10-17 14:33:37",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"senderDept": "newDepartment",
"senderDeptId": "2GRc9uflP5C0Vw9eCO5",
"scope": 2,
"receiverInfo": "{\"user\":[],\"dept\":[{\"deptId\":\"8h1xHsPjXW0qb7OSQo8\",\"deptName\":\"市场部\"}]}",
"receiverId": "ZUNHIPmke4EDKJjhzmp",
"receiverDeptId": "8h1xHsPjXW0qb7OSQo8",
"commentCount": 0,
"type": 0,
"sticky": false,
"comment": true,
"module": null
},
{
"id": "8Q9Jl0JXICP6s95ZRuD",
"title": null,
"content": "AASS",
"attachment": "[]",
"createTime": "2019-10-17 09:10:51",
"sender": "CCC",
"senderId": "pyVVlAIzdRkiw6QZWTT",
"senderDept": "newDepartment",
"senderDeptId": "2GRc9uflP5C0Vw9eCO5",
"scope": 2,
"receiverInfo": "{\"user\":[],\"dept\":[{\"deptId\":\"8h1xHsPjXW0qb7OSQo8\",\"deptName\":\"市场部\"}]}",
"receiverId": "ZUNHIPmke4EDKJjhzmp",
"receiverDeptId": "8h1xHsPjXW0qb7OSQo8",
"commentCount": 1,
"type": 0,
"sticky": false,
"comment": true,
"module": null
}
],
"pageCount": 1
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | 企业域集合 | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | true | none | none | |
| »»» title | null | true | none | none | |
| »»» content | string | true | none | none | |
| »»» attachment | string | true | none | none | |
| »»» createTime | string | true | none | none | |
| »»» sender | string | true | none | none | |
| »»» senderId | string | true | none | none | |
| »»» senderDept | string | true | none | none | |
| »»» senderDeptId | string | true | none | none | |
| »»» scope | integer | true | none | none | |
| »»» receiverInfo | string | true | none | none | |
| »»» receiverId | string | true | none | none | |
| »»» receiverDeptId | string | true | none | none | |
| »»» commentCount | integer | true | none | none | |
| »»» type | integer | true | none | none | |
| »»» sticky | boolean | true | none | none | |
| »»» comment | boolean | true | none | none | |
| »»» module | null | true | none | none | |
| »» pageCount | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
GET 查看预览文件
GET /api/message/messages/attachement/preview
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| id | query | string | 是 | 文件id |
| extName | query | string | 是 | 后缀名 |
| url | query | string | 是 | 文件路径 |
返回示例
成功
{
"data": {
"origPath": "C:\\project\\obpm22\\src\\main\\webapp/uploads/message/2019/11e9-f0ac-7ba39506-87bc-135c9e77df9d.docx",
"is2SWF": "false",
"swfPath": "C:\\project\\obpm22\\src\\main\\webapp/uploads/message/2019//swf/11e9-f0ac-7ba39506-87bc-135c9e77df9d.swf"
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | none | |
| »» origPath | string | true | none | none | |
| »» is2SWF | string | true | none | none | |
| »» swfPath | string | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
myApps消息中心/事项提醒
GET 获取事项提醒
GET /api/message/notice
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| readStatus | query | string | 是 | 未读:0 读:1 |
| type | query | string | 是 | 后续补充 |
| linesPerPage | query | string | 是 | 每页条数 |
| pageNo | query | string | 是 | 页数 |
返回示例
成功
{
"data": {
"rowCount": 1,
"linesPerPage": 30,
"pageNo": 1,
"datas": [
{
"id": "NeP9OdoZigTlntn4dvC",
"summary": "<span class='notice_type' type='3'></span><span class='notice_actor'>CCC</span><span class='notice_flowType'>创建</span><span class='notice_flow'>审批单</span><span class='notice_summary'>请假单_自由流程-CCC创建请假单_自由流程</span>",
"content": "{\"content\":\"CCC创建请假单_自由流程\",\"event\":\"发起\",\"type\":3}",
"toUserId": "pyVVlAIzdRkiw6QZWTT",
"createTime": "2019-07-11 18:46:44",
"read": false,
"module": "自由流程",
"linkParams": "{\"_docid\":\"RtCYmbpQ0gLah7SuKP8\",\"_formid\":\"OGMmff1QTZYqFk5vfeD\",\"application\":\"HdPeBqYwJyFyjHkhZu3\",\"mode\":\"personalMessageMode\"}",
"subjectType": 3
}
],
"pageCount": 1
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» summary | string | false | none | none | |
| »»» content | string | false | none | none | |
| »»» toUserId | string | false | none | none | |
| »»» createTime | string | false | none | none | |
| »»» read | boolean | false | none | none | |
| »»» module | string | false | none | none | |
| »»» linkParams | string | false | none | none | |
| »»» subjectType | integer | false | none | none | |
| »» pageCount | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
DELETE 删除事项提醒通知
DELETE /api/message/notice
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| noticeId | query | string | 是 | 通知事项id |
返回示例
成功
{
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » message | string | true | none | none | |
| » status | integer | true | none | none |
PUT 设置事项提醒通知为已读
PUT /api/message/notice/read
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| noticeId | query | string | 是 | 通知id |
返回示例
成功
{
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » message | string | true | none | none | |
| » status | integer | true | none | none |
PUT 标记所有未读通知为已读
PUT /api/message/notice/allRead
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » message | string | true | none | none | |
| » status | integer | true | none | none |
myApps消息中心/消息中心
GET 用户登录时,获取消息通知
GET /api/message/notification/login
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
| id | query | string | 是 | 用户id |
返回示例
成功
{
"data": {
"2": 0,
"3": 0,
"size": 0
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | none | |
| »» 2 | integer | true | none | none | |
| »» 3 | integer | true | none | none | |
| »» size | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
GET 获取消息中心通知
GET /api/message/notification
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"data": {
"data": [],
"amount": {
"notice": 0,
"comment": 0,
"sum": 0
}
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | none | |
| »» data | [string] | true | none | none | |
| »» amount | object | true | none | none | |
| »»» notice | integer | true | none | none | |
| »»» comment | integer | true | none | none | |
| »»» sum | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |
DELETE 清空消息中心通知
DELETE /api/message/notification/clear
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » message | string | true | none | none | |
| » status | integer | true | none | none |
GET 获得消息总数
GET /api/message/notification/count
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"data": {
"notice": 0
},
"message": "",
"status": 1
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | object | true | none | none | |
| »» notice | integer | true | none | none | |
| » message | string | true | none | none | |
| » status | integer | true | none | none |