Ir al contenido

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.

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.

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.
filters=campo:valor,otro_campo:valor

Cada 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.

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|ASC
order=campo|ASC,otro_campo|DESC

Se 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.

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.