2. 工单实例API

API列表

API调用

工单实例表接口

新增

接口地址:/v1/workorder/admin/instance/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "address": "",
  "appointTime": "",
  "bpmDefinitionId": "",
  "bpmInstanceId": "",
  "contactPhone": "",
  "createBy": "",
  "createTime": "",
  "currentPerson": "",
  "currentPersonId": 0,
"userId": 0,
  "custId": 0,
  "custName": "",
  "custPhone": "",
  "description": "",
  "doneTime": "",
  "id": 0,
  "incidentContent": "",
  "incidentPerson": "",
  "incidentPersonId": 0,
  "isAnonymous": "",
  "isDeleted": "",
  "orderCategoryId": 0,
  "orderCategoryName": "",
  "orderNo": "",
  "remark": "",
  "roomNo": "",
  "scopeType": "",
  "sendOrderPerson": "",
  "sendOrderPersonId": 0,
  "sendOrderPersonType": "",
  "serviceType": "",
  "spaceId": 0,
  "spaceName": "",
  "status": "",
  "submitSrc": "",
  "submitTime": "",
  "title": "",
  "updateBy": "",
  "updateTime": "",
  "urgentLevel": "",
  "version": 0,
  "workorderId": 0
}

请求参数:

响应参数:

暂无

响应示例:

null

查询

接口地址:/v1/workorder/admin/instance/get/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

响应参数:

暂无

响应示例:

null

列表

接口地址:/v1/workorder/admin/instance/list/all

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

响应参数:

暂无

响应示例:

null

分页

接口地址:/v1/workorder/admin/instance/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数: 我经办:menu=myHandled, 我处理:menu=pendingHandle

{
    "spaceId": "21906",
    "pageNo": 1,
    "pageSize": 10,
    "order": {
        "id": "desc"
    },
    "query": {
        "createTime": {//按照时间筛选今日或者本月数据
            "$gte": "2022-01-01 00:00:00",
            "$lte": "2022-07-04 23:59:59"
        },
        "status":{//未完成工单数
            "$nin":["CLOSED","COMPLETED"]
        }
    },
    "scopeType",1//客户报单
}

响应参数:

暂无

响应示例:

{
  "message": "Ok",
  "code": 200,
  "data": {
    "total": 8,
    "pages": 1,
    "records": [
      {
        "serviceType": null,
        "custPhone": "123456",
        "spaceName": "",
        "urgentLevel": null,
        "incidentPerson": null,
        "workorderType": null,
        "bpmInstanceId": null,
        "id": 1,
        "sendOrderPersonType": "1",
        "orderNo": "111",
        "appointTime": null,
        "roomNo": "2002",
        "version": null,
        "isAnonymous": null,
        "submitTime": null,
        "orderCategoryId": null,
        "status": "待接单",
        "incidentContent": null,
        "description": "待办测试",
        "remark": null,
        "sendOrderPersonId": null,
        "orderCategoryName": null,
        "title": "杰发的测试数据",
        "incidentPersonId": null,
        "isTimeoutRemind": null,
        "spaceId": null,
        "currentPersonId": null,
        "attachment": null,
        "isDeleted": null,
        "scopeType": null,
        "updateBy": null,
        "custId": 88293,
        "doneTime": "2021-12-22T13:31:39.000+00:00",
        "bpmDefinitionId": null,
        "address": "三期/10栋/1单元/2002",
        "nextStatus": null,
        "suspendReason": null,
        "currentPerson": null,
        "updateTime": null,
        "submitSrc": null,
        "custName": "liaojf17",
        "workorderTemplateId": 1,
        "updateById": null,
        "sendOrderPerson": "派单人",
        "createBy": null,
        "nodes": null,
        "createTime": null,
        "createById": null,
        "contactPhone": null
      }
    ],
    "pageNo": 1,
    "pageSize": 10
  }
}

删除

接口地址:/v1/workorder/admin/instance/remove/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

响应状态:

响应参数:

暂无

响应示例:

null

更新

接口地址:/v1/workorder/admin/instance/update

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "address": "",
  "appointTime": "",
  "bpmDefinitionId": "",
  "bpmInstanceId": "",
  "contactPhone": "",
  "createBy": "",
  "createTime": "",
  "currentPerson": "",
  "currentPersonId": 0,
  "custId": 0,
  "custName": "",
  "custPhone": "",
  "description": "",
  "doneTime": "",
  "id": 0,
  "incidentContent": "",
  "incidentPerson": "",
  "incidentPersonId": 0,
  "isAnonymous": "",
  "isDeleted": "",
  "orderCategoryId": 0,
  "orderCategoryName": "",
  "orderNo": "",
  "remark": "",
  "roomNo": "",
  "scopeType": "",
  "sendOrderPerson": "",
  "sendOrderPersonId": 0,
  "sendOrderPersonType": "",
  "serviceType": "",
  "spaceId": 0,
  "spaceName": "",
  "status": "",
  "submitSrc": "",
  "submitTime": "",
  "title": "",
  "updateBy": "",
  "updateTime": "",
  "urgentLevel": "",
  "version": 0,
  "workorderId": 0
}

请求参数:

响应参数:

暂无

响应示例:

null

2.7: 工单创建-用户端

描述

