Get Model Descriptions
Get all models and their structure
GET https://YOUR_JET_BRIDGE_HOSTNAME/jet_api/model_descriptions/
Headers
[
{
// Unique model name
"model": "core_country",
// Table name used for SQL Charts suggestions
"db_table": "core_country",
// Display name
"verbose_name": "country",
// Display name in plural
"verbose_name_plural": "countries",
// Hide by default in menu
"hidden": false,
// (optional) Field used as primary key ("id" by default)
"primary_key_field": "id",
"fields": [
{
// Unique field name
"name": "id",
// Column name used for SQL Charts suggestions
"db_column": "id",
// Display name
"verbose_name": "ID",
// Field type used for determine default display, possible filters, serialization and deserialization
// Read Model Field Types for possible values
"field": "IntegerField",
// Is required
"required": false,
// Can be null
"null": false,
// Can be edited
"editable": true,
// Can be filtered
"filterable": true,
// Optional paramters for this Field Type
// Read Model Field Types for possible values
"params": {}
},
{
"name": "unique_name",
"db_column": "unique_name",
"verbose_name": "unique name",
"is_relation": false,
"field": "CharField",
"required": true,
"null": false,
"editable": true,
"filterable": true,
"params": {}
},
{
"name": "name",
"db_column": "name",
"verbose_name": "name",
"is_relation": false,
"field": "CharField",
"required": false,
"null": false,
"editable": true,
"filterable": true,
"params": {}
},
{
"name": "alpha_3",
"db_column": "alpha_3",
"verbose_name": "alpha 3",
"is_relation": false,
"field": "CharField",
"required": true,
"null": false,
"editable": true,
"filterable": true,
"params": {}
},
{
"name": "continent",
"db_column": "continent",
"verbose_name": "continent",
"is_relation": false,
"field": "ForeignKey",
"required": false,
"null": true,
"editable": true,
"filterable": false,
"params": {
"related_model": "core_continent"
}
},
{
"name": "order",
"db_column": "order",
"verbose_name": "order",
"is_relation": false,
"field": "PositiveIntegerField",
"required": false,
"null": false,
"editable": true,
"filterable": true,
"params": {}
}
]
}
]Last updated