Recupera detalles de varios registros de una aplicación especificando el identificador de la aplicación y una 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.

1

app=8&query=Created_by%20in%20(LOGINUSER())%20and%20Created_datetime%20%3D%20TODAY()%20order%20by%20%24id%20asc%20limit%20100%20offset%200&fields[0]=%24id&fields[1]=Created_by&fields[2]=Created_datetime

1
2
3
4
5
6
7
8
9

var query = 'Created_by in (LOGINUSER()) and Created_datetime = TODAY() order by $id asc limit 100 offset 0';
var fields = '&fields[0]=$id&fields[1]=Created_by&fields[2]=Created_datetime';
kintone.api(kintone.api.url('/k/v1/records.json', true) + '?app=8&query=' + query + fields, 'GET', {}, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

1
2
3

curl -X GET 'https://{subdomain}.kintone.com/k/v1/records.json?app=8&query=Created_by%20in%20(LOGINUSER())%20and%20Created_datetime%20%3D%20TODAY()' \
'%20order%20by%20%24id%20asc%20limit%20100%20offset%200&fields[0]=%24id&fields[1]=Created_by&fields[2]=Created_datetime' \
 -H 'X-Cybozu-API-Token: {APIToken}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

var body = {
  'app': 8,
  'query': 'Created_by in (LOGINUSER()) and Created_datetime = TODAY() order by $id asc limit 100 offset 0',
  'fields': ['$id', 'Created_by', 'Created_datetime']
};

kintone.api(kintone.api.url('/k/v1/records.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

1
2
3
4

curl -X GET 'https://{subdomain}.kintone.com/k/v1/records.json' \
 -H 'X-Cybozu-API-Token: {APIToken}' \
 -H 'Content-Type: application/json' \
 -d '{"app": 8, "query": "Created_by in (LOGINUSER()) and Created_datetime = TODAY() order by $id asc limit 100 offset 0", "fields": ["$id", "Created_by", "Created_datetime"]}'

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

{
  "records": [
    {
      "Created_datetime": {
        "type": "CREATED_TIME",
        "value": "2024-11-11T04:50:00Z"
      },
      "Created_by": {
        "type": "CREATOR",
        "value": {
          "code": "Administrator",
          "name": "Administrator"
        }
      },
      "$id": {
        "type": "__ID__",
        "value": "1"
      }
    },
    {
      "Created_datetime": {
        "type": "CREATED_TIME",
        "value": "2024-11-11T06:42:00Z"
      },
      "Created_by": {
        "type": "CREATOR",
        "value": {
          "code": "Administrator",
          "name": "Administrator"
        }
      },
      "$id": {
        "type": "__ID__",
        "value": "2"
      }
    }
  ],
  "totalCount": null
}

Para obtener más información sobre las cadenas de consulta, consulte el siguiente documento:
Cadena de consulta

• 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 1,000 campos en el cuerpo de la solicitud.
• El valor de desplazamiento máximo que se puede especificar es 10,000.
• Al utilizar una búsqueda de palabras clave con like y not like Como condiciones de filtrado, la búsqueda se anulará una vez que el número de registros que contengan la palabra clave supere los 100.000.
  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

• 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

• 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