请求信息

HTTP协议：HTTP,HTTPS

接口地址:/v1/workorder/user/instance/submit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "attachment": "",
  "categoryId": 0,
  "custId": 0,
  "custName": "",
  "incidentContent": "",
  "orderCategoryName": "",
  "serviceType": "",
  "spaceId": 0,
  "spaceName": ""
}

请求参数:

响应参数:

响应示例:

{
  "code": 0,
  "data": {},
  "message": ""
}

2.8: 工单列表-用户端

描述

请求信息

HTTP协议：HTTP,HTTPS

接口地址:/v1/workorder/user/instance/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

响应参数:

暂无

响应示例:

null

2.9: 根据工单号获取工单信息-用户端

描述

请求信息

HTTP协议：HTTP,HTTPS

接口地址:/v1/workorder/user/instance/getByOrderNo

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

响应参数:

响应示例:

{
  "code": 0,
  "data": {},
  "message": ""
}

关闭

接口地址:/v1/workorder/admin/instance/close/{id}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{

}

请求参数:

响应参数:

暂无

响应示例:

null

回退

接口地址:/v1/workorder/admin/instance/fallback/{id}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{

}

请求参数:

转单

接口地址:/v1/workorder/admin/instance/transfer

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "currentPerson": "",
  "currentPersonId": "",
  "workorderIds": []
}

请求参数:

工单统计

接口地址:/v1/workorder/admin/instance/statistics?spaceId=21906

请求方式:GET

请求数据类型:request params

响应数据类型:*/*

接口描述:

请求示例:

`/v1/workorder/admin/instance/statistics?spaceId=21906`

请求参数: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |-----------------|--------------|----------|----------|----------------|--------| | spaceId | 空间id | | false | integer(int64) | |

响应参数: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |-----------------|--------------|----------|----------|----------------|--------| | todayNewCount | 今日新增 | | false | integer(int64) | | | notFinishCount | 未完成工单数 | | | integer(int64) | | | thisMonthCustServiceCount | 客户报单数 | | | integer(int64) | | | satisfaction | 满意度 | | | integer(int64) | |

响应示例:

{
    "message": "Ok",
    "code": 200,
    "data": {
        "todayNewCount": 0,
        "notFinishCount": 1,
        "thisMonthCustServiceCount": 1,
        "satisfaction": 97org/role/list
    }
}

员工工单统计

接口地址:/v1/workorder/admin/instance/own/statistics

请求方式:GET

请求数据类型:request params

响应数据类型:*/*

接口描述:

请求示例:

`/v1/workorder/admin/instance/own/statistics `

请求参数: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |-----------------|--------------|----------|----------|----------------|--------|

响应参数: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |-----------------|--------------|----------|----------|----------------|--------| | mySends | 我的待派单 | | false | integer(int64) | | | myReceives | 我的待接单 | | | | | | myHandles | 我的待处理 | | | | | | myVisits | 我的待回访 | | | | |

响应示例:

{
    "message": "Ok",
    "code": 200,
    "data": {
        "mySends": 0,
        "myReceives": 0,
        "myHandles": 0,
        "myVisits": 0
    }
}

员工待处理工单

接口地址:/v1/workorder/admin/instance/own/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
    "msgId": "1dce6d91-fe0a-885f-bea6-12cbad1c1caa",
    "spaceId": "21906",
    "pageNo": 1,
    "pageSize": 10,
    "order": {
        "id": "desc"
    },
    "status":"SEND", SEND:待派单,RECEIVE:待接单,HANDLE：待处理,VISIT：待回访,
    "scopeType":1
}

请求参数: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |-----------------|--------------|----------|----------|----------------|--------| | spaceId | 空间id | | false | integer(int64) | |

响应参数: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |-----------------|--------------|----------|----------|----------------|--------|

响应示例:

{
    "message": "Ok",
    "code": 200,
    "data": {
        "total": 0,
        "pages": 0,
        "records": [],
        "pageNo": 1,
        "pageSize": 10
    }
}
}

根据受理类型和工单类别id查询指定节点类型下的员工集合

接口地址:/v1/workorder/admin/instance/list/admins

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
    "scopeType":"1",
    "orderCategoryId":1176,
    "nodeCode":"A0002",
    "communityId":21906,
    "pageNo":1,
    "pageSize":100
}

请求参数:

响应参数: { "code": "200", "data": { "result": [ { "id": 304734, -- 员工id "org_id": 223539, "org_name": "NO4", "mobile": "13477000001", -- 员工手机号 "org_code": "100000149100010038100000000100000000100000000", "src": 1, "nickname": "lx01", "ico": null, "job_number": "lx01", "pwd": "$2a$10$QyZGLBqRR20QvHLiXIY6b.VqHzvnfVklepv9X8Fe.tm1V18vHBQdm", "name": "领贤零一", -- 员工姓名 "sex": null, "email": "13477000001@163.com", "identity": "430421196601010001", "type": 1, "status": 1, "face_ico": "https://iot-xlink-xfile.oss-cn-hangzhou.aliyuncs.com/customer/2022-08-11/218971660215162850.jpg", "is_effective": 1, } ], "pageNo": 1, "pageSize": 100, "total": 1, "totalPage": 1 }, "message": "成功" }