Update Work Order¶
更新工单。您可通过指定工单ID来更新工单的相关信息,包括工单标题,场站ID等。
请求格式¶
POST https://{apigw-address}/work-management-cmms/v1.0/cmms/work-order/update
请求参数(Header)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
authorization |
必需 |
String |
Access Token,以Bearer Token表示,其形式为 Bearer {your token}。可通过调用 Log In 或 Refresh Access Token 接口后获取。 |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
woId |
必需 |
String |
工单ID, 通过指定该 ID您可筛选待更新的工单。 |
title |
可选 |
String |
指定工单标题的更新值。 |
description |
可选 |
String |
指定工单描述的更新值。 |
siteId |
可选 |
String |
指定场站 ID的更新值。 |
deviceId |
可选 |
String |
指定设备 ID的更新值,使用英文逗号分隔。 |
woStatus |
可选 |
Integer |
指定工单状态的更新值。 |
priority |
可选 |
Integer |
指定工单优先级的更新值。您可以按照如下方式赋值:
|
workType |
可选 |
String |
指定工单类型的更新值。 |
assignee |
可选 |
User结构体 |
指定工单指派人的更新值。其结构参见 User 结构体。 |
followers |
可选 |
List<User> |
指定工单关注人列表的更新值。其结构参见 User 结构体。 |
parentId |
可选 |
String |
指定父工单 ID的更新值。 |
plannedStartTime |
可选 |
String |
指定父工单计划开始时间的更新值。格式:yyyy-MM-dd HH:mm:ss |
plannedEndTime |
可选 |
String |
指定父工单计划结束时间的更新值。格式:yyyy-MM-dd HH:mm:ss |
actualStartTime |
可选 |
String |
指定父工单实际开始时间的更新值。格式:yyyy-MM-dd HH:mm:ss |
actualEndTime |
可选 |
String |
指定父工单实际结束时间的更新值。格式: yyyy-MM-dd HH:mm:ss |
fileIds |
可选 |
List<String> |
指定附件 ID列表的更新值。 |
tags |
可选 |
List<String> |
指定用户自定义标签列表的更新值。 |
customizedParam |
可选 |
List<Param>。 |
指定用户自定义字段的更新值。其结构参见 Param 结构体。 |
User 结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
userId |
String |
用户ID。如何获取UserId>> |
username |
String |
用户名称。 |
Param 结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
key |
String |
用户自定义字段标识符,需要在工作管理表单中注册。 |
value |
String |
用户自定义字段值。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
count |
Integer |
工单更新成功的数量。 |
示例¶
请求示例¶
url: https://{apigw-address}/work-management-cmms/v1.0/cmms/work-order/update
method: POST
Header:
authorization: Bearer your_token
requestBody:
{
"woId":"yourwoId",
"title":"新工单标题"
}
返回示例¶
{
"code": 0,
"data": {
"count": 1
}
}