1. 工单模板API

API列表

编号 API名称 路径 版本
1.1 新增工单模板 /v1/workorder/admin/admin/template/add 1.0
1.2 工单模板详情 /v1/workorder/admin/admin/template/get/{id} 1.0
1.3 修改工单模板 /v1/workorder/admin/template/update 1.0
1.4 删除工单模板 /v1/workorder/admin/template/remove/{id} 1.0
1.5 工单模板列表 /v1/workorder/admin/template/list 1.0
1.6 工单模板分页 /v1/workorder/admin/template/page 1.0
1.7 新增更新流程定义 /v1/workorder/admin/template/add/definition 1.0
1.8 校验工单分类是否设计流程节点 /v1/workorder/admin/template/isExistProcessDefinition/{id} 1.0
1.9 添加或者更新模板 /v1/workorder/admin/template/addOrUpdate 1.0

API调用

1.1: 新增工单模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/add

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 工单名称
scopeType body int y 适用范围，1客户报事 2员工报事
categoryIds body string y 工单分类ID，逗号隔开

请求Body描述(非Form表单数据)

{
  "name": "",
  "scopeType": 1,
  "categoryIds": "123,234"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
id 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
    "id": 3
  }
}

1.2: 工单模板详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/get/{id}

方法：GET

请求参数

名称 位置 类型 必填 描述
id url int y 主键id

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
name body string y 工单名称
scopeType body int y 适用范围，1客户报事2员工报事
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
    "name": "",
    "workorderType": 1
  }
}

1.3: 修改工单模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/update

方法：PUT

请求参数

名称 位置 类型 必填 描述
name body string y 工单名称
scopeType body int y 适用范围，1客户报事2员工报事
id body int y 主键id

请求Body描述(非Form表单数据)

{
    "id": 1,
    "name": "",
  "workorderType": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.4: 删除工单模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/remove/{id}

方法：DELETE

请求参数

名称 位置 类型 必填 描述
id body int y 主键id

请求Body描述(非Form表单数据)

{
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.5: 工单模板列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/list/all

方法：POST

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
records data Array 是 列表
name records string y 分类名称
orderNo records int y 分类排序号
pid records int n 父id
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "name": "",
            "orderNo": "",
            "pid": 0,
      "categoryNames": "报修,报事"
        }
      ]
  }
}

1.6: 工单模板分页列表/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int y 每页条数
pageNo body int y 当前页数

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
total data int y 总条数
records data Array y 列表
name records string y 分类名称
orderNo records int y 分类排序号
pid records int n 父id
id records int y 主键id
categoryNames records string y 分类名称
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "total": 10,
      "pageNo": 1,
      "pageSize": 10,
      "records": [
          {
            "id": 1,
            "name": "",
            "orderNo": "",
            "pid": 0,
      "categoryNames": "报修,报事"
        }
      ]
  }
}

1.7: 新增更新流程定义/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/add/definition

方法：POST

请求参数

