Get Service Request Details¶
Get service request details.
Request Format¶
POST https://{apigw-address}/work-management/v1.0/s-taskmgmtds/cmms/service-request/detail
Request Parameters (URI)¶
Name | Location (Path/Query) | Mandatory/Optional | Data Type | Description |
---|---|---|---|---|
srId | Query | Mandatory | String | The service request ID to query |
Request Parameters (Header)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
authorization | Mandatory | String | User Token information obtained from the Application Portal |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | Data Struct | The return message. For more information about Data Struct, see Data Struct. |
Data Struct¶
Name | Data Type | Description |
---|---|---|
orgId | String | OU ID |
srId | String | Service Request ID |
srNum | String | Service Request Number |
title | String | Service Request Title |
description | String | Service Request Description |
srStatus | Integer | Service Request Status Code |
siteId | String | Site ID |
siteName | String | Site Name |
rootModelId | String | Site Model |
priority | Integer | Service Request Priority |
assigneeName | String | Assignee Name |
assigneeId | String | Assignee ID |
assignee | User Struct | Assignee. For more information about User Struct, see User Struct. |
createUserId | String | Creator ID |
createUser | String | Creator Name |
createTime | String | Ticket Creation Time |
createLocalTime | String | Ticket Creation Local Time |
updateUserId | String | Ticket Updater ID |
updateUser | String | Ticket Updater Name |
updateTime | String | Ticket Update Time |
sourceType | Integer | Source type. This API accepts enumerated values. 1: Alert; 2: Alarm; 3: O&M Recommendation; 4: Manual; 5: Downtime Record; 6: O&M Plan (internal reserved value); 7: Service Request (internal reserved value). |
expectedCompletionDate | String | Expected Completion Date |
customizedParam | List of Param Struct | Custom Field. For more information about Param Struct, see Param Struct. |
timezone | String | Site Time Zone |
deviceId | String | Device ID list, separated by commas (,) |
fileIds | List of String | File ID List |
files | List of File Struct | File information list. For more information about File Struct, see File Struct. |
relatedIssue | Integer | Number of associated ticket |
actualCause | String | Actual Cause |
completionNote | String | Ticket Completion Note |
expired | Boolean | Whether the ticket is overdue |
remainingTime | String | Ticket remaining time (ms) |
estimateEffort | Integer | Estimated work hours for ticket |
processInstanceId | String | Process ID |
requestType | Integer | Request Type |
User Struct¶
Name | Data Type | Description |
---|---|---|
userId | String | User ID |
username | String | User Name |
Param Struct¶
Name | Data Type | Description |
---|---|---|
key | String | Custom field identifier, required to be registered in the Work Management Form. |
value | String | The value of the queried field. |
File Struct¶
Name | Data Type | Description |
---|---|---|
fileId | String | File ID |
fileName | String | File Name |
fileSize | Long | File Size |
fileUrl | String | File URL |
createUser | String | File Creator |
createTime | String | File Creation Time |
Error Codes¶
Code | Description |
---|---|
96134 | Invalid site ID |
96146 | The custom field key does not support filtering, please check the configuration or change the parameter. |
Samples¶
Request Sample¶
url: https://{apigw-address}/work-management/v1.0/s-taskmgmtds/cmms/service-request/detail
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":""
}
Response Sample¶
{
"code": 0,
"data": {
"orgId": "orgId",
"srId": "srId",
"srNum": "srNum",
"title": "test jimmy",
"description": "description",
"srStatus": 30,
"siteId": "siteId",
"siteName": "siteName",
"rootModelId": "rootModelId",
"priority": 4,
"assigneeName": "assigneeName",
"assigneeId": "assigneeId",
"assignee": {
"userId": "assigneeId",
"username": "assigneeName"
},
"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",
"fileIds": [
"fileId1",
"fileId2"
],
"files": [
{
"taskId": "taskId",
"taskNum": "taskNum",
"fileId": "fileId",
"fileName": "fileName.jpeg",
"fileUrl": "fileUrl",
"createTime": "2022-05-19 16:37:19",
"fileSize": 3700,
"createUser": "createUser"
}
],
"relatedIssue": 2,
"note": "",
"actualCause": "reason test",
"completionNote": "note test",
"remainingTime": "-1",
"estimateEffort": 8,
"processInstanceId": "processInstanceId",
"currentTask": "Close Service Request",
"taskId": "taskId",
"processStatus": 1,
"requestType": 1
}
}