Obtener registros
Recupera detalles de varios registros de una aplicación especificando el identificador de la aplicación y una cadena de consulta.
Método | GET |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/records.json |
URL (espacio de invitado) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/records.json |
Autenticación | Autenticación de contraseña, Autenticación de token de API, Autenticación de sesión |
Content-Type | application/json (no es necesario si se especifica la consulta con una cadena de consulta) |
Contenido
Parámetros de solicitud
PARÁMETRO | VALOR | OBLIGATORIO | DESCRIPCIÓN |
---|---|---|---|
fields | Matriz de cadenas | Opcional | Los códigos de campo que se incluirán en la respuesta. Si se ignora este parámetro, se devolverán todos los campos accesibles que existan en la aplicación. |
app | Entero o cadena | Sí | El identificador de la aplicación. |
query | Cuerda | Opcional | Cadena de consulta que especifica los registros que se van a incluir en la respuesta. Consulte el siguiente documento para obtener más información: Cadenas de consulta Si se ignora este parámetro, se devolverán todos los registros accesibles desde la aplicación. |
totalCount | Booleano o cadena | Opcional | Si se establece en true , el recuento total de registros que coincidan con las condiciones de consulta se incluirá en la respuesta.Si se omite, se devuelve null para el totalCount valor. |
Solicitudes de ejemplo (cadena de consulta)
Una solicitud de ejemplo para usar la API Get Records que especifica:
- Un ID de aplicación de 8
- Una consulta de
_Created_by in (LOGINUSER()) and Created_datetime = TODAY() order by $id asc limit 100 offset 0_
- Los siguientes campos que se incluirán en la respuesta
- El ID de registro campo
- El Creado por campo (con la línea de campo de "Created_by")
- El Fecha y hora creada campo (con la línea de campo de "Created_datetime")
La cadena de consulta se envía uniendo los parámetros "app", "query" y "fields" con un "&" y una URL que codifica el nombre de cada parámetro de la consulta y sus valores correspondientes.
Cadena de consulta
|
|
|
|
Muestra de curl
|
|
Solicitudes de ejemplo (JSON)
|
|
Muestra de curl
|
|
Parámetros de respuesta
Parámetro | Tipo | Descripción |
---|---|---|
records | Arreglo | Matriz de objetos, incluidos los tipos de campo y los valores de campo dentro de los registros coincidentes. |
totalCount | Cuerda | El recuento total de registros que coinciden con las condiciones de consulta. Si el parámetro totalCount se omite o se establece como false En la solicitud, se devuelve null. |
Ejemplo de respuesta
Un objeto de una matriz de registros con datos de campo se responde desde la aplicación especificada.
Cada registro de la matriz incluye el tipo de campo y los valores almacenados en el registro.
Para conocer las especificaciones del tipo de campo, consulte el siguiente documento:
Tipos de campo
|
|
Operadores y funciones de consulta
Para obtener más información sobre las cadenas de consulta, consulte el siguiente documento:
Cadena de consulta
Limitaciones
- El número máximo de registros que se pueden recuperar con la API Get Records es de 500.
- El ámbito del índice de matriz que puede especificar para las consultas de campo está entre 0 y 99.
- Se pueden especificar hasta 1000 campos en el cuerpo de la solicitud.
- El valor de desplazamiento máximo que se puede especificar es 10000.
- El filtrado se anulará si hay más de 100.000 coincidencias para la consulta.
En este caso, "x-cybozu-warning : Filtro abortado debido a demasiados resultados de búsqueda." se devolverá en el encabezado de respuesta. - Para conocer otras limitaciones, consulte la sección de limitaciones del siguiente artículo:
Descripción general de la API REST de Kintone
Artículos relacionados
- Obtener todos los registros desde una aplicación: El método de desplazamiento frente al método de búsqueda
- Obtener todos los registros desde una aplicación: El método Offset
- Los tres métodos para la recuperación masiva de registros
Notas
- El idioma de los datos de registro devueltos depende del método de autenticación utilizado:
- Cuando el
Accept-Language
request header, se devolverá el idioma especificado, si se ha establecido en la configuración regional. Para obtener más información sobre los encabezados de solicitud, consulte el siguiente documento:
Encabezados de solicitud - Autenticación de token de API: Se utilizará el idioma de visualización de la cuenta de administrador.
- Otras formas de autenticación: Se utilizará el idioma de visualización de la cuenta de usuario.
- Cuando el idioma de visualización se establece en Usar la configuración del navegador web, el idioma especificado en el Administración de Usuarios y Sistemas Se usará la configuración regional.
- La configuración regional del sistema se puede cambiar a través de la función Administración de Usuarios y Sistemas Configuración regional. Para obtener más información, consulte el siguiente artículo:
Configuración del idioma del sistema
- Cuando el