GET /api/v202606/edx/schema

Returns the catalog of tables and columns available to query.

GetSchemaV202606
Each column reports a broad data-type category (string, int, double, decimal, bool, or datetime). This is the same catalog the schema browser and editor auto-complete 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
name string
name string
Example Response application/json 
{  "tables": [
    {    "columns": [
      {      "dataType": "string",      "name": "string"
    }
    ],    "name": "string"
  }
  ]
}