作者：管理员  历史版本：1  最后编辑：龚清  更新时间：2024-11-20 15:41

获取消息模板

简述：

  • 获取消息模板

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
messageTemplateId String 是 消息模板id
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/msg/messageTemplate/get?messageTemplateId=139728732518351001

返回示例：

{
    "state": 200,
    "request": null,
    "message": "获取消息模板成功！",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "任务创建[默认]",
        "ip": null,
        "createBy": "1",
        "createTime": 1488455481000,
        "updateBy": null,
        "updateTime": null,
        "tenantId": "-999",
        "dataStatus": null,
        "dbtype": null,
        "id": "139728732518351001",
        "key": "taskCreate-default",
        "typeKey": "taskCreate",
        "subTypeKey": null,
        "isDefault": "Y",
        "subject": "任务创建通知",
        "plain": "任务创建：流程实例：${instSubject}，执行到${nodeName}",
        "html": "任务创建：流程实例<a href=\"${baseUrl}/#/platform/bpmn/instance/bpmInst/detail.htm?id=${instId}\">${instSubject}</a>，执行到${nodeName}",
        "wechat": "任务创建：流程实例<a href=\"${baseUrl}/#/platform/bpmn/instance/bpmInst/detail.htm?id=${instId}\">${instSubject}</a>，执行到${nodeName}",
        "createOrgId": null,
        "creator": "管理员",
        "updator": null
    }
}

返回参数说明：

名称 类型 备注
data MessageTemplatePo 消息模版实体对象

获取分类下默认的消息模板

简述：

  • 获取分类下默认的消息模板

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
typeKey String 是 消息模板分类标识
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/msg/messageTemplate/getDefaultTemplate?typeKey=taskCreate

返回示例：

{
    "state": 200,
    "request": null,
    "message": "获取消息模板成功！",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "任务创建[默认]",
        "ip": null,
        "createBy": "1",
        "createTime": 1488455481000,
        "updateBy": null,
        "updateTime": null,
        "tenantId": "-999",
        "dataStatus": null,
        "dbtype": null,
        "id": "139728732518351001",
        "key": "taskCreate-default",
        "typeKey": "taskCreate",
        "subTypeKey": null,
        "isDefault": "Y",
        "subject": "任务创建通知",
        "plain": "任务创建：流程实例：${instSubject}，执行到${nodeName}",
        "html": "任务创建：流程实例<a href=\"${baseUrl}/#/platform/bpmn/instance/bpmInst/detail.htm?id=${instId}\">${instSubject}</a>，执行到${nodeName}",
        "wechat": "任务创建：流程实例<a href=\"${baseUrl}/#/platform/bpmn/instance/bpmInst/detail.htm?id=${instId}\">${instSubject}</a>，执行到${nodeName}",
        "createOrgId": null,
        "creator": null,
        "updator": null
    }
}

返回参数说明：

名称 类型 备注
data MessageTemplatePo 消息模版实体对象

校验key是否存在

简述：

  • 校验key是否存在

请求URL：

请求方式：

  • GET

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
id String 是 主键ID
key String 是 业务主键
typeKey String 是 模板分类key值
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/msg/messageTemplate/isKeyExists?id=139728732518351001&key=taskCreate-default&typeKey=taskCreate

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": false
}

返回参数说明：

名称 类型 备注
data Boolean

获取消息模板列表

简述：

  • 获取消息模板列表

请求URL：

请求方式：

  • 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": "的我的",
                "ip": null,
                "createBy": "1",
                "createTime": 1577159557000,
                "updateBy": "1",
                "updateTime": 1577159748000,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "659000474271219712",
                "key": "dwd12",
                "typeKey": "taskCreate",
                "subTypeKey": null,
                "isDefault": "N",
                "subject": "测试",
                "plain": "但是我",
                "html": "<p>请问</p>",
                "wechat": "的商务区的我",
                "createOrgId": null,
                "creator": "管理员",
                "updator": "管理员"
            },
            {
                "pk": "",
                "name": "风格化风格化法国",
                "ip": null,
                "createBy": "1",
                "createTime": 1577090850000,
                "updateBy": "1",
                "updateTime": 1577090882000,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "658712296322760704",
                "key": "fghfghfg",
                "typeKey": "taskCreate",
                "subTypeKey": null,
                "isDefault": "N",
                "subject": "警方根据和法国",
                "plain": "",
                "html": "",
                "wechat": "",
                "createOrgId": null,
                "creator": "管理员",
                "updator": "管理员"
            },
            {
                "pk": "",
                "name": "单机",
                "ip": null,
                "createBy": "1",
                "createTime": 1576222773000,
                "updateBy": "1",
                "updateTime": 1576222782000,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "655071317917171712",
                "key": "dj",
                "typeKey": "bpmnTaskTrans",
                "subTypeKey": null,
                "isDefault": "N",
                "subject": "",
                "plain": "",
                "html": "",
                "wechat": "",
                "createOrgId": null,
                "creator": "管理员",
                "updator": "管理员"
            }
        ],
        "pageResult": {
            "limit": 3,
            "page": 1,
            "totalCount": 23,
            "totalPages": 8
        }
    }
}

返回参数说明：

名称 类型 备注
data APIPageList< MessageTemplatePo > 消息模版实体对象

删除消息模板

简述：

  • 删除消息模板

请求URL：

请求方式：

  • POSTA

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：
名称 类型 是否必须 默认值 备注 其他信息
messageTemplateIds String[] 是 消息回复id数组
  • Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/msg/messageTemplate/remove?messageTemplateIds=673941178760036352

返回示例：

{
    "state": 200,
    "request": null,
    "message": "删除消息模板成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称 类型 备注
data Void

保存消息模板

简述：

  • 保存消息模板

请求URL：

请求方式：

  • POST

请求参数：

  • Headers：
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 是 系统令牌
  • Query：

暂无

  • Body：

MessageTemplatePo 对象信息

名称 类型 是否必须 默认值 备注
id String 否 主键
name String 否 模版名称
key String 否 模版业务键
typeKey String 否 模板分类。可以按任务操作类型分类，也可以按其它方式分类。
subTypeKey String 否 模板二级分类
isDefault String 否 是否默认模板
subject String 否 标题
plain String 否 纯文本
html String 否 模版体HTML
wechat String 否 微信模版体HTML
createBy String 否 创建人ID
createTime Date 否 创建时间
createOrgId String 否 创建者所属组织ID
updateBy String 否 更新人ID
updateTime Date 否 更新时间
creator String 否 创建人姓名
updator String 否 更新人姓名

请求参数示例：

{
    "name": "test",
    "key": "test",
    "typeKey": "taskCreate",
    "isDefault": "N",
    "subject": "测试",
    "plain": "test",
    "html": "<p>test</p>",
    "wechat": "tom"
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "消息模板添加成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称 类型 备注
data Void