Agregar cursor

Agrega un cursor para que se pueda obtener una gran cantidad de registros desde una aplicación.

MétodoPOST
URLhttps://{subdomain}.kintone.com/k/v1/records/cursor.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/records/cursor.json
Autenticación Autenticación de contraseña , Autenticación de token de API , Autenticación de sesión
Content-Typeapplication/json

Contenido

Permisos

El usuario o el token de API deben tener permiso para ver los registros.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
app Entero o cadena El identificador de la aplicación.
fields Matriz de cadenas No Los códigos de campo que se incluirán en la respuesta cuando se utilice la API Get Cursor. Para obtener más información, consulte el siguiente documento:
Obtener cursor
Si se ignora, se devolverán todos los campos accesibles de la aplicación.
query Cuerda No Cadena de consulta que especificará qué registros se responderán al usar la API Get Cursor. Para obtener más información, consulte el siguiente documento:
Obtener cursor
Para obtener más información sobre los operadores y las opciones que se pueden especificar en la cadena de consulta, consulte el artículo siguiente:
Cadenas de consulta
Si se ignora, se devolverán todos los registros accesibles desde la aplicación.
size Entero o cadena No El número máximo de registros que la API Get Cursor puede recuperar de este cursor con una solicitud.

Para obtener más información, consulte la siguiente API:
Obtener cursor
El número máximo es de 500 registros. Si se omite, el número predeterminado de registros que se van a recuperar es 100.

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
var body = {
  'app': 1,
  'fields': ['$id', 'Created_by', 'Created_datetime'],
  'query': 'Created_by in (LOGINUSER()) and Created_datetime = TODAY() order by $id asc',
  'size': 500
};
kintone.api(kintone.api.url('/k/v1/records/cursor.json', true), 'POST', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

Muestra de curl

1
2
3
4
$ curl -X POST 'https://{subdomain}.kintone.com/k/v1/records/cursor.json' \
  -H 'X-Cybozu-API-Token: {APIToken}' \
  -H 'Content-Type: application/json' \
  -d '{"app": 1, "fields": ["$id", "Created_by", "Created_datetime"], "query": "Created_by in (LOGINUSER()) and Created_datetime = TODAY() order by $id asc", "size": 500}'

Parámetros de respuesta

Parámetro Tipo Descripción
id Cuerda El ID del cursor.
totalCount Cuerda El recuento total de registros que coinciden con las condiciones de consulta.

Ejemplo de respuesta

1
2
3
4
{
  "id": "9a9716fe-1394-4677-a1c7-2199a5d28215",
  "totalCount": "123456"
}

Limitaciones

  • No se pueden realizar solicitudes simultáneas por dominio con esta API.
  • El número máximo de cursores válidos por dominio es 10.
    Si se alcanza este límite, se producirá un error en las llamadas a la API para agregar nuevos cursores.
    Si se produce una de las siguientes acciones, se reducirá el número de cursores válidos:
    • Todos los registros se obtienen de un cursor existente
    • Se elimina un cursor válido
    • Caduca un cursor válido
  • Los cursores caducan 10 minutos después de su adición. Si la API Get Cursor especifica un cursor y aún no se han obtenido registros de ese cursor, el tiempo de expiración se ampliará a 10 minutos. Para obtener más información, consulte el siguiente documento:
    Obtener cursor
  • Esta API agotará el tiempo de espera después de 5 minutos.
    En este caso, será necesario volver a llamar a la API con una consulta más sencilla o una consulta que obtenga menos registros.