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.

Herramienta
filmo_collections_list
Acceso: Lectura

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_collections_list",
    "arguments": {
      "limit": 20
    }
  }
}

generado desde el esquema

Filtra por lo que agrupan las colecciones (entityType) o por colección padre. Ordenadas por path.

Argumentos

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

sortstring

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

entityTypestring

Filtra por lo que agrupan las colecciones: item, space, vehicle, staff o service.

Opciones disponibles: item, space, vehicle, staff, service

entityTypesstring[]

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

parentIdstring

Filtra por colección padre: solo se devuelven sus hijas directas.

Límites: longitud mín. 1

includeTotalbooleanpredeterminado:false

Ponlo en true para incluir pagination.total, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.

dateFiltersobject

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 hijos
dateFilters.createdobject

Mostrar atributos hijos
dateFilters.created.gtestring

Desde este día o instante, inclusive.

dateFilters.created.ltestring

Hasta este día o instante, inclusive.

dateFilters.created.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.created.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.created.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.updatedobject

Mostrar atributos hijos
dateFilters.updated.gtestring

Desde este día o instante, inclusive.

dateFilters.updated.ltestring

Hasta este día o instante, inclusive.

dateFilters.updated.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.updated.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.updated.onstring

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
idstring

Identificador único de la colección.

namestring

Nombre de la colección.

pathstring

Nombre completo desde la colección de nivel superior, con los niveles unidos por " > ".

entityTypestring

Qué agrupa la colección: item, space, vehicle, staff o service.

Opciones disponibles: item, space, vehicle, staff, service

parentIdstring | null

Identificador de la colección padre; null para una colección de primer nivel.

depthinteger

Niveles por encima: 0 para una colección de primer nivel, 1 para sus hijas, y así sucesivamente.

ordernumber

Orden de visualización entre sus hermanos.

itemCountinteger

Entidades directamente en esta colección, sin contar sus subcolecciones.

createdAtstring<date-time> | null

Fecha de creación en ISO 8601 UTC; null si no consta.

updatedAtstring<date-time> | null

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].text; no hay structuredContent. Consulta Errores.

La misma operación por REST

Esta herramienta ejecuta GET /api/v1/collections.

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

  • 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: true y el problema en el primer bloque de texto. Ramifica por su code.

¿Te ha resultado útil esta página?