Notas

Listar las notas de una entidad

Devuelve las notas adjuntas a UNA entidad de la cuenta, las más recientes primero.

Herramienta
filmo_notes_list
Acceso: Lectura
  • notes:read
  • 120/min
  • Anotación del servidor: Solo lectura
  • Anotación del servidor: Idempotente

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_notes_list",
    "arguments": {
      "relatedDocumentType": "item",
      "relatedDocumentId": "rela_8f2a1c",
      "limit": 20
    }
  }
}

generado desde el esquema

relatedDocumentType y relatedDocumentId son obligatorios —no hay un listado de todas las notas— y la entidad debe pertenecer a la cuenta: de lo contrario responde 404 sin leer nada.

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: createdAt, updatedAt. Por defecto, "-createdAt". 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

relatedDocumentTypestringObligatorio

Tipo de la entidad cuyas notas se listan. Obligatorio.

Opciones disponibles: item, contact, order, space, kit, vehicle, staff, service, collection, project, repairTicket, purchaseOrder, supplierInvoice

relatedDocumentIdstringObligatorio

Identificador de esa entidad. Obligatorio; debe pertenecer a la cuenta.

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

contentstring

Texto de la nota.

relatedDocumentTypestring | null

Tipo de la entidad a la que está adjunta la nota; null si no está adjunta.

relatedDocumentIdstring | null

Identificador de esa entidad; null si la nota no está asociada.

subRelatedDocumentTypestring | null

Tipo de la subentidad; null si no aplica.

subRelatedDocumentIdstring | null

Identificador de la subentidad; null si no aplica.

subRelatedDocumentCodestring | null

Código legible de la subentidad; null si no aplica.

createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

updatedAtstring<date-time>

Fecha de la última modificación en ISO 8601 UTC.

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/notes.

  • Notas

    Listar las notas de una entidad

    Devuelve las notas adjuntas a UNA entidad de la cuenta, las más recientes primero.

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