Notas
Escribe una nota en una entidad
Deja un registro en una entidad de la cuenta: por qué se rechazó un pedido, cómo va una reparación.
notes:writeResultado
generado desde el esquema
Anotación del servidor
Una nota con mentionedUserIds avisa a esos usuarios de Filmo.
Con subRelatedDocumentType y subRelatedDocumentId la nota va en una unidad física concreta y no en el artículo entero. mentionedUserIds notifica a esos usuarios de Filmo. Las notas de una entidad se leen con GET /api.
Argumentos
Texto de la nota.
Límites: longitud mín. 1
Cuando la nota se refiere a una unidad física concreta del artículo.
Identificador de esa unidad física. Requiere subRelatedDocumentType.
Código de la unidad, para poder leerlo en la nota sin resolver el id.
Usuarios de Filmo a notificar. Cada uno recibe una notificación.
Clave de idempotencia elegida por el cliente (se recomienda un UUID). Repetir la misma clave con los mismos argumentos en 24 h devuelve la respuesta almacenada sin volver a ejecutar; con argumentos distintos responde 422. Es la forma segura de reintentar tras un fallo de red.
Límites: longitud mín. 1, longitud máx. 255
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 nota.
Texto de la nota.
Tipo de la subentidad; null si no aplica.
Identificador de la subentidad; null si no aplica.
Código legible de la subentidad; null si no aplica.
Fecha de creación en ISO 8601 UTC.
Fecha de la última modificación en ISO 8601 UTC.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
Prompts de ejemplo
Deja una nota en este pedido diciendo que el cliente recogerá en la puerta norte.
La misma operación por REST
Esta herramienta ejecuta POST /api/v1/notes.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasNotas
Escribe una nota en una entidad
Deja un registro en una entidad de la cuenta: por qué se rechazó un pedido, cómo va una reparación.
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?