Returns the catalog of tables and columns available to query.
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
|
|||||||||||||||||||||||||||||||||||||||||||||||
Example Response
{ "tables": [
{ "columns": [
{ "dataType": "string", "description": "string", "displayFormat": "string", "name": "string", "relatedFields": []
}
], "description": "string", "name": "string"
}
]
}