Documentos de API

Agregar registros

Agrega varios registros a una aplicación.

  • Se pueden agregar hasta 100 registros a la vez.
  • Si hay campos con la opción "Campo obligatorio" activada, esos campos deben incluirse en la solicitud.
  • Los registros se agregan en el orden especificado en el records request. El orden de los ID de registro en la respuesta también corresponde a este orden.
  • Si se produce un error en la API Agregar registros, la solicitud se cancelará y no se agregará ningún registro.
MétodoPOST
URLhttps://{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-Typeapplication/json

Contenido

Permisos

  • Se necesita permiso para agregar registros a la aplicación.
  • Se necesita permiso para editar los campos que se incluyen en los parámetros de solicitud.
  • Se necesita permiso para editar los campos que se incluyen en los parámetros de solicitud.

Parámetros de solicitud

Parámetro Tipo Obligatorio Descripción
app Integer o String Sí El identificador de la aplicación.
records Matriz de objetos Sí Contiene una matriz de objetos de registro, que contiene códigos de campo y sus valores.
Los valores que se pueden especificar varían en función del tipo de campo.

Los campos que no están incluidos en los objetos se agregan con su valor predeterminado.
Los objetos que contienen códigos de campo que no existen se ignoran.
Para obtener más información sobre los tipos de campo, consulte el siguiente artículo:
Tipos de campo

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

var body = {
  'app': 1,
  'records': [
    {
      'Text': {
        'value': 'Sample001'
      },
      'Number': {
        'value': 1
      }
    },
    {
      'Text': {
        'value': 'Sample002'
      },
      'Number': {
        'value': 2
      }
    }
  ]
};

kintone.api(kintone.api.url('/k/v1/records.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

$ curl -X POST 'https://{subdomain}.kintone.com/k/v1/records.json' \
-H 'X-Cybozu-API-Token: {APIToken}' \
-H 'Content-Type: application/json' \
-d '{
  "app": 1,
  "records": [
    {
      "Text": {
        "value": "Sample001"
      },
      "Number": {
        "value": 1
      }
    },
    {
      "Text": {
        "value": "Sample002"
      },
      "Number": {
        "value": 2
      }
    },
  ]
}'

Parámetros de respuesta

Parámetro Tipo Descripción
ids Matriz de cadenas Los identificadores de registro de los registros creados.
revisions Matriz de cadenas Los números de revisión de los registros.

Ejemplo de respuesta

1
2
3
4

{
  "ids": ["77", "78"],
  "revisions": ["1", "1"]
}

Limitaciones

Se necesita permiso para administrar la aplicación para agregar valores a los siguientes campos:

  • Creado por
  • Actualizado por
  • Fecha y hora creada
  • Fecha y hora actualizada

Si hay campos con la opción "Campo obligatorio" activada, esos campos deben incluirse en la solicitud.

No se pueden agregar valores a los siguientes campos:

  • Los destinos de asignaciones de campos del campo Búsqueda
  • Estado
  • Categorías
  • Calculado
  • Cesionario
  • Campos de texto con la opción "Calcular automáticamente"

Para conocer otras limitaciones, consulte la sección Limitaciones del siguiente artículo:
Descripción general de la API REST de Kintone