Para: Administradores
Agregue notas a los casos con una clave central
Crea notas internas sobre un caso desde tu propio software, asígnales un documento y archivos, y elige qué roles pueden verlas.
En este artículo7 secciones
Antes de empezar
Esta página trata sobre cómo agregar y leer los datos de un caso. NotasNotas Notas internas sobre un caso que solo pueden ver las personas cuyo rol lo permite; los clientes no pueden verlas a menos que la firma cambie eso. Con una clave de concentración. Los caminos están bajo… https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Llamadas
| Llamar | Lo que hace |
|---|---|
GET /notes/templates | Lista de los plantillas de notas que tienes. |
POST /notes | Se crea una nota. |
GET /notes | Lista las notas relacionadas con el caso, empezando por las más recientes. |
GET /notes/<note_id> | Lee una nota. |
PUT /notes/<note_id> | Cambia el título de una nota o quién puede verla. |
DELETE /notes/<note_id> | Se elimina una nota, junto con sus archivos relacionados. |
Una nota es un documento que se guarda en un caso específico, para su equipo, junto con todos los archivos relacionados con él. El contenido de la nota consiste en el propio documento; se puede comenzar desde una plantilla o cargar un archivo PDF o Word una vez que la nota ya esté lista. No hay campos de texto disponibles para la escritura. Nadie recibe notificaciones sobre cuándo se agrega o modifica una nota, y las notas no envían ningún tipo de señales web.
Crear una nota
| Campo | Lo que hace | Requerido | Por defecto |
|---|---|---|---|
name | El título de la nota. Letras, números, espacios y & ' - _ ( ) . /; sin comas, dos puntos, signos de interrogación o guiones. | Sí. | — |
permissions | Los rolesPapel Un conjunto de permisos que determina qué puede ver y hacer una persona en un caso, como por ejemplo, el personal o los clientes. que pueden acceder a ella, como por ejemplo ["role::staff"]. Solo los roles que pueden leer las notas. | No. | Las funciones del plantilla, o todas las funciones que pueden leer las notas. |
template | Desde {"owner": "host", "template_id": "<asset_id>"} hasta GET /notes/templates: para llevar el documento y los archivos del plantilla. O desde {"owner": "case", "template_id": "<note_id>"}: para copiar una nota relacionada con este caso. | No. | Ninguno. |
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/notes \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Case representation letter", "permissions": ["role::staff"], "template": {"owner": "host", "template_id": "note::20260915101500_5e4d3c2b1a0f90"}}'
Responde a 201 con note_id.
- A partir de un modelo, la nota obtiene los datos del documento, los archivos y las funciones asociadas al modelo. Los códigos, como el nombre del cliente, se rellenan una vez que se crea la nota. Los códigos relacionados con quien la creó, como su nombre, toman los detalles del Asistente Virtual, que incluyen el nombre de su empresa. El título de la nota no se copia; se envía
name. - Una copia de una nota sobre este caso también conserva lo que se ha escrito o dibujado en ella, a menos que se envíe
schemapara reemplazar ese contenido. Los códigos se rellenan nuevamente en el momento en que se hace la copia. - Sin un modelo predeterminado, cargue su documento de inmediato: solicite una dirección con
media_group=schemas, cargue un archivo en formato PDF o Word, y adjúntelo conPUT /notes/<note_id>/schema/media. Un archivo en formato Word se convierte en PDF. Una nota contiene un solo documento. Consulte Carga y adjunta archivos utilizando la clave de hub. - Otros archivos, como fotos o grabaciones, deben adjuntarse con
PUT /notes/<note_id>/media.
¿Quién lo ve?
Las personas que ocupan los roles relacionados con las notas pueden abrirlas. El personal, cuyo rol es moderar las notas por defecto, puede ver todas las notas, independientemente de su rol. Los clientes no pueden ver las notas, a menos que un administrador les haya dado acceso a ellas. Para más información, vea ¿Cómo cambiar las funciones de un rol?.
Notas de lectura
GET /notes toma como parámetros limit (por defecto: 20; hasta 1000), start_key, y también las páginas, tal como ocurre en cualquier lista. Una clave lee cada nota del caso. Cada nota contiene lo siguiente:
| Campo | Lo que contiene |
|---|---|
note_id, case_id | Sus identificadores |
name | Su título |
user_id | ¿Quién lo creó? Es la identificación del Asistente Virtual, utilizada para indicar si se trata de una nota importante o si se trata de algo automatizado. |
permissions | Los roles que podrían verlo… Se han excluido aquellos roles que pueden leer las notas. |
schema_media | El media_id de su documento |
media, media_ct | Sus documentos y archivos… ¿Cuántos son? Descargalos, tal como se indica en “Subir y adjuntar archivos utilizando una clave de hub”. |
schema | Lo que la gente escribió o dibujó en el documento, en formato Instant JSON. |
template_id | El modelo del cual se trata es el que sirvió de base para su creación. |
created_on, updated_on | Cuando se realizó y se realizó la última modificación, en UTC. |
GET /notes/templates Lista de las notas que han sido publicadas. PlantillasPlantilla Un formulario, formulario, firma electrónica, nota o tarea reutilizable que se guarda en la biblioteca y se copia en los expedientes., Los más antiguos primero, y cada uno de ellos… asset_id, title, description y permissions.
Modificar y eliminar
PUT /notes/<note_id> toma name y permissions, y solo modifica aquellos valores que usted envíe. Un “key” puede cambiar cualquier nota en el caso. Una lista vacía de permissions es rechazada: por favor, envíe los valores que deben ser visibles en ese caso. Un cuerpo sin ninguno de estos valores también es rechazado.
DELETE /notes/<note_id> elimina todas las notas, junto con sus documentos y archivos relacionados. Nadie es informado de esto.
Si se rechaza una llamada
| Estado | message | Por qué |
|---|---|---|
| 400 | SchemaFieldsException | Se ha perdido o invalidado un campo. Por ejemplo, puede haber comas en name, una lista vacía en permissions, o alguna función que su centro de control no posee. errors indica el nombre del campo. |
| 400 | SchemaFieldsException, con ItemCopyNotAllowedException en template | El plantilla no está publicada, no está disponible para las herramientas automáticas, o sus archivos aún están siendo procesados. |
| 400 | SchemaFieldsException, con NoteRoleCannotReadNotesException en permissions.<n> | Un rollo en permissions no puede leer las notas. |
| 403 | HostModuleDisabledException | Las notas están desactivadas para su centro de control, o escondidas en este caso. |
| 403 | CaseClosedException | El caso está cerrado. |
| 404 | ItemNotFoundException | La nota no existe. |
Para información sobre el cuerpo de error y los demás códigos, vea Como manejar los errores de la API y los códigos de estado.