GET /api/v202606/edx/schema

Returns the catalog of tables and columns available to query.

GetSchemaV202606
Each column reports a logical data-type category (string, int, double, decimal, currency, billingperiod, bool, or datetime). Currency and billing-period columns compute as decimal and int respectively in KQL, so calculations and comparisons are unaffected; the narrower type only tells clients how to format and label the value. Related fields identify unit codes and display names needed to format a value. This is the same catalog the schema browser and editor use. Requires the Edx feature flag.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Responses

200 The table/column catalog. The request succeeded and the response body contains the requested data.

Response Body Parameters

EdxSchemaV202606
Property Description Type
tables EdxSchemaTableV202606[]
EdxSchemaTableV202606 properties
Property Description Type
columns EdxColumnV202606[]
EdxColumnV202606 properties
Property Description Type
dataType string
description Human-readable description of the column, when documented in the schema. string
displayFormat Optional purely cosmetic rendering variant for columns that share a EnergyCap.DTO.V202606.EdxColumnDto.DataType but are drawn differently. No column declares one today — anything that changed more than rendering became a EnergyCap.DTO.V202606.EdxColumnDto.DataType instead. string
name string
relatedFields Unit fields needed to display this field. EdxRelatedFieldV202606[]
EdxRelatedFieldV202606 properties
Property Description Type
name Name of the related unit field. string
type Display role: unit or unitCode. string
description Human-readable description of what the table represents, when documented. string
name string
Example Response application/json
{  "tables": [
    {    "columns": [
      {      "dataType": "string",      "description": "string",      "displayFormat": "string",      "name": "string",      "relatedFields": []
    }
    ],    "description": "string",    "name": "string"
  }
  ]
}