Get Work Order List¶
获取工单列表。
请求格式¶
POST https://{apigw-address}/work-management/v1.0/s-taskmgmtds/cmms/work-order/list
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
locale | Query | 可选 | String | 区域信息(Chinese: zh-CN, English: en-US)。 |
请求参数(Header)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
authorization | 必需 | String | 从应用门户获取的用户 Token 信息。 |
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
startTime | 必需 | String | 开始时间,格式:yyyy-MM-dd HH:mm:ss。 |
endTime | 必需 | String | 结束时间,格式:yyyy-MM-dd HH:mm:ss。 |
siteIds | 必需 | List 格式 String | 场站 ID 列表。 |
woStatus | 可选 | List 格式 Integer | 状态列表。 |
priority | 可选 | List 格式 String | 来源业务 ID 列表。 |
workTypes | 可选 | List 格式 Integer | 工单类型列表。 |
assigneeIds | 可选 | List 格式 String | 指派人用户 ID 列表。 |
queryTodo | 可选 | Boolean | 是否查询代办(assigneeIds 以及其所属用户组的任务)。注:assigneeIds 暂时仅支持单个用户的代办。 |
plannedEndTime | 可选 | String |
|
plannedEndTimeFrom | 可选 | String | plannedEndTime 开始时间。 |
plannedEndTimeTo | 可选 | String | plannedEndTime 结束时间。 |
dueDate | 可选 | String |
|
dueDateFrom | 可选 | String | dueDate 开始时间。 |
dueDateTo | 可选 | String | dueDate 结束时间。 |
createUserIds | 可选 | List 格式 String | 创建人用户 ID 列表。 |
sortName | 可选 | String | 排序字段。支持按以下字段排序: - woNum:编号(默认值) - woStatus:状态 - priority:优先级 - createTime:创建时间 - updateTime:更新时间 |
sortType | 可选 | String | 排序方式。ASC:升序;DESC:降序(默认值)。 |
keyword | 可选 | String | 搜索关键字。 |
customizedParam | 可选 | List 格式 Param 结构体 | 关键字可多个条件查询。示例:[{“key”: “subType”,”value”: “缺陷”},{“key”: “subType”,”value”: “故障”}]。其结构参见 Param 结构体。 |
plannedStartTimeFrom | 可选 | String | 计划开始时间起始时间点。 |
plannedStartTimeTo | 可选 | String | 计划开始时间截止时间点。 |
actualStartTimeFrom | 可选 | String | 实际开始时间起始时间点。 |
actualStartTimeTo | 可选 | String | 实际开始时间截止时间点。 |
actualEndTimeFrom | 可选 | String | 实际结束时间起始时间点。 |
actualEndTimeTo | 可选 | String | 实际结束时间截止时间点。 |
followerIds | 可选 | List 格式 String | 关注人的 ID 列表。 |
pageNo | 可选 | Integer | 第几页。默认值:1。 |
pageSize | 可选 | Integer | 每页条数。默认值:50,最大值:1000。 |
Param 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
key | String | 自定义字段标识符,需要在工作管理表单中注册。 |
value | String | 所查询的字段值。 |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | Data 结构体 | 成功的返回信息。其结构参见 Data 结构体。 |
Data 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
pageNo | Integer | 页码。 |
pageSize | Integer | 每页条数。 |
total | Integer | 查询到数据量总数。 |
list | List 格式 WorkOrder 结构体 | WorkOrder 对象列表,其结构参见 WorkOrder 结构体。 |
Work Order 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
orgId | String | 组织 ID。 |
woId | String | 工单 ID。 |
woNum | String | 工单编号。 |
title | String | 工单标题。 |
description | String | 工单描述。 |
woStatus | Integer | 工单状态码。 |
siteId | String | 场站 ID。 |
siteName | String | 场站名称。 |
workType | Integer | 工单类型。 |
priority | Integer | 工单优先级。 |
plannedStartTime | String | 计划开始时间。 |
plannedEndTime | String | 计划结束时间。 |
assigneeName | String | 指派人名称。 |
assigneeId | String | 指派人 ID。 |
createUserId | String | 创建人 ID。 |
createUser | String | 创建人名称。 |
createTime | String | 票单创建时间。 |
createLocalTime | String | 票单本地创建时间。 |
dueDate | String | 截止日期。 |
updateUserId | String | 票单更新人 ID。 |
updateUser | String | 票单更新人名称。 |
updateTime | String | 票单更新时间。 |
deviceId | String | 设备 ID。 |
deviceName | String | 设备名称。 |
customizedParam | List 格式 Param 结构体 | 自定义字段。其结构参见 Param 结构体。 |
timezone | String | 场站时区。 |
note | String | 备注。 |
relatedIssue | Integer | 关联记录数量。 |
relatedDowntime | Integer | 关联停机记录数量。 |
sourceType | Integer | 来源类型。该接口接受枚举值。1:告警;2:预警;3:运维建议;4:手工;5:停机记录;6:运维计划(内部保留值);7:服务请求(内部保留值)。 |
scheduleNum | String | 运维计划编号。 |
expired | Boolean | 是否逾期。 |
remainingTime | String | 票单剩余时间(ms)。 |
templateKey | String | 模板关键字。 |
templateValue | String | 模板值。 |
错误码¶
名称 | 描述 |
---|---|
96134 | 场站 ID 无效。 |
96146 | 自定义字段 key 不支持筛选,请检查配置或更改参数。 |
示例¶
请求示例¶
url: https://{apigw-address}/work-management/v1.0/work-order/list
method: POST
requestBody:
{
"pageNo": 1,
"pageSize": 50,
"siteIds":["siteId1","siteId2"],
"startTime":"2021-05-09 16:28:39",
"endTime":"2021-06-09 16:28:39",
"keyword":""
}
返回示例¶
{
"code": 0,
"data": {
"list": [
{
"orgId": "orgId",
"woId": "woId",
"woNum": "woNum",
"title": "title",
"description": "",
"woStatus": 20,
"siteId": "siteId",
"siteName": "siteName",
"workType": 1,
"priority": 1,
"plannedStartTime": "",
"plannedEndTime": "2022-01-25 05:14:00",
"assigneeName": "",
"assigneeId": "",
"createUserId": "createUserId",
"createUser": "createUser",
"createTime": "2022-01-20 13:14:00",
"createLocalTime": "2022-01-20 05:14:00",
"dueDate": "",
"updateUserId": "updateUserId",
"updateUser": "updateUserName",
"updateTime": "2022-08-18 22:54:21",
"status": 1,
"deviceId": "deviceId",
"deviceName": "deviceName",
"timezone": "+08:00",
"note": "",
"relatedIssue": 0,
"relatedDowntime": 0,
"sourceType": 1,
"scheduleNum": "",
"expired": true,
"remainingTime": "-22",
"templateKey": "workType",
"templateValue": "1"
}
],
"pageNo": 1,
"pageSize": 1,
"total": 15196
}
}