Obtener cursor

Recupera varios registros de una aplicación especificando el identificador del cursor.

MétodoGET
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
id Cuerda El ID del cursor.

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
var body = {
  'id': '9a9716fe-1394-4677-a1c7-2199a5d28215'
};
kintone.api(kintone.api.url('/k/v1/records/cursor.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

Muestra de curl

1
2
3
4
$ curl -X GET 'https://{subdomain}.kintone.com/k/v1/records/cursor.json' \
  -H 'X-Cybozu-API-Token: {APIToken}' \
  -H 'Content-Type: application/json' \
  -d '{"id": "9a9716fe-1394-4677-a1c7-2199a5d28215"}'

Parámetros de respuesta

Parámetro Tipo Descripción
records Arreglo Matriz de objetos que incluye datos de campo de registros que coinciden con la consulta.
La respuesta es la misma que la respuesta de la API Get Records. Para obtener más información, consulte el siguiente documento:
Obtener registros
next Booleano Indica si hay más registros que se pueden adquirir desde el cursor.
  • true: Todavía quedan registros por adquirir.
  • false: No hay más registros que adquirir.
Vuelva a ejecutar esta API con los mismos parámetros para obtener el siguiente conjunto de registros.
El cursor seguirá siendo válido hasta que se hayan obtenido todos los registros.

Ejemplo de respuesta

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "records": [
    {
      "$id": {
        "type": "__ID__",
        "value": "1"
      },
      "Created_by": {
        "type": "CREATOR",
        "value": {
          "code": "Administrator",
          "name": "Administrator"
        }
      },
      "Created_datetime": {
        "type": "CREATED_TIME",
        "value": "2019-05-23T04:50:00Z"
      }
    }
  ],
  "next": false
}

Limitaciones

  • La API Get Cursor devuelve archivo que coincidan con la consulta en el momento en que se llama a la API Add Cursor. Para obtener más información, consulte el siguiente documento:
    Agregar cursor
    Sin embargo, la API Get Cursor devuelve el atributo Valores de campo de registros en el momento en que se llama a la API Get Cursor.

  • En el caso de que se aplique una nueva configuración de permisos a la aplicación después de agregar un cursor, la API Get Cursor puede devolver registros que no deben coincidir con la consulta con los nuevos permisos. En este caso, los valores de los campos sin permisos de visualización no se pueden ver en la respuesta.

  • Dado que los valores de campo obtenidos dependen de cuándo se llama a la API Get Cursor, los valores obtenidos de los campos localizados pueden variar en función de la configuración de idioma del iniciador de la API.

  • Puede haber casos en los que el siguiente conjunto de registros obtenidos (cuando el next El parámetro es true) está vacío, si los registros se eliminan o tienen una nueva configuración de permisos aplicada durante las solicitudes de la API Get Cursor.

  • El cursor se eliminará automáticamente cuando responda false En el caso de la next parámetro. Cualquier solicitud adicional dará como resultado una respuesta de error 404.

  • Si la cadena de consulta incluye like y not like operadores, la búsqueda se detendrá después de que coincida con 100.000 registros. En este caso, "x-cybozu-warning : Filtro abortado debido a demasiados resultados de búsqueda." se incluirá en el encabezado de respuesta.

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 (External link)