Paginación, filtros y orden
Los listados que usan BaseControllerHelper::index aceptan los mismos parámetros de consulta. Cada modelo puede limitar cuáles campos se pueden ordenar o filtrar; esa información está en la página Resumen de cada modelo.
Paginación
Sección titulada «Paginación»| Parámetro | Descripción |
|---|---|
per_page |
Registros por página. Por defecto, 20. |
page |
Número de página. |
La respuesta usa la estructura estándar del paginador de Laravel: data con los registros y, junto a él, current_page, per_page, total, last_page y los enlaces de página.
Búsqueda y estado
Sección titulada «Búsqueda y estado»| Parámetro | Descripción |
|---|---|
search |
Texto a buscar. Los campos buscables dependen del modelo. |
status |
Solo registros con ese estado. |
not_status |
Excluye registros con ese estado. |
trashed |
Incluye los registros eliminados (soft delete). |
only_trashed |
Solo los registros eliminados. |
ids |
Solo los registros con esos identificadores. |
not_ids |
Excluye esos identificadores. |
Filtros por campo
Sección titulada «Filtros por campo»filters=campo:valor,otro_campo:valorCada par filtra por igualdad. Por defecto solo se aceptan campos que terminan en _id y que son rellenables en el modelo (por ejemplo cashbox_id). Un modelo puede definir su propia lista de campos filtrables. Los campos no permitidos se ignoran sin error.
Rangos de fechas
Sección titulada «Rangos de fechas»| Parámetros | Campo |
|---|---|
created_at_from, created_at_to |
Fecha de creación. |
updated_at_from, updated_at_to |
Fecha de modificación. |
order=campo|ASCorder=campo|ASC,otro_campo|DESCSe ordena por uno o varios campos separados por coma, cada uno con ASC o DESC. Solo se aceptan los campos permitidos del modelo; si el campo no es válido, se ordena por id descendente. Un campo con punto (relacion.campo) ordena por un campo de una relación.
Relaciones y campos
Sección titulada «Relaciones y campos»| Parámetro | Descripción |
|---|---|
relations |
Relaciones a cargar, separadas por coma. |
count_relations |
Relaciones de las que se devuelve el conteo. Solo las permitidas por el modelo. |
select_fields |
Limita los campos devueltos. |
