Get Work Order Details

Get work order details.

Request Format

POST https://{apigw-address}/work-management/v1.0/s-taskmgmtds/cmms/work-order/detail

Request Parameters (URI)

Name

Location (Path/Query)

Mandatory/Optional

Data Type

Description

woId

Query

Mandatory

String

The work order 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

woId

String

Work Order ID

woNum

String

Work Order Number

templateKey

String

Template Keyword

templateValue

String

Template Value

title

String

Work Order Title

description

String

Work Order Description

woStatus

Integer

Work Order Status Code

priority

Integer

Work Order Priority

siteId

String

Site ID

deviceId

String

Device ID list, separated by commas (,)

siteName

String

Site Name

assigneeName

String

Assignee Name

assigneeId

String

Assignee ID

workType

Integer

Work Order Type

createUser

String

Creator Name

createTime

String

Work Order Creation Time

updateUser

String

Work Order Updater Name

updateTime

String

Work Order Update Time

plannedStartTime

String

Planned Start Time

plannedEndTime

String

Planned End Time

actualStartTime

String

Actual Start Time

actualEndTime

String

Actual End Time

relatedIssue

Integer

Number of associated records

relatedDowntime

Integer

Number of associated downtime records

tags

List of String

User-defined tag list

processStatus

Integer

Task Status. 1: The process is in progress and the task can be submitted; 0: The process has ended and the task cannot be submitted.

files

List of File Struct

File information list. For more information about File Struct, see File Struct.

followers

List of User Struct

Followers. For more information about User Struct, see User Struct.

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

User Struct

Name

Data Type

Description

userId

String

User ID

username

String

User Name

Samples

Request Sample

url: https://{apigw-address}/work-management/v1.0/work-order/detail
method: POST
requestBody:

Response Sample

{
    "code": 0,
    "data": {
        "woId": "id1",
        "woNum": "0001",
        "templateKey":"field1",
        "templateValue":"value1",
        "title": "yourTitle",
        "description": "des",
        "woStatus": 1,
        "priority": 1,
        "siteId": "siteId",
        "deviceId": "id1,id2,id4",
        "siteName": "site1",
        "assigneeName": "san.zhang",
        "assigneeId": "0123456",
        "workType": "PM",
        "createUser": "wu.wang",
        "createTime": "2020-04-22 17:00:00",
        "updateUser": "wu.wang",
        "updateTime": "2020-04-22 17:00:00",
        "plannedStartTime": "2020-04-22 17:00:00",
        "plannedEndTime": "2020-04-22 17:00:00",
        "actualStartTime": "2020-04-22 17:00:00",
        "actualEndTime": "2020-04-22 17:00:00",
        "relatedIssue": 4,
        "relatedDowntime":1,
        "tags":["tag1", "tag2"],
        "processStatus":1
        "files": [
            {
                "fileId": "uuid",
                "fileName": "file1.jpg",
                "fileSize": 1627532,
                "fileUrl": "exporturl:
                "createUser": "username"
            },
            ......
        ],
        "followers": [
              {
                 "userId": "uid0004",
                 "username": "username"
              },
              ......
       ]
    }