参数名称 参数说明 请求类型 是否必须 数据类型 schema
entity 工单模板表 body true Template对象 Template对象
categoryIds 分类ID，逗号隔开 true string
categoryNames 分类名称，逗号隔开 true string
id 主键 false integer(int64)
lines 连线列表 false array 流程连线
conditionExpression 条件表达式 false string
edges 坐标信息 false array 点位
x x坐标 false integer
y y坐标 false integer
id id false string
sourceRefÏ 来源key false string
targetRef 目标key false string
name 工单流程名称 true string
processDefinitionJson 流程定义json false string
processDefinitionKey 流程KEY false string
processDefinitionXml 流程文件内容 false string
scopeType 适用范围，1客户报单 2员工报单 true string
tasks 节点列表 false array 流程节点
acceptRemind 接单后提示语 false string
autoSubmitHour 自动提交时长，小时 false integer
autoSubmitMinute 自动提交时长，分钟 false string
createBy 创建人 false string
createTime 创建时间 false string
custCloseRemind 客户端关闭消息 false string
custDoneRemind 完成后文案，业主 false string
fields false array 动态表单字段
field 字段属性 false Field对象 Field对象
extraInfo 扩展属性 false string
fieldCode 字段编码 true string
fieldName 字段名称 true string
formId 表单ID false string
id 主键 false integer
isDeleted 逻辑删除 false string
type 类型 true string
fieldValue 字段值 false string
nodeFieldRel 权限 false NodeFieldRel对象 NodeFieldRel对象
fieldCode 字段code false string
fieldId 字段ID false integer
id 主键 false integer
isHidden 是否隐藏1否2是 false string
nodeId 节点ID false integer
operateRight 读写权限r只读w只写rw读写 false string
sortNo 排序号 false integer
workorderId 工单ID false integer
workorderTemplateId 工单模板ID,0表示节点模板 false integer
hasNodeForm 是否有节点表单，1否2是 false string
id 主键 false integer
incoming 来源节点key false array string
isAutoSubmit 是否超时自动提交 false string
isClosable 是否可关闭工单1否2是 false string
isCloseRemind 是否推送关闭消息1否2是 false string
isDeleted 逻辑删除 false string
isDone 完成后设置 false string
isDoneRemind 完成后是否推送 false string
isFallback 是否允许回退1否2是 false string
isSuspend 是否允许挂起1否2是 false string
isTimeoutRemind 超时是否提醒 1否 2是 false string
isTransform 是否允许转单1否2是 false string
nodeCode 节点编码 false string
nodeName 节点名称 false string
orderNo 排序号 false string
outgoing 目标节点key false array string
participateRolesId 参与角色ID,逗号隔开 false string
participateRolesName 参与角色名称,逗号隔开 false string
shapes 坐标信息 false 点位尺寸 点位尺寸
height 高度 false integer
width 宽度 false integer
x x坐标 false integer
y y坐标 false integer
suspendTime 挂起时间 false string
suspendTimeout 挂起时长，小时 false integer
taskKey 节点key false string
taskType 节点类型: userTask用户节点/serviceTask服务节点/startEvent开始节点/endEvent结束节点/exclusiveGateway分支节点 false string
timeoutHour 时长，小时 false integer
timeoutMinute 时长，分钟 false integer
timeoutRemind 提醒文案 false string
timeoutRemindTarget 超时提醒致：1可处理人，2部门负责人，3全部 false string
transformTimes 允许转单次数 false integer
updateBy 更新人 false string
updateTime 更新时间 false string
workorderId 工单ID false integer
workorderTemplateId 工单模板ID,0表示节点模板 false integer

请求Body描述(非Form表单数据)

