Colecciones
Listar colecciones
Devuelve el árbol por el que se organiza el catálogo como una lista PLANA: cada nodo con su parentId, su path completa y su depth, de modo que el árbol se reconstruye en una sola pasada.
collections:readcollections:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
Filtra por lo que agrupan las colecciones (entityType) o por colección padre. Ordenadas por path.
Argumentos
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: path, name, order, depth, itemCount, createdAt, updatedAt. Por defecto, "path". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.
Límites: longitud máx. 200
Filtra por lo que agrupan las colecciones: item, space, vehicle, staff o service.
Opciones disponibles: item, space, vehicle, staff, service
Filtra por entityType, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Opciones disponibles: item, space, vehicle, staff, service
Límites: mín. 1 elementos, máx. 50 elementos
Filtra por colección padre: solo se devuelven sus hijas directas.
Límites: longitud mín. 1
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, updated.
Mostrar atributos hijosOcultar atributos hijos
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador único de la colección.
Nombre de la colección.
Nombre completo desde la colección de nivel superior, con los niveles unidos por " > ".
Qué agrupa la colección: item, space, vehicle, staff o service.
Opciones disponibles: item, space, vehicle, staff, service
Identificador de la colección padre; null para una colección de primer nivel.
Niveles por encima: 0 para una colección de primer nivel, 1 para sus hijas, y así sucesivamente.
Orden de visualización entre sus hermanos.
Entidades directamente en esta colección, sin contar sus subcolecciones.
Fecha de creación en ISO 8601 UTC; null si no consta.
Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/collections.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasColecciones
Listar colecciones
Devuelve el árbol por el que se organiza el catálogo como una lista PLANA: cada nodo con su
parentId, supathcompleta y sudepth, de modo que el árbol se reconstruye en una sola pasada.Guías
Escrituras seguras
Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.
Guías
Errores
Un error de herramienta es un resultado con
isError: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?