Put Work Order Details for Events API
This API allows users to update the status and details of work orders for HID events.
Request
PUT /dpss/v1/{{tenant_id}}/{{tenant_code}}/hid/events/status
{
"IssueId": [],
"Status": "Accepted",
"StatusDatetime": "2024-06-15T00:00:12",
"Reason": "Investigating occurrence at premises",
"WorkOrderId": "123456"
}Body Type should be RAW JSON
{
"IssueId":[19865],
"Status":"Active",
"StatusDateTime":"2024-12-31T05:46:14.265Z",
"Reason":"TeststatusAPI_Test",
"WorkOrderID":"12345"
}Response
The request will return a JSON response as shown in the following example:
{
"success": true
}Parameters
|
Name |
Description |
Operators |
Required |
Type |
Format |
Default |
Range |
Origination |
|---|---|---|---|---|---|---|---|---|
|
IssueId |
The unique identifier for the alarm |
In list |
Yes |
Integer |
N/A |
N/A |
N/A |
App platform |
|
WorkOrderId |
The user-entered identifier for the utility work order associated with the alarm |
Equals |
Yes |
String |
N/A |
N/A |
N/A |
External WOS |
|
StatusDatetime |
The date the work order was updated |
Equals |
Yes |
Date time |
YYYY-MM-DDTHH:MM:SSZ |
N/A |
(Current UTC Date) to (Current UTC Date - 13 months) |
External WOS |
|
Status |
The status of the alarm |
Equals |
Yes |
String |
N/A |
N/A |
N/A |
External WOS |
|
Reason |
The technician comments or reason for changing the status of the work order |
Equals |
Yes |
String |
N/A |
N/A |
N/A |
External WOS |