Kintone REST API
Documentos para API REST para la gestión de aplicaciones, registros, archivos y espacios.
Apps
Categoría | API | Método | URL |
---|---|---|---|
Apps | Obtener aplicación | GET | /k/v1/app.json |
Obtener aplicaciones | GET | /k/v1/apps.json | |
Agregar aplicación de vista previa | POST | /k/v1/preview/app.json | |
Deploy | Implementar la configuración de la aplicación | POST | /k/v1/preview/app/deploy.json |
Obtener el estado de implementación de la aplicación | GET | /k/v1/preview/app/deploy.json | |
Campos de formulario | Obtener campos de formulario | GET |
/k/v1/app/form/fields.json /k/v1/preview/app/form/fields.json |
Agregar campos de formulario | POST | /k/v1/preview/app/form/fields.json | |
Actualizar campos de formulario | PUT | /k/v1/preview/app/form/fields.json | |
Eliminar campos de formulario | DELETE | /k/v1/preview/app/form/fields.json | |
Diseño del formulario | Obtener diseño de formulario | GET |
/k/v1/app/form/layout.json /k/v1/preview/app/form/layout.json |
Actualizar el diseño del formulario | PUT | /k/v1/preview/app/form/layout.json | |
Vistas | Obtener vistas | GET |
/k/v1/app/views.json /k/v1/preview/app/views.json |
Actualizar vistas | PUT | /k/v1/preview/app/views.json | |
Ajustes generales | Obtener la configuración general | GET |
/k/v1/app/settings.json /k/v1/preview/app/settings.json |
Actualizar la configuración general | PUT | /k/v1/preview/app/settings.json | |
Gestión de Procesos | Obtener la configuración de gestión de procesos | GET |
/k/v1/app/status.json /k/v1/preview/app/status.json |
Actualizar la configuración de administración de procesos | PUT | /k/v1/preview/app/status.json | |
Customization | Obtener personalización | GET |
/k/v1/app/customize.json /k/v1/preview/app/customize.json |
Personalización de actualizaciones | PUT | /k/v1/preview/app/customize.json | |
Permisos de la aplicación | Obtener permisos de la aplicación | GET |
/k/v1/app/acl.json /k/v1/preview/app/acl.json |
Actualizar permisos de la aplicación | PUT |
/k/v1/app/acl.json /k/v1/preview/app/acl.json |
|
Permisos de registro | Obtener permisos de registro | GET |
/k/v1/record/acl.json /k/v1/preview/record/acl.json |
Actualizar permisos de registro | PUT |
/k/v1/record/acl.json /k/v1/preview/record/acl.json |
|
Permisos de campo | Obtener permisos de campo | GET |
/k/v1/field/acl.json /k/v1/preview/field/acl.json |
Actualizar permisos de campo | PUT |
/k/v1/field/acl.json /k/v1/preview/field/acl.json |
|
Permisos de registro | Evaluar los permisos de registro | GET | /k/v1/records/acl/evaluate.json |
Notificaciones generales | Obtener la configuración general de notificaciones | GET |
/k/v1/app/notifications/general.json /k/v1/preview/app/notifications/general.json |
Actualizar la configuración general de notificaciones | PUT | /k/v1/preview/app/notifications/general.json | |
Notificaciones por registro | Obtener configuración de notificación por registro | GET |
/k/v1/app/notifications/perRecord.json k/v1/preview/app/notifications/perRecord.json |
Configuración de notificación de actualización por registro | PUT | k/v1/preview/app/notifications/perRecord.json | |
Notificaciones de recordatorio | Obtener la configuración de notificaciones de recordatorio | GET |
/k/v1/app/notifications/reminder.json /k/v1/preview/app/notifications/reminder.json |
Actualizar la configuración de notificaciones de recordatorio | PUT | /k/v1/preview/app/notifications/reminder.json | |
Configuración del gráfico | Obtener la configuración del gráfico | GET |
/k/v1/app/reports.json /k/v1/preview/app/reports.json |
Actualizar la configuración de Graph | PUT | /k/v1/preview/app/reports.json | |
Configuración de la acción | Obtener la configuración de la acción | GET |
/k/v1/app/actions.json /k/v1/preview/app/actions.json |
Actualizar la configuración de la acción | PUT | /k/v1/preview/app/actions.json | |
Obtener formulario | Obtener formulario | GET |
/k/v1/form.json /k/v1/preview/form.json |
Aplicación Move | Mover la aplicación al espacio | POST | /k/v1/app/move.json |
Plug-in * | Obtener complementos de aplicaciones | GET | /k/v1/app/plugins.json |
Agregar plug-ins | POST | /k/v1/app/plugins.json | |
Notas de administración | Obtener notas del administrador de la aplicación | GET | /k/v1/app/adminNotes.json |
Actualizar las notas del administrador de la aplicación | PUT | /k/v1/app/adminNotes.json |
* Ciertas API relacionadas con las aplicaciones solo se pueden ejecutar en la configuración del formulario que no se ha aplicado a la aplicación en vivo (es decir, se realizaron cambios en la configuración del formulario pero la aplicación no se ha actualizado), solo en la aplicación en vivo o en ambos.
* La ruta URL en el caso de la configuración que aún no se ha actualizado a la aplicación en vivo es '/k/v1/Vista previa/xxxx.json'. Consulte cada documento individual para obtener más detalles.
Archivo
Categoría | API | Método | URL |
---|---|---|---|
Record | Obtener registro | GET | /k/v1/record.json |
Obtener registros | GET | /k/v1/records.json | |
Agregar registro | POST | /k/v1/record.json | |
Agregar registros | POST | /k/v1/records.json | |
Actualizar registro | PUT | /k/v1/record.json | |
Actualizar registros | PUT | /k/v1/records.json | |
Eliminar registros | DELETE | /k/v1/records.json | |
Cursor | Obtener cursor | GET | /k/v1/records/cursor.json |
Agregar cursor | POST | /k/v1/records/cursor.json | |
Eliminar cursor | DELETE | /k/v1/records/cursor.json | |
Comentarios | Obtener comentarios | GET | /k/v1/record/comments.json |
Agregar comentario | POST | /k/v1/record/comment.json | |
Eliminar comentario | DELETE | /k/v1/record/comment.json | |
Solicitud masiva | Solicitud masiva | POST | /k/v1/bulkRequest.json |
Gestión de Procesos | Estado de actualización | PUT | /k/v1/record/status.json |
Actualizar varios estados | PUT | /k/v1/records/status.json | |
Actualizar personas asignadas | PUT | /k/v1/record/assignees.json |
Archivos
Categoría | API | Método | URL |
---|---|---|---|
File | Descargar archivo | GET | /k/v1/file.json |
Subir archivo | POST | /k/v1/file.json |
Espacios
Categoría | API | Método | URL |
---|---|---|---|
Space | Consigue espacio | GET | /k/v1/space.json |
Añade espacio | POST | /k/v1/template/space.json | |
Actualizar el cuerpo del espacio | PUT | /k/v1/space/body.json | |
Eliminar espacio | DELETE | /k/v1/space.json | |
Miembros del espacio | Obtener miembros del espacio | GET | /k/v1/space/members.json |
Actualizar miembros del espacio | PUT | /k/v1/space/members.json | |
Thread | Agregar comentario de hilo | POST | /k/v1/space/thread/comment.json |
Agregar hilo | POST | /k/v1/space/thread.json | |
Hilo de actualización | PUT | /k/v1/space/thread.json | |
Huéspedes | Agregar invitados | POST | /k/v1/guests.json |
Actualizar a los miembros invitados | PUT | /k/guest/<SpaceID>/v1/space/guests.json | |
Eliminar invitados | DELETE | /k/v1/guests.json |
Plug-in
Categoría | API | Método | URL |
---|---|---|---|
Plug-in * | Obtener plug-ins instalados | GET | /k/v1/plugins.json |
Instalar plug-in | POST | /k/v1/plugin.json | |
Complemento de actualización | PUT | /k/v1/plugin.json | |
Desinstalar plug-in | DELETE | /k/v1/plugin.json | |
Obtener aplicaciones plug-in | GET | /k/v1/plugin/apps.json | |
Obtener los complementos necesarios | GET | /k/v1/plugins/required.json |
API Info
Categoría | API | Método | URL |
---|---|---|---|
Kintone REST API | Obtener la lista de API | GET | /k/v1/apis.json |
Obtener esquema de API | GET | /k/v1/apis/*.json |