Este documento ha sido traducido por IA. Para información precisa, consulte la versión en inglés.
SingleRecordResource
Resource orientado a un único registro: los datos consisten en un objeto individual, permitiendo la obtención por clave primaria, creación/actualización (save) y eliminación. Es adecuado para escenarios de "registro único" como bloques de detalles y formularios. A diferencia de MultiRecordResource, el método getData() de SingleRecordResource devuelve un solo objeto. Usted especifica la clave primaria mediante setFilterByTk(id), y save() llamará automáticamente a create o update basándose en el estado de isNewRecord.
Herencia: FlowResource → APIResource → BaseRecordResource → SingleRecordResource.
Formas de creación: ctx.makeResource('SingleRecordResource') o ctx.initResource('SingleRecordResource'). Debe llamar a setResourceName('nombre_de_la_colección') antes de su uso. Al realizar operaciones por clave primaria, utilice setFilterByTk(id). En RunJS, ctx.api es inyectado por el entorno de ejecución.
Escenarios de uso
Formato de datos
getData()devuelve un objeto de registro único, que corresponde al campodatade la respuesta de la APIget.getMeta()devuelve metainformación (si está disponible).
Nombre del recurso y clave primaria
Estado
Parámetros de solicitud (Filtros / Campos)
CRUD
Configuración y eventos
Ejemplos
Obtención y actualización básica
Crear un nuevo registro
Eliminar un registro
Carga de asociaciones y campos
Recursos de asociación (ej. users.profile)
Guardar sin actualización automática
Escuchar eventos refresh / saved
Notas
- setResourceName es obligatorio: Debe llamar a
setResourceName('nombre_de_la_colección')antes de su uso, de lo contrario no se podrá construir la URL de la solicitud. - filterByTk e isNewRecord: Si no se llama a
setFilterByTk,isNewRecordserátrueyrefresh()no iniciará ninguna solicitud;save()ejecutará una accióncreate. - Recursos de asociación: Cuando el nombre del recurso tiene el formato
padre.hijo(ej.users.profile), debe llamar primero asetSourceId(clave_primaria_padre). - getData devuelve un objeto: El campo
datadevuelto por las API de registro único es un objeto de registro;getData()devuelve este objeto directamente. Se convierte ennulldespués de ejecutardestroy().
Relacionado
- ctx.resource - La instancia del recurso en el contexto actual
- ctx.initResource() - Inicializa y vincula a
ctx.resource - ctx.makeResource() - Crea una nueva instancia de recurso sin vincularla
- APIResource - Recurso de API general solicitado por URL
- MultiRecordResource - Orientado a colecciones/listas, soporta CRUD y paginación

