Get Work Order Details for High Impedance Events API

This API fetches and delivers work order details for HID events to a customer's data lake/business system.

This is used to request a large data file in the format of your choice (Apache Parquet, ORC, JSON, CSV) for downloading when the request can take several minutes to complete.

Data product ID. 82624588-c005-4cbb-bc7d-420a2332f1ef
Data latency. Three minutes or greater, depending on query parameters.
Maximum result size. Millions.
Data availability. Last 13 months.

Request

Copy

POST /dpss/api/v1/subscriptions/{{subscriptionid}}/batch-request
Host: k8s.itrontotal.com
Authorization: Bearer {{AccessToken}}
Itron-CorrelationId: {{correlationid}}
DataSubscriberId: {{subscriberid}}
Content-Type: application/json

{
    "filetype": "csv",
    "tokens": {
        "StatusDatetime": "2024-01-01",
        "WorkOrderId": "123456"
    },
    "isOhsRequest": false
}

Response

Copy

ServicePointId,Phase,IssueID,Status,StatusDatetime,Reason,EventDate,WorkOrderId,
,,Accepted,2024-06-15:00:00:13,Investigating premises,2024-06-13,123456,9000053409,1,
,,New,2024-08-04:00:00:13,Gathering data,2024-08-03,78910212,9000053408,2,

Get Synchronous request and response examples

This is used to request a smaller data set 'on demand' with very low latency.

Data latency. 1-5 seconds.
Maximum result size. 1,000 rows.
Data availability. Last 13 months.

Request

Copy

POST /dpss/api/v1/subscriptions/{{subscriptionid}}/on-demand
Host: k8s.itrontotal.com
Authorization: Bearer {{AccessToken}}
Itron-CorrelationId: 5e08ab90-b77e-4b8e-9b12-5874be4dbc02
DataSubscriberId: {{subscriberid}}
Content-Type: application/json

{
    "StatusDatetime": "2024-07-01T00:00:00Z",
    "WorkOrderId": "123456"
    ]
}

Response

Copy

[
    {
        "ServicePointId": "9000372474",
        "Phase": "1",
        "Issueid": {},
        "Status": "Accepted",
        "StatusDatetime": "2024-06-15T00:00:12",
        "Reason": "Investigating occurence at premises",
        "EventDate": "2024-06-13",
        "WorkOrderId": "123456",  
    }
]

Parameters

Table 21
Name	Description	Operators	Required	Type	Format	Default	Range	Origination
IssueId	The unique identifier for the HID alarm	Equals	No	String	N/A	N/A	N/A	App Platform
Status	The status of the HID alarm	Equals	No	String	N/A	N/A	N/A	App Platform
StatusDatetime	The date the work order was updated	Equals	No	Date time	YYYY-MM-DDTHH:MM:SSZ	N/A	(Current UTC Date) to (Current UTC Date - 13 months)	App Platform
Reason	The technician comments or reason for changing the status of the work order	Equals or contains	No	String	N/A	N/A	N/A	App Platform
WorkOrderId	The user-entered identifier for the utility work order associated with the HID alarm	In list	No	String	N/A	N/A	N/A	App Platform

Data values

Table 22
Name	Description	Type	Units	Range	Format	Nullable	Origination
ServicePointId	Service Point ID as of EventDate	String	N/A	N/A	N/A	No	CIS MDMS GIS
Phase	Phase/meter leg	Integer	N/A	1 to 4	N	No	App Platform
IssueId	The unique identifier for the HID alarm	String	N/A	N/A	N/A	No	App Platform
Status	The status of the HID alarm	String	N/A	N/A	N/A	No	App Platform
StatusDatetime	The date the work order was updated	Date time	N/A	N/A	YYYY-MM-DDTHH:MM:SSZ	No	App Platform
Reason	The technician comments or reason for changing the status of the work order	String	N/A	N/A	N/A	No	App Platform
EventDate	UTC day for which the statistics have been collected	Date	N/A	N/A	YYYY-MM-DD	No	Edge app
WorkOrderId	The user-entered identifier for the utility work order associated with the HID alarm	String	N/A	N/A	N/A	No	App Platform