Get MV Equipment Group Members API

This API fetches and delivers the list of equipment (feeder or substation bank) groups' member transformers 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. c1144eea-cf39-40dd-92ea-8c1ed525a729

  • Data latency. Three minutes or greater, depending on query parameters.

  • Maximum result size. Millions.

  • Data availability. Last 13 months.

Request

Copy 
POST /data-products/c1144eea-cf39-40dd-92ea-8c1ed525a729/subscriptions/{subscriptionId}/batch-request
{
    "filetype": "csv",
    "Tokens": {
        "StartReceivedDatetime": "2023-09-05T00:00:00Z",
        "EndReceivedDatetime": "2023-09-20T00:00:00Z",
        "StartReportDatetime": "2023-09-01",
        "EndReportDatetime": "2023-09-20",
        "MvEquipmentId": "KNY901,XKR673,OPJ542",
    }
}

Response

Copy 
ReceivedTime,ReportTime,MvEquipmentId,MvEquipmentGroupId,TransformerGroupId,TransformerId,CountServicePoints,XfmrLatitude,XfmrLongitude,CentroidFeederDistance,PhaseAngle,PhaseLabel
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,KNY901,59,808,4929542183-90777887,450,-11.5773477,-58.03992627,29.2087385,-60,C
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,XKR673,56,253,2594744147-91918635,410,46.80101392,116.3092734,1.511984665,30,C
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,OPJ542,45,523,2594744147-91918635,238,75.67532295,155.7855714,8.334218535,60,B

Parameters

Table 37  

Name

Description

Operators

Required

Type

Format

Default

Range

Origination

StartReportDatetime

API returns all meter connectivity recommendations from this date/time Range End

Greater than or equal to

No

Datetime

YYYY-MM-DDTHH:MM:SSZ

2020-01-01T00:00:00.0Z

(Current UTC Date - 13 mo.) to (Current UTC Date

Edge app

EndReportDatetime

API returns all meter connectivity recommendations from Range Start through this date/time

Less than or equal to

No

Datetime

YYYY-MM-DDTHH:MM:SSZ

9999-12-31T00:00:00.0Z

(Current UTC Date - 13 mo.) to (Current UTC Date

Edge app

StartReceivedDatetime

Min ReceivedTime data

Greater than or equal to

No

Datetime

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

Datetime

YYYY-MM-DDTHH:MM:SSZ

9999-12-31T00:00:00.0Z

(Current UTC Date) to (Current UTC Date - 13 months)

App Platform

MvGroupId

List of Group IDs to retrieve members for. Use either GroupId or EquipmentId, but not both.

Equals

No

List

N/A

N/A

N/A

App Platform

MvEquipmentId

List of Equipment IDs to retrieve members for. Use either GroupId or EquipmentId, but not both.

Equals

No

List

N/A

N/A

N/A

App Platform

Data values

Table 38  

Name

Description

Type

Units

Range

Format

Nullable

Origination

ReceivedTime

When the data was received by the App Platform

Datetime

N/A

N/A

YYYY-MM-DDTHH:MM:SSZ

No

App Platform

ReportTime

Date the associated children were connected to this group

Datetime

N/A

N/A

YYYY-MM-DDTHH:MM:SSZ

No

Edge app

MvEquipmentId

Equipment (feeder or substation bank) identifier provided by utility via GIS

String

N/A

N/A

N/A

Yes

App Platform

MvEquipmentGroupId

Equipment (feeder or substation bank) identifier created by DI

String

N/A

N/A

N/A

N/A

Edge app

TransformerGroupId

Txfmr identifier created by DI

String

N/A

N/A

N/A

No

CIS

MDMS

GIS

TransformerId

Transformer ID as of EventDate

String

N/A

N/A

N/A

Yes

CIS

MDMS

GIS

CountServicePoints

Count of service points connected to txfmr

Integer

N/A

0 to 10,000

N

No

Edge app

XfmrLatitude

Lattitude of utility txfmr asset provided by GIS

String

N/A

N/A

N/A

Yes

App Platform

XfmrLongitude

Longitude of utility txfmr asset provided by GIS

String

N/A

N/A

N/A

Yes

App Platform

CentroidFeederDistance

Distance, in meters, from the transformer location provided by GIS to equipment (feeder or substation bank) centroid

Real Meters

non-negative

N/A No

App Platform

PhaseAngle

Relative Phase between SPs connected to txfmr and an arbitrarily assigned 0 Phase Angle

Integer

N/A

1 to 4

N

Yes

Edge app

PhaseLabel

Phases of SPs connected to txfmr assigned by DI analysis

Integer

N/A

1 to 4

N

Yes

App Platform