维修任务管理

维修任务管理，为施工员创建维修任务后，施工员可通过智慧工程APP或集成施工sdk的自研APP对损坏的设备进行调试、维修，也可为房屋配网新设备。

API 列表

请求方式	API	描述
POST	/v1.0/osaas/projects/{project_id}/maintenance/task	创建维修任务
GET	/v1.0/osaas/projects/{project_id}/maintenance/tasks	分页查询维修任务列表
GET	/v1.0/osaas/projects/{project_id}/maintenance/tasks/{task_id}	获取维修任务详情
POST	/v1.0/osaas/projects/{project_id}/maintenance/tasks/{task_id}/reopen	维修任务重开放
POST	/v1.0/osaas/projects/{project_id}/maintenance/tasks/{task_id}/acceptance	验收维修任务
DELETE	/v1.0/osaas/projects/{project_id}/maintenance/tasks/{task_id}	删除维修任务

创建维修任务

接口描述

调用该接口创建维修任务

接口地址

POST /v1.0/osaas/projects/{project_id}/maintenance/task

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
worker_id	String	BODY	施工员唯一标识	是
room_device_relations	Arrays	BODY	房间设备关系列表	是

room_device_relations 参数说明

参数名	类型	参数类型	说明	是否必需
room_id	String	BODY	房屋唯一标识	是
device_ids	String[]	BODY	设备唯一标识列表	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	任务唯一标识

请求示例

POST {url}/v1.0/osaas/projects/123382396505******/maintenance/task

{
  "worker_id": "13064118127******",
  "room_device_relations": [
    {
      "room_id": "1452678965053******",
      "device_ids": [
        "00122433******"
      ]
    }
  ]
}

响应成功示例

{
  "success": true,
  "result": "11123823965053******",
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询维修任务列表

接口描述

调用该接口分页查询维修任务列表

接口地址

GET /v1.0/osaas/projects/{project_id}/maintenance/tasks

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	BODY	项目唯一标识	是
page_no	Integer	BODY	页码(page_no>0)(默认1)	否
page_size	Integer	BODY	页条数(0<page_size<100)(默认20)	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	维修任务分页结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
page_size	Integer	页条数
tasks	Arrays	维修任务列表

tasks参数说明

参数名	类型	说明
task_id	String	任务唯一标识
maintenance_status	String	维修状态: PENDING_CONSTRUCTION:待施工 IN_CONSTRUCTION:施工中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成
worker_username	String	施工员用户名
worker_nickname	String	施工员昵称
gmt_create	Long	创建时间，13 位时间戳

请求示例

GET {url}/v1.0/osaas/projects/1233823965053******/maintenance/tasks?page _no=1&page_size=20

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 20,
    "tasks": [
      {
        "task_id": "130641181272348xxxx",
        "worker_username": "test@tuya.com",
        "worker_nickname": "张三",
        "maintenance_status": "PENDING_CONSTRUCTION",
        "gmt_create": 1600766546913
      }
    ]
  },
  "success": true,
  "t": 1572936751228
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

获取维修任务详情

接口描述

调用该接口获取维修任务详情

接口地址

GET /v1.0/osaas/projects/{project_id}/maintenance/tasks/{task_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
task_id	String	URI	任务唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	维修任务详情

result参数说明

参数名	类型	说明
task_id	String	任务唯一标识
maintenance_ status	String	维修状态: PENDING_CONSTRUCTION:待施工 IN_CONSTRUCTION:施工中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成
worker_username	String	施工员用户名
worker_nickname	String	施工员昵称
gmt_create	Long	创建时间，13 位时间戳
room_device_relations	Arrays	房间设备关系列表

room_device_relations参数说明

参数名	类型	说明
room_id	String	房间唯一标识
device_ids	String[]	设备唯一标识列表

请求示例

GET {url}/v1.0/osaas/projects/1233823965053******/maintenance/tasks/126770532******

响应成功示例

{
  "result": {
    "task_id": "1306411812723******",
    "worker_username": "test@tuya.com",
    "worker_nickname": "张三",
    "construction_status": "PENDING_CONSTRUCTION",
    "gmt_create": 1600766546913,
    "room_device_relations": [
      {
        "room_id": "1452678965053******",
        "device_ids": [
          "00122433******"
        ]
      }
    ]
  },
  "success": true,
  "t": 1572936751228
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

维修任务重开放

接口描述

调用该接口维修任务重开放

接口地址

POST /v1.0/osaas/projects/{project_id}/maintenance/tasks/{task_id}/reopen

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
task_id	String	URI	任务唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

POST {url}/v1.0/osaas/projects/12338239650******/maintenance/tasks/126770******/reopen

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

验收维修任务

接口描述

调用该接口验收维修任务

接口地址

POST /v1.0/osaas/projects/{project_id}/maintenance/tasks/{task_id}/acceptance

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
task_id	String	URI	任务唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

POST {url}/v1.0/osaas/projects/12338239650******/maintenance/tasks/12677053******/acceptance

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

删除维修任务

接口描述

调用该接口删除维修任务

接口地址

DELETE /v1.0/osaas/projects/{project_id}/maintenance/tasks/{task_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
task_id	String	URI	任务唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

DELETE {url}/v1.0/osaas/projects/123382396505******/maintenance/tasks/1267705******

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误