Documentos de API

Solicitud masiva

Ejecuta varias solicitudes de API de forma secuencial a varias aplicaciones.

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

Contenido

Permisos

Los permisos dependen de las API que se utilicen.

Introducción

La API de solicitud masiva permite que varias solicitudes de API se ejecuten en varias aplicaciones de Kintone. Las siguientes API se pueden usar con la API de solicitud masiva:

  • Agregar registro
  • Agregar registros
  • Actualizar registro
  • Actualizar registros
  • Eliminar registros
  • Estado de actualización
  • Estados de actualización
  • Actualizar personas asignadas

Parámetros de solicitud

PARÁMETRO VALOR OBLIGATORIO DESCRIPCIÓN
requests Arreglo Sí Una matriz de solicitudes. El número máximo de solicitudes es de 20.
requests[].method Cuerda Sí El método de API para la solicitud.
requests[].api Cuerda Sí La ruta de acceso de la API para la solicitud.
requests[].payload Objeto Sí Los parámetros que se pasarán a la API de la solicitud.
Los contenidos y formatos cambiarán en función de la API.

Solicitud de muestra

JavaScript using kintone.api() 

 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
40
41
42
43
44
45
46
47

var body = {
  'requests': [
    {
      'method': 'POST',
      'api': '/k/v1/record.json',
      'payload': {
        'app': 1,
        'record': {
          'text': {
            'value': 'post bulk'
          }
        }
      }
    },
    {
      'method': 'PUT',
      'api': '/k/v1/record.json',
      'payload': {
        'app': 1,
        'id': 3,
        'record': {
          'text': {
            'value': 'update bulk'
          }
        }
      }
    },
    {
      'method': 'DELETE',
      'api': '/k/v1/records.json',
      'payload': {
        'app': 1,
        'ids': [
          2
        ],
      }
    }
  ]
};

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

Muestra de curl 

 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
40
41
42

curl -X POST 'https://{subdomain}.kintone.com/k/v1/bulkRequest.json' \
  -H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
  -H 'Content-Type: application/json' \
  -d '{
    "requests": [
      {
        "method": "POST",
        "api": "/k/v1/record.json",
        "payload": {
          "app": 1,
          "record": {
            "text": {
              "value": "post bulk"
            }
          }
        }
      },
      {
        "method": "PUT",
        "api": "/k/v1/record.json",
        "payload": {
          "app": 1,
          "id": 3,
          "record": {
            "text": {
              "value": "update bulk"
            }
          }
        }
      },
      {
        "method": "DELETE",
        "api": "/k/v1/records.json",
        "payload": {
          "app": 1,
          "ids": [
            2
          ]
        }
      }
    ]
  }'

Parámetros de respuesta

Se responde a una matriz, donde los resultados se colocan en el mismo índice que la solicitud.

PARÁMETRO VALOR DESCRIPCIÓN
results Arreglo La respuesta de cada solicitud de API. El orden de la respuesta es el mismo que el de las solicitudes.
Si se produce un error en una solicitud de API, se incluirá un error en el índice de la API fallida. En este caso, todos los demás índices se responderán con {} (objetos vacíos).

Ejemplo de respuesta

Respuesta exitosa 

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

{
  "results": [
    {
      "id": "4",
      "revision": "1"
    },
    {
      "revision": "2"
    },
    {}
  ]
}

Respuesta fallida

Se trata de un ejemplo de respuesta fallida, en la que se produce un error en la segunda solicitud PUT debido a que no existe un identificador de registro. Si se produce un error en una API, el error se responderá en ese índice y otros índices responderán con objetos vacíos {}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "results": [
    {},
    {
      "message": "Record(id:3)NotFound.",
      "id": "1505999166-1721668264",
      "code": "GAIA_RE01"
    },
    {}
  ]
}

Limitaciones

  • El número máximo de solicitudes es de 20.
  • Si se produce un error en una de las solicitudes de API, se revertirán todas las operaciones.
  • La API de solicitud masiva que se usa para las aplicaciones de espacio de invitado solo puede dirigirse a aplicaciones dentro del mismo espacio de invitado.
  • Cuando uses la autenticación de token de API para operar varias aplicaciones, especifica el token de API emitido para cada aplicación. Para obtener información sobre cómo especificar varios tokens de API, consulte el siguiente documento:
    Autenticación de token de API