Get Transformer Connectivity Discrepancies API (deprecated)
This API fetches and delivers transformer connectivity discrepancies to a customer's data lake/business system. It can be used for the following use cases:
-
GIS operators receive daily update of connectivity data. Some connections may be automatically updated, some may be further validated automatically by utility back-office systems or manually by utility.
Used to request a large data file in the format of your choice (Parquet, Orc, Json, CSV) for downloading when the request can take several minutes to complete.
-
Data product ID. 328070b5-f0d8-4b06-9ee2-0d9d80e7a451
-
Data latency. Three minutes or greater, depending on query parameters.
-
Maximum result size. Millions.
-
Data availability. Last 13 months.
Request
POST /data-products/328070b5-f0d8-4b06-9ee2-0d9d80e7a451/subscriptions/{subscriptionId}/batch-request
{
"FileType": "Csv",
"Tokens":
{
"StartRecievedDatetime": "2023-1-1",
"EndRecievedDatetime": "2023-1-31",
}
}
Response
XfmrDiscrepancyId,ReceivedTime,DiscoverDate,TransformerGroupId,AutoUpdate,RecommendedMvEquipId,MvEquipmentId,TransformerId,Action,ActionTime,SuppressOrIgnore,EndSuppressionTime,FeederOrBank
584,2023-09-13T00:29:55.55Z,9/13/2023,808,TRUE,LRL23,KNY901,4929542183-90777887,Pending,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
364,2023-09-13T00:29:55.55Z,9/14/2023,253,TRUE,VTG272,XKR673,2594744147-91918635,Pending,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
716,2023-09-13T00:29:55.55Z,9/15/2023,523,TRUE,CZM77,OPJ542,2594744147-91918635,Accept,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
898,2023-09-13T00:29:55.55Z,9/16/2023,355,TRUE,FVT647,YOU145,2662535221-10734063,Accept,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Bank
658,2023-09-13T00:29:55.55Z,9/17/2023,457,TRUE,XLQ562,XDD764,2949637457-92808645,Pending,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
269,2023-09-13T00:29:55.55Z,9/18/2023,988,TRUE,YQC206,LME477,2435841314-92195447,Ignore,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
944,2023-09-13T00:29:55.55Z,9/19/2023,251,TRUE,JWB570,KID811,4495046038-10795431,Pending,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
576,2023-09-13T00:29:55.55Z,9/20/2023,478,TRUE,QVM264,SHM373,2604141857-10581404,Pending,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Bank
891,2023-09-13T00:29:55.55Z,9/21/2023,950,FALSE,KAW321,WAN304,2768938379-10477102,Suppress,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
788,2023-09-13T00:29:55.55Z,9/22/2023,251,TRUE,BKK744,KSG83,2302540356-10169202,Pending,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
477,2023-09-13T00:29:55.55Z,9/23/2023,594,TRUE,BKJ352,GAQ484,3393042722-93886808,Pending,2023-09-13T00:29:55.55Z,Suppress,2023-09-13T00:29:55.55Z,Feeder
719,2023-09-13T00:29:55.55Z,9/24/2023,673,TRUE,MXH759,WXO742,3393042722-93886808,Accept,2023-09-13T00:29:55.55Z,Ignore,2023-09-13T00:29:55.55Z,Feeder
Parameters
|
Name |
Description |
Operators |
Required |
Type |
Format |
Default |
Range |
Origination |
|---|---|---|---|---|---|---|---|---|
|
DiscoveryDateStart |
API returns all meter connectivity recommendations from this to Range End |
Greater than or equal to |
No |
Date |
YYYY-MM-DD |
2020-01-01 |
(Current UTC Date - 13 mo.) to (Current UTC Date) |
Edge app |
|
DiscoveryDateEnd |
API returns all meter connectivity recommendations from Range Start through to this |
Less than or equal to |
No |
Date |
YYYY-MM-DD |
9999-12-31 |
(Current UTC Date - 13 mo.) to (Current UTC Date |
Edge app |
|
StartReceivedDatetime |
Min ReceivedTime data |
Greater than or equal to |
No |
Date time |
YYYY-MM-DDTHH:MM:SSZ |
2020-01-01T00:00:00.0Z |
(Current UTC Date) to (Current UTC Date - 13 months) |
App Platform |
|
EndReceivedDatetime |
Max ReceivedTime data |
Less than or equal to |
No |
Date time |
YYYY-MM-DDTHH:MM:SSZ |
9999-12-31T00:00:00.0Z |
(Current UTC Date) to (Current UTC Date - 13 months) |
App Platform |
|
Action |
Include only recommendations with Action = Accept, Pending, Ignore, Suppress (null = all) |
In list |
No |
N/A |
N/A |
N/A |
N/A |
Edge app |
|
MVEquipmentType |
Include recommendations for transformers with feeder and/or substation bank discrepancies (null = both) |
In list |
No |
N/A |
N/A |
N/A |
N/A |
Edge app |
Data values
|
Name |
Description |
Type |
Units |
Range |
Format |
Nullable |
Origination |
|---|---|---|---|---|---|---|---|
|
XfmrDiscrepancyId |
Unique identifier of the transformer discrepancy |
String |
N/A |
N/A |
N/A |
No |
Edge app |
|
ReceivedTime |
When the data was received by the App Platform |
Date time |
N/A |
N/A |
YYYY-MM-DDTHH:MM:SSZ |
No |
App Platform |
|
DiscoverDate |
Date this relationship was discovered |
Date |
N/A |
N/A |
YYYY-MM-DD |
No |
App Platform |
|
TransformerGroupId |
transformer identifier created by DI |
Integer |
N/A |
N/A |
N |
No |
CIS MDMS GIS |
|
AutoUpdate |
Action was performed via AutoUpdate (vs. manual in UI) true/false |
Boolean |
N/A |
null, true, false |
TRUE, FALSE |
No |
App Platform |
|
RecommendedMvEquipId |
Connected feeder or bank as determined by DI analysis |
String |
N/A |
N/A |
N/A |
No |
App Platform |
|
MvEquipmentId |
Previously connected feeder or substation bank |
String |
N/A |
N/A |
N/A |
Yes |
App Platform |
|
TransformerId |
Transformer ID as of EventDate |
String |
N/A |
N/A |
N/A |
Yes |
CIS MDMS GIS |
|
Action |
Accept, Pending, Ignore, Supress |
String |
N/A |
Accept, Pending, Ignore, Suppress |
N/A |
No |
App Platform |
|
ActionTime |
Date time action was assigned in DI app. Could be automatic or manual (user can tell from AutoUpdate flag). |
Date time |
N/A |
N/A |
YYYY-MM-DDTHH:MM:SSZ |
No |
App Platform |
|
SuppressOrIgnore |
Indicates if Rejected update is suppressed for a limited duration or ignored indefinitely |
String |
N/A |
Suppress, Ignore |
N/A |
Yes |
App Platform |
|
EndSuppressionTime |
Date time updates for this SP will no longer be suppressed |
Date time |
N/A |
N/A |
YYYY-MM-DDTHH:MM:SSZ |
Yes |
App Platform |
|
FeederOrBank |
Indication whether association is to Feeder or Substation Bank |
String |
N/A |
Feeder, Bank |
N/A |
Yes |
App Platform |