• 文档
  • 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

区域信息（Chinese: zh-CN, English: en-US）。

请求参数（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

来源业务 ID 列表。

assigneeIds

可选

List 格式 String

指派人用户 ID 列表。

queryTodo

可选

Boolean

是否查询代办（assigneeIds 以及其所属用户组的任务）。注：assigneeIds 暂时仅支持单个用户的代办。

expectedCompletionDate

可选

String
计划结束日期。时间区间：expectedCompletionDateFrom ~ expectedCompletionDateTo 字段。

  • 关键字：expectedCompletionDate 字段。支持关键字范围：不为空：isNotNull；为空：isNull；已逾期：Expired。

expectedCompletionDateFrom

可选

String

expectedCompletionDate 开始时间。

expectedCompletionDateTo

可选

String

expectedCompletionDate 结束时间。

createUserIds

可选

List 格式 String

创建人用户 ID 列表。

sourceTypes

可选

List 格式 Integer

来源类型列表。

sortName

可选

String

排序字段。支持按以下字段排序： - srNum：编号（默认值） - srStatus：状态 - priority：优先级 - expectedCompletionDate：期望完成日期 - sourceType：来源类型 - createTime：创建时间 - updateTime：更新时间

sortType

可选

String

排序方式。ASC：升序；DESC：降序（默认值）。

keyword

可选

String

搜索关键字。

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

所查询的字段值。

响应参数

名称

数据类型

描述

data

Data 结构体

成功的返回信息。其结构参见 Data 结构体。

Data 结构体

名称

数据类型

描述

pageNo

Integer

页码。

pageSize

Integer

每页条数。

total

Integer

查询到数据量总数。

list

List 格式 ServiceRequest 结构体

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/v1.0/service-request/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": [
      {
        "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
  }
}