作者:管理员 历史版本:1 最后编辑:龚清 更新时间:2024-09-20 15:13
获取参与者数据
简述:
- 获取参与者数据
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/get
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
innerMessageId | String | 是 | 内部信息id |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/msg/innerMessage/get?innerMessageId=651787568509091840
返回示例:
{
"state": 200,
"request": null,
"message": "获取内部消息成功!",
"cause": "",
"variables": {},
"data": {
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575439866000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "651787568509091840",
"subject": "任务完成通知",
"ownerId": "651730407368163328",
"ownerName": "系统",
"messageType": "system",
"canreply": 0,
"isPublic": 0,
"content": "<p>抄送审批2完成:流程实例: <a href=\"http://localhost/#/platform/bpmn/form?instanceId=651787524640866304\" target=\"_blank\">超2在2019-12-04 14:10:55发起抄送验证</a>完成.</p>",
"fileMsg": null,
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": null,
"receiverTime": null
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | InnerMessagePo | 内部消息对象信息 |
标记消息为已读
简述:
- 标记消息为已读
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/markRead
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
innerMessageId | String | 是 | 内部信息id |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/msg/innerMessage/markRead?innerMessageIds=651787568509091840
返回示例:
{
"state": 200,
"request": null,
"message": "标记内部消息为已读成功",
"cause": "",
"variables": {},
"data": null
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | InnerMessagePo | 内部消息对象信息 |
获取未读消息列表
简述:
- 获取未读消息列表
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/msg/list/unread
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
innerMessageId | String | 是 | 内部信息id |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/msg/innerMessage/msg/list/unread?messageType=651787568509091840
返回示例:
{
"state": 200,
"request": null,
"message": "获取未读消息列表成功!",
"cause": "",
"variables": {},
"data": {
"dataResult": [],
"pageResult": {
"limit": 10,
"page": 1,
"totalCount": 0,
"totalPages": 0
}
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | InnerMessagePo | 内部消息对象信息 |
获取未读消息列表
简述:
- 获取未读消息列表
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/msgList
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/msg/innerMessage/msgList
返回示例:
{
"state": 200,
"request": null,
"message": "获取未读消息列表成功!",
"cause": "",
"variables": {},
"data": {
"dataResult": [
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575428198000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "651738631442006016",
"subject": "流程结束通知",
"ownerId": "651730407368163328",
"ownerName": "系统",
"messageType": "system",
"canreply": 0,
"isPublic": 0,
"content": null,
"fileMsg": null,
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": "2天前",
"receiverTime": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575274136000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "651092445026582528",
"subject": "任务完成通知",
"ownerId": "643520726346760192",
"ownerName": "系统",
"messageType": "system",
"canreply": 0,
"isPublic": 0,
"content": null,
"fileMsg": null,
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": "4天前",
"receiverTime": null
}
],
"pageResult": {
"limit": 10,
"page": 1,
"totalCount": 2,
"totalPages": 1
}
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | APIPageList< InnerMessagePo > | 内部消息对象信息列表 |
查询收到的内部消息
简述:
- 查询收到的内部消息
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/receive
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例:
{
"parameters": [],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}
返回示例:
{
"state": 200,
"request": null,
"message": "获取收到的内部消息列表成功!",
"cause": "",
"variables": {},
"data": {
"dataResult": [
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575439866000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "651787568509091840",
"subject": "任务完成通知",
"ownerId": "651730407368163328",
"ownerName": "系统",
"messageType": "system",
"canreply": 0,
"isPublic": 0,
"content": null,
"fileMsg": null,
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": null,
"receiverTime": 1575623558000
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575428198000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "651738631442006016",
"subject": "流程结束通知",
"ownerId": "651730407368163328",
"ownerName": "系统",
"messageType": "system",
"canreply": 0,
"isPublic": 0,
"content": null,
"fileMsg": null,
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": null,
"receiverTime": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575274619000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "651094474272800768",
"subject": "任务完成通知",
"ownerId": "643520726346760192",
"ownerName": "系统",
"messageType": "system",
"canreply": 0,
"isPublic": 0,
"content": null,
"fileMsg": null,
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": null,
"receiverTime": 1575337289000
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575274136000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "651092445026582528",
"subject": "任务完成通知",
"ownerId": "643520726346760192",
"ownerName": "系统",
"messageType": "system",
"canreply": 0,
"isPublic": 0,
"content": null,
"fileMsg": null,
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": null,
"receiverTime": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575247771000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "650981863451525120",
"subject": "流程结束通知",
"ownerId": "626357874037096448",
"ownerName": "系统",
"messageType": "system",
"canreply": 0,
"isPublic": 0,
"content": null,
"fileMsg": null,
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": null,
"receiverTime": 1575267467000
}
],
"pageResult": {
"limit": 20,
"page": 1,
"totalCount": 5,
"totalPages": 1
}
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | APIPageList< InnerMessagePo > | 内部消息对象信息列表 |
删除内部消息
简述:
- 删除内部消息
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/remove
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
innerMessageIds | String | 是 | 内部信息id |
- Body:
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/platform/v3/msg/innerMessage/remove?innerMessageIds=651787568509091840
返回示例:
{
"state": 200,
"request": null,
"message": "删除内部消息成功",
"cause": "",
"variables": {},
"data": null
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
保存
简述:
- 保存
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/save
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
canreply | Short | 否 | 是否可以回复 | ||
content | string | 是 | 消息内容 | ||
createBy | string | 否 | 创建人ID | ||
createTime | Date | 否 | 创建时间 | ||
dataStatus | string | 否 | 数据状态 | ||
dbtype | string | 否 | 数据库类型 | ||
durationTime | string | 否 | 持续时间 | ||
fileMsg | string | 否 | 附件 | ||
groupId | string | 否 | 组ID | ||
groupName | string | 否 | 组名 | ||
id | string | 否 | 主键 | ||
ip | string | 否 | IP地址 | ||
isPublic | Short | 否 | 是否公告 | ||
messageType | string | 否 | 消息类型 | ||
name | string | 否 | 名称 | ||
ownerId | string | 否 | 发帖人ID | ||
ownerName | string | 否 | 发帖人 | ||
pk | string | 否 | 主键 | ||
receiver | string | 否 | 接收人 | ||
receiverId | string | 是 | 接收人ID | ||
receiverTime | Date | 否 | 接收时间 | ||
subject | string | 是 | 主题 | ||
tenantId | string | 否 | 租户ID | ||
updateBy | string | 否 | 更新人ID | ||
updateTime | Date | 否 | 更新时间 |
请求参数示例:
{
"subject": "文档测试",
"receiverId": "645921644728025088",
"receiver": "",
"groupId": "",
"groupName": "",
"canreply": "1",
"fileMsg": "",
"content": "<p>调试</p>",
"id": "",
"editorValue": ""
}
返回示例:
{
"state": 200,
"request": null,
"message": "发送成功",
"cause": "",
"variables": { },
"data": null
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
保存回复信息
简述:
- 保存回复信息
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/saveReply
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | 否 | 主键 | |||
msgId | String | 是 | 消息ID | ||
content | String | 是 | 内容 | ||
replyId | String | 否 | 回复人ID | ||
reply | String | 否 | 回复人 | ||
replyTime | String | 否 | 回复时间 | ||
isPrivate | String | 否 | 私信 | ||
fileMsg | string | 否 | 附件 |
请求参数示例:
{
"msgId": "652571920532766720",
"content": "<p>123</p>",
"fileMsg": [
""
],
"editorValue": "<p>123</p>"
}
返回示例:
{
"state": 200,
"request": null,
"message": "回复成功",
"cause": "",
"variables": { },
"data": null
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | InnerMessagePo | 内部消息对象信息 |
查询发送的内部消息
简述:
- 传入查询请求json字符串
请求URL:
- http://ip:port/ibps/platform/v3/msg/innerMessage/sent
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例:
{
"parameters": [],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}
返回示例:
{
"state": 200,
"request": null,
"message": "获取发送的内部消息列表成功!",
"cause": "",
"variables": {},
"data": {
"dataResult": [
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": 1575943882000,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653901565999972352",
"subject": "测试",
"ownerId": "653561339549057024",
"ownerName": "Jerry",
"messageType": "normal",
"canreply": 1,
"isPublic": 0,
"content": "",
"fileMsg": "",
"receiver": null,
"receiverId": null,
"groupId": null,
"groupName": null,
"durationTime": null,
"receiverTime": null
}
],
"pageResult": {
"limit": 20,
"page": 1,
"totalCount": 1,
"totalPages": 1
}
}
}
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | APIPageList< InnerMessagePo > | 内部消息对象信息列表 |