• 文档
  • Get Service Request List

Get Service Request List

获取服务请求列表。

请求格式

POST https://{apigw-address}/work-management/v1.0/s-taskmgmtds/cmms/service-request/list

请求参数（URI）

名称

位置（Path/Query）

必需/可选

数据类型

描述

locale

Query

可选

String

指定以哪种语言返回服务请求查询结果。例如，若需以中文语言返回，需赋值 zh-CN。默认以英文语言返回，故该参数默认赋值为 en-US. 更多语言支持，见 EnOS支持的locale >>

请求参数（Body）

名称

必需/可选

数据类型

描述

startTime

必需

String

工单开始时间，格式：yyyy-MM-dd HH:mm:ss。

endTime

必需

String

工单结束时间，格式：yyyy-MM-dd HH:mm:ss。

siteIds

必需

List 格式 String

场站 ID 列表。

srStatus

可选

List 格式 Integer

状态码。

priority

可选

List 格式 String

服务请求优先级。您可以按照如下方式赋值：

  • 1：高

  • 2：正常

  • 3：低

  • 4：未指定

assigneeIds

可选

List 格式 String

指派人用户 ID 列表。

queryTodo

可选

Boolean

指定是否需要基于 assigneeIds 参数查询待办任务信息。 true 代表需要， false 代表不需要。默认赋值 false. 注：如需查询待办任务信息，需确保对 assigneeIds 参数赋值，且仅支持赋值填写1个用户ID。

expectedCompletionDate

可选

String

该字段用以指定针对任务计划完成日期的筛选条件。您可以按照如下方式赋值：

  • isNotNull: 查询结果会返回计划完成日期不为空的工单。

  • isNull: 查询结果会返回计划完成日期为空的工单。

  • Expired: 查询结果会返回已过期的工单。

expectedCompletionDateFrom

可选

String

expectedCompletionDate 开始时间。需要与 expectedCompletionDateTo 一起使用。

expectedCompletionDateTo

可选

String

expectedCompletionDate 结束时间。需要与 expectedCompletionDateFrom 一起使用。

createUserIds

可选

List 格式 String

创建人用户 ID 列表。

sourceTypes

可选

List 格式 Integer

来源类型列表。

sortName

可选

String

排序字段。支持按以下字段排序：

  • srNum：服务请求编号

  • srStatus：状态

  • priority：优先级

  • expectedCompletionDate：期望完成日期

  • sourceType：来源类型

  • createTime：创建时间

  • updateTime：更新时间

默认按服务请求编号排序。

sortType

可选

String

排序方式。支持以下赋值：

  • ASC：升序

  • DESC: 降序

默认按照降序排列。

keyword

可选

String

搜索关键字，只能输入一个字段。模糊匹配的字段：title、description、srNum、srId、sourceId。

customizedParam

可选

List 格式 Param 结构体

搜索关键字，可多个条件查询。 示例：[{“key”: “subType”,”value”: “缺陷”},{“key”: “subType”,”value”: “故障”}]。结构参见 Param 结构体。 注：可前往工作管理的 设置 > 工单设置 菜单中配置自定义字段。

startTimeFrom

可选

String

针对工单开始时间进行筛选所设置的起始时间点。

startTimeTo

可选

String

针对工单开始时间进行筛选所设置的截止时间点。

endTimeFrom

可选

String

针对工单结束时间进行筛选所设置的起始时间点。

endTimeTo

可选

String

针对工单结束时间进行筛选所设置的截止时间点。

pageNo

可选

Integer

第几页。默认值：1。

pageSize

可选

Integer

每页条数。默认值：50，最大值：1000。

Param 结构体

名称

数据类型

描述

key

String

自定义字段标识符。

value

String

所查询的字段值。

响应参数

名称

数据类型

描述

pageNo

Integer

页码。

pageSize

Integer

每页条数。

total

Integer

查询到数据量总数。

list

ServiceRequest 结构体

服务请求列表，其结构参见 ServiceRequest 结构体。

ServiceRequest 结构体

名称

数据类型

描述

orgId

String

组织 ID。

srId

String

服务请求 ID。

srNum

String

服务请求编号。

title

String

服务请求标题。

description

String

服务请求描述。

srStatus

Integer

服务请求状态码。

siteId

String

场站 ID。

siteName

String

场站名称。

priority

Integer

服务请求优先级。

assigneeName

String

指派人名称。

assigneeId

String

指派人 ID。

assignee

User 结构体

指派人。其结构参见 User 结构体。

createUserId

String

创建人 ID。

createUser

String

创建人名称。

createTime

String

票单创建时间。

createLocalTime

String

票单本地创建时间。

updateUserId

String

票单更新人 ID。

updateUser

String

票单更新人名称。

updateTime

String

票单更新时间。

sourceType

Integer

来源类型。该接口接受枚举值。1：告警；2：预警；3：运维建议；4：手工；5：停机记录；6：运维计划（内部保留值）；7：服务请求（内部保留值）。

expectedCompletionDate

String

期望完成日期。

customizedParam

List 格式 Param 结构体

自定义字段。其结构参见 Param 结构体。

timezone

String

场站时区。

deviceId

String

设备 ID 列表。

relatedIssue

Integer

关联票单数量。

actualCause

String

实际原因。

completionNote

String

票单完成信息。

expired

Boolean

是否逾期。

remainingTime

String

票单剩余时间（ms）。

estimateEffort

Integer

票单预估工时。

processInstanceId

String

流程 ID。

requestType

Integer

请求类型。

User 结构体

名称

数据类型

描述

userId

String

用户 ID。

username

String

用户名称。

错误码

名称

描述

96134

场站 ID 无效。

96146

自定义字段 key 不支持筛选，请检查配置或更改参数。

示例

请求示例

url: https://{apigw-address}/work-management-cmms/v1.0/s-taskmgmtds/cmms/service-request/list
method: POST
Header:
   authorization: Bearer your_token
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": [
      {
        "id": id,
        "orgId": "orgId",
        "srId": "srId",
        "srNum": "srNum",
        "title": "test jimmy",
        "description": "description",
        "srStatus": 30,
        "siteId": "siteId",
        "siteName": "siteName",
        "priority": 4,
        "assigneeName": "assigneeName",
        "assigneeId": "assigneeId",
        "assignee": {
          "userId": "userId",
          "username": "username"
        },
        "createUserId": "createUserId",
        "createUser": "createUser",
        "createTime": "2022-05-18 15:47:08",
        "createLocalTime": "2022-05-18 15:47:08",
        "updateUserId": "updateUserId",
        "updateUser": "updateUser",
        "updateTime": "2022-05-25 10:31:23",
        "sourceType": 4,
        "expectedCompletionDate": "2022-05-19",
        "customizedParam": [
          {
            "key": "key",
            "value": "value",
            "label": null,
            "section": null,
            "displayOrder": null
          }
        ],
        "timezone": "+08:00",
        "status": 1,
        "deviceId": "deviceId1,deviceId2",
        "relatedIssue": 2,
        "note": "",
        "actualCause": "reason test",
        "completionNote": "note test",
        "expired": true,
        "remainingTime": "0",
        "estimateEffort": 8,
        "processInstanceId": "processInstanceId",
        "requestType": 1
      }
    ],
    "pageNo": 1,
    "pageSize": 1,
    "total": 14488
  }
}