{
  {
  "categoryIds": "",
  "categoryNames": "",
  "id": 0,
  "lines": [
    {
      "conditionExpression": "",
      "edges": [
        {
          "x": 0,
          "y": 0
        }
      ],
      "id": "",
      "sourceRef": "",
      "targetRef": ""
    }
  ],
  "name": "",
  "processDefinitionJson": "",
  "processDefinitionKey": "",
  "processDefinitionXml": "",
  "scopeType": "",
  "tasks": [
    {
      "acceptRemind": "",
      "adminCloseRemind": "",
      "adminDoneRemind": "",
      "autoSubmitHour": 0,
      "autoSubmitMinute": "",
      "createBy": "",
      "createTime": "",
      "custCloseRemind": "",
      "custDoneRemind": "",
      "fields": [
        {
          "field": {
            "extraInfo": "",
            "fieldCode": "",
            "fieldName": "",
            "formId": "",
            "id": 0,
            "isDeleted": "",
            "type": ""
          },
          "fieldValue": "",
          "nodeFieldRel": {
            "fieldCode": "",
            "fieldId": 0,
            "id": 0,
            "isHidden": "",
            "nodeId": 0,
            "operateRight": "",
            "sortNo": 0,
            "workorderId": 0,
            "workorderTemplateId": 0
          }
        }
      ],
      "hasNodeForm": "",
      "id": 0,
      "incoming": [],
      "isAutoSubmit": "",
      "isClosable": "",
      "isCloseRemind": "",
      "isDeleted": "",
      "isDone": "",
      "isDoneRemind": "",
      "isFallback": "",
      "isSuspend": "",
      "isTimeoutRemind": "",
      "isTransform": "",
      "nodeCode": "",
      "nodeName": "",
      "orderNo": "",
      "outgoing": [],
      "participateRolesId": "",
      "participateRolesName": "",
      "shapes": {
        "height": 0,
        "width": 0,
        "x": 0,
        "y": 0
      },
      "suspendTime": "",
      "suspendTimeout": 0,
      "taskKey": "",
      "taskType": "",
      "timeoutHour": 0,
      "timeoutMinute": 0,
      "timeoutRemind": "",
      "timeoutRemindTarget": "",
      "transformTimes": 0,
      "updateBy": "",
      "updateTime": "",
      "workorderId": 0,
      "workorderTemplateId": 0
    }
  ]
}
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
total data int y 总条数
records data Array y 列表
name records string y 分类名称
orderNo records int y 分类排序号
pid records int n 父id
id records int y 主键id
categoryNames records string y 分类名称
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

1.8: 校验工单分类是否设计流程节点/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/isExistProcessDefinition/{id}

方法：GET

请求参数

名称 位置 类型 必填 描述
id url int y 主键id

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

校验通过

{
    "message": "Ok",
    "code": 200,
    "data": 1
}

校验不通过

{
    "message": "Ok",
    "code": 200,
    "data": 2
}

校验失败

{
    "code": "1",
    "message": "该工单分类不存在"
}

备注：data值1表示校验通过，data值为2表示校验不通过，无data值表示该工单分类不存在。

1.8: 添加或者更新模板/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/template/addOrUpdate

方法：POST

请求参数

{
  "msgId": "cae8c6e0-dc0a-cb38-541a-3ffea2b43793",
  "name": "LXY10",
  "categoryIds": "1137,1140",
  "categoryNames": "维修类/住户家庭",
  "scopeType": "2",
  "processDefinitionJson": "{\"title\":\"流程\",\"node\":{\"name\":\"登记\",\"type\":\"SUBMIT\",\"id\":1,\"levelId\":1,\"nodeId\":\"sid-startevent\",\"childNode\":{\"name\":\"接单\",\"id\":3,\"levelId\":3,\"prevId\":\"sid-startevent\",\"nodeId\":\"node1659351554342\",\"type\":\"RECEIVE\"}}}",
  "lines": [
    {
      "id": "sid-startevent#node1659351554342",
      "sourceRef": "sid-startevent",
      "targetRef": "node1659351554342"
    },
    {
      "id": "node1659351554342#sid-endevent",
      "sourceRef": "node1659351554342",
      "targetRef": "sid-endevent"
    },
    {
      "id": "sid-endevent#sid-endevent",
      "sourceRef": "sid-endevent",
      "targetRef": "sid-endevent"
    }
  ],
  "tasks": [
    {
      "nodeName": "登记",
      "id": 1,
      "taskKey": "sid-startevent",
      "taskType": "startEvent",
      "outgoing": [
        "node1659351554342"
      ]
    },
    {
      "nodeName": "接单",
      "id": 3,
      "taskKey": "node1659351554342",
      "taskType": "userTask",
      "incoming": [
        "sid-startevent"
      ],
      "outgoing": [
        "sid-endevent"
      ]
    },
    {
      "nodeName": "结束",
      "taskKey": "sid-endevent",
      "taskType": "endEvent",
      "incoming": [
        "node1659351554342"
      ],
      "outgoing": [
        "sid-endevent"
      ]
    }
  ]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
    "message": "Ok",
    "code": 200,
    "data": 1
}

results matching ""

    No results matching ""