Referencia

Recurso

Metadata

Estructura e introspección de modelos

2 endpoints · base http://localhost/api/v1

¿Prefieres Postman?Colección·Environment·Cómo usarla
get
/metadata

Listar modelos disponibles

Retorna la lista de modelos habilitados para API con nombre, app, verbose_name y endpoint.

públicohttp://localhost/api/v1/metadata

Respuestas

200Lista de modelos
CampoTipoDescripción
dataobject
data.modelsobject[]
data.models[].modelstring
data.models[].appstring
data.models[].verbose_namestring
data.models[].endpointstring
URL path en snake_case
get
/metadata/{modelo}

Estructura de un modelo

Retorna columnas, relaciones, admin config, capture fields y grid display.

públicohttp://localhost/api/v1/metadata/{modelo}

Parámetros

NombreEnTipoDescripción
modelo*pathstringNombre del modelo en snake_case (ej: moneda, tipo_venta, comprobante)

Respuestas

200Metadata del modelo
CampoTipoDescripción
dataobject
data.modelstring
data.appstring
data.tablestring
data.columnsobject
data.relationsobject
data.adminobject
data.captureobject
data.gridobject
400Modelo no encontrado o no habilitado
CampoTipoDescripción
datanull
metaobject
errorsobject[]
errors[].codestring
errors[].messagestring
errors[].fieldstring