工单

获取工单编号: /generateCode/workForms GET

返回结果:

{
  "no": "202205142345"
}

获取工单数: /count/workForms GET

请求参数 queryParams

参数名	示列值	类型	必须	说明
status	1	number	否	处理状态:1=处理中,2=已关闭,3=已完成（已流转）
name	测试测试工单	string	否	工单名称
workFormFlowId	3	number	否	服务流程id

返回结果:

{
  "total": 6
}

新建工单: /workForms POST

请求参数

参数名	示列值	类型	必须	说明
no	123456	string	是	工单编号
workFormFlowId	1	number	是	工单流程id
name	服务流程	string	是	工单名称
description	工单描述	string	否	描述
images	['http://www.baidu.com/1.png']	string[]	否	图片url数组
appendixes	['http://www.baidu.com/1.pdf']	string[]	否	附件url数组
phases		WorkFormPhase[]	否	阶段
phases.workFormFlowPhaseId	工单流程阶段id	number	是
phases.order	工单流程阶段序号	number	是
phases.status	1	number	是	处理状态 1=处理中,2=已关闭,3=已完成（已流转）
phases.handlerId	处理人id	number	是
phases.description	备注	string	是
phases.images		string[]	否	图片url数组
phases.appendixes		string[]	否	附件url数组

返回结果: 工单信息

请求示例

{
  "no": "01",
  "workFormFlowId": 3,
  "name": "测试",
  "creatorId": 1,
  "description": "描述描述",
  "images": [],
  "appendixes": [],
  "phases": [{
    "workFormFlowPhaseId": 1,
    "order": 1,
    "status": 1,
    "handlerId": 1,
    "description": "测试",
    "images": [],
    "appendixes": [],
  }]
}

编辑工单: /workForms/:id PUT

请求参数

参数名	示列值	类型	必须	说明
name	123456	string	是	名称
no	123456	string	是	工单编号
workFormFlowId	1	number	是	工单流程id
name	服务流程	string	是	工单名称
description	工单描述	string	否	描述
images	['http://www.baidu.com/1.png']	string[]	否	图片url数组
appendixes	['http://www.baidu.com/1.pdf']	string[]	否	附件url数组
phases		WorkFormPhase[]	否	阶段
phases.id	阶段id	number	否	更新阶段数据时必传，新建阶段数据时不传
phases.workFormFlowPhaseId	工单流程阶段id	number	是
phases.order	工单流程阶段序号	number	是
phases.status	1	number	是	处理状态: 1=处理中,2=已关闭,3=已完成（已流转）
phases.handlerId	处理人id	number	是
phases.images	['http://www.baidu.com/1.png']	string[]	否	图片url数组
phases.appendixes	['http://www.baidu.com/1.pdf']	string[]	否	附件url数组
phases.description	阶段备注	string	否

返回结果: 工单信息

请求示例

{
  "id": 1,
  "no": "01",
  "workFormFlowId": 3,
  "name": "测试单据",
  "creatorId": 1,
  "description": "哈哈哈哈哈哈",
  "images": ["https://bs-develop-share.oss-cn-shenzhen.aliyuncs.com/811653375142_.pic.jpg"],
  "appendixes": ["https://bs-develop-share.oss-cn-shenzhen.aliyuncs.com/811653375142_.pic.jpg"],
  "phases": [{
    "id": 1,
    "workFormFlowPhaseId": 1,
    "order": 1,
    "status": 1,
    "handlerId": 1
  }, {
    "workFormFlowPhaseId": 2,
    "order": 2,
    "status": 1,
    "handlerId": 1
  }]
}

工单详情: /workForms/:id GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	id
expand	'creator,phases,workFormFlow,records'	string	否	获取指定子资源数据 ''
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段

返回结果

recoreds字段说明：

参数名	示列值	类型	必须	说明
id	1	number	是	记录 id
currentHandlerId	0	number	是	当前处理人id
destinationHandlerId	0	number	是	目标处理人id
status	1	number	是	0=新建工单,1=信息变更,2=待处理,3=转接
beforeData	{}	json	是	变更前数据
afterData	{}	json	是	变更后数据
createdAt	1654592151	number	创建时间

{
  "createdAt": 1654592151,
  "updatedAt": 1654592954,
  "id": 17,
  "no": "0010001",
  "workFormFlowId": 3,
  "creatorId": 1,
  "name": "测试",
  "description": "哈哈0000哈哈哈哈",
  "images": [
    "https://bs-develop-share.oss-cn-shenzhen.aliyuncs.com/811653375142_.pic.jpg"
  ],
  "appendixes": [
    "https://bs-develop-share.oss-cn-shenzhen.aliyuncs.com/811653375142_.pic.jpg"
  ],
  "status": 1,
  "deletedAt": null,
  "workFormFlow": {
    "createdAt": 1653557280,
    "updatedAt": 1653560349,
    "id": 3,
    "name": "工单测试流程",
    "status": 0,
    "creatorId": 1,
    "updaterId": null,
    "deletedAt": null
  },
  "phases": [
    {
      "createdAt": 1653622586,
      "id": 1,
      "order": 1,
      "status": 1,
      "description": "",
      "images": [],
      "appendixes": [],
      "handler": {
        "id": 1,
        "name": "test",
        "avatar": "",
        "departments": []
      },
      "name": "阶段1"
    },
    {
      "createdAt": 1653623299,
      "id": 2,
      "order": 2,
      "status": 1,
      "description": "",
      "images": [],
      "appendixes": [],
      "handler": {
        "id": 1,
        "name": "test",
        "avatar": "",
        "departments": []
      },
      "name": "阶段2"
    },
    {
      "createdAt": 1654592151,
      "id": 1,
      "order": 1,
      "status": 1,
      "description": "",
      "images": [],
      "appendixes": [],
      "handler": {
        "id": 1,
        "name": "test",
        "avatar": "",
        "departments": []
      },
      "name": "阶段1"
    },
    {
      "createdAt": 1654592409,
      "id": 2,
      "order": 2,
      "status": 1,
      "description": "",
      "images": [],
      "appendixes": [],
      "handler": {
        "id": 1,
        "name": "test",
        "avatar": "",
        "departments": []
      },
      "name": "阶段2"
    },
    {
      "createdAt": 1654592819,
      "id": 2,
      "order": 2,
      "status": 1,
      "description": "",
      "images": [],
      "appendixes": [],
      "handler": {
        "id": 1,
        "name": "test",
        "avatar": "",
        "departments": []
      },
      "name": "阶段2"
    }
  ],
  "creator": {
    "id": 1,
    "name": "test",
    "avatar": "",
    "departments": []
  },
  "recoreds": [
    {
      "createdAt": 1654592954,
      "updatedAt": 1654592954,
      "id": 6,
      "workFormId": 17,
      "currentHandlerId": 1,
      "destinationHandlerId": 0,
      "status": 1,
      "beforeData": {
      },
      "afterData": {
      },
      "deletedAt": null,
      "currentHandler": {
        "id": 1,
        "name": "test",
        "avatar": ""
      },
      "destinationHandler": null
    },
    {
      "createdAt": 1654592819,
      "updatedAt": 1654592819,
      "id": 5,
      "workFormId": 17,
      "currentHandlerId": 1,
      "destinationHandlerId": 1,
      "status": 3,
      "beforeData": {},
      "afterData": {},
      "deletedAt": null,
      "currentHandler": {
        "id": 1,
        "name": "test",
        "avatar": ""
      },
      "destinationHandler": {
        "id": 1,
        "name": "test",
        "avatar": ""
      }
    },
    {
      "createdAt": 1654592409,
      "updatedAt": 1654592409,
      "id": 4,
      "workFormId": 17,
      "currentHandlerId": 1,
      "destinationHandlerId": 1,
      "status": 3,
      "beforeData": {},
      "afterData": {},
      "deletedAt": null,
      "currentHandler": {
        "id": 1,
        "name": "test",
        "avatar": ""
      },
      "destinationHandler": {
        "id": 1,
        "name": "test",
        "avatar": ""
      }
    },
    {
      "createdAt": 1654592151,
      "updatedAt": 1654592151,
      "id": 2,
      "workFormId": 17,
      "currentHandlerId": 1,
      "destinationHandlerId": 0,
      "status": 0,
      "beforeData": {},
      "afterData": {},
      "deletedAt": null,
      "currentHandler": {
        "id": 1,
        "name": "test",
        "avatar": ""
      },
      "destinationHandler": null
    },
    {
      "createdAt": 1654592151,
      "updatedAt": 1654592151,
      "id": 3,
      "workFormId": 17,
      "currentHandlerId": 1,
      "destinationHandlerId": 0,
      "status": 2,
      "beforeData": {},
      "afterData": {},
      "deletedAt": null,
      "currentHandler": {
        "id": 1,
        "name": "test",
        "avatar": ""
      },
      "destinationHandler": null
    }
  ]
}

删除工单: /workForms/:id DELETE

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	资源id

返回示列

HTTP/1.1 204 NO CONTENT

工单列表: /workForms GET

请求参数

参数名	示列值	类型	必须	说明
page	1	number	否	当前页数
pageSize	10	number	否	每页条数
name	xxx	string	否	名称
no	xxx	string	否	编号
search	xxx	string	否	模糊查找(支持同时查询名称和编号)
currentHandlerId	1	number	否	当前处理人
creatorId	1	number	否	创建人
createdAt	{123,321}	string	否	创建时间
workFormFlowId	1	number	否	工单流程Id
meType	1	string	否	1=待我处理 2=我创建的 3=我已处理 4=我的全部工单
status	1	number	否	处理状态: 1=处理中,2=已关闭,3=已完成（已流转)
sort	-createdAt	string	否	排序。多个排序字段用,号隔开。sort=-a,b
expand	'creator,phases,workFormFlow,records'	string	否	获取指定子资源数据 'creator,phases,workFormFlow,records'
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名	示列值	说明
page	1	当前页数
pageSize	10	每页条数
limit	10	同 pageSize
offset	2	起始条数
total	3231	符合条件的总数量
items	[{ "id": 4, "name": "test2"]	返回数据项

items：工单信息

参数名	示列值	类型	说明
id	1	number	id
name	跑步	string	名称
index	0	number	序号
description	''	string	描述
status	0	number	状态 1=处理中,2=已关闭,3=已完成（已流转）
createdAt	1650160322	number	创建时间
updatedAt	1650160322	number	更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
      {
        "id": 1,
        "name": "测试",
        "status": 1,
        "creator": {
          "id": 1,
          "name": "super_admin"
        },
        "phases": [
          {
            "id": 1,
            "workFormId": 1,
            "order": 1,
            "workFormFlowPhaseId": 1,
            "status": 1,
            "handler": {
              "id": 1,
              "name": "super_admin"
            }
          }
        ],
        "images": [],
        "appendixes": []
      }
    ],
    "total": 4070,
    "offset": 1,
    "limit": 2,
    "page": 1,
    "pageSize": 2
  }

所有工单: /listAll/workForms GET

请求参数

参数名	示列值	类型	必须	说明
name	xxx	string	否	名称
expand	''	string	否	获取指定子资源数据 'creator,phases,workFormFlow,records'
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 工单信息

返回示列

HTTP/1.1 200 OK
[
  {}
]