Actualizar registro

Actualiza los detalles de 1 registro en una aplicación especificando su número de registro o una clave única diferente.

MétodoPUT
URLhttps://{subdomain}.kintone.com/k/v1/record.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/record.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 actualizar los registros en la aplicación.
  • Se necesita permiso para actualizar los campos que se incluyen en los parámetros de solicitud.

Parámetros de solicitud

PARÁMETRO VALOR OBLIGATORIO DESCRIPCIÓN
app Entero o cadena El identificador de la aplicación.
id Entero o cadena Condicional El identificador de registro del registro que se va a actualizar. Obligatorio, si updateKey no se especificará.
updateKey Objeto Condicional La clave única del registro que se va a actualizar. Obligatorio, si identificación no se especificará. Para especificar este campo, el campo debe tener activada la opción "Prohibir valores duplicados".
updateKey.field Cuerda Condicional El código de campo de la clave única.
Obligatorio, si updateKey se especificará.
updateKey.value Entero o cadena Condicional El valor de la clave única.
Obligatorio, si updateKey se especificará.
revision Entero o cadena El número de revisión esperado. Si el valor no coincide, se producirá un error y el registro no se actualizará. Si el valor no se especifica o es -1, no se comprobará el número de revisión.
record Objeto Los códigos de campo y los valores se especifican en este objeto. Si se ignora, el registro no se actualizará. Para obtener más información sobre los tipos de campo, consulte el siguiente artículo:
Tipos de campo

*la API dará lugar a un error si ambos identificación y updateKey se especifican

Solicitud de muestra (id)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
var body = {
  'app': 1,
  'id': 1,
  'record': {
    'Text': {
      'value': 'ABC'
    }
  }
};

kintone.api(kintone.api.url('/k/v1/record.json', true), 'PUT', 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
$ curl -X PUT 'https://{subdomain}.kintone.com/k/v1/record.json' \
-H 'X-Cybozu-API-Token: {APIToken}' \
-H 'Content-Type: application/json' \
-d '{
    "app": 1,
    "id": 1,
    "record": {
        "Text": {
            "value": "ABC"
        }
    }
}'

Solicitud de ejemplo (updateKey)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
var body = {
  'app': 1,
  'updateKey': {
    'field': 'unique_key',
    'value': 'unique_code'
  },
  'record': {
    'Text': {
      'value': 'ABC'
    }
  }
};

kintone.api(kintone.api.url('/k/v1/record.json', true), 'PUT', 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
$ curl -X PUT 'https://{subdomain}.kintone.com/k/v1/record.json' \
-H 'X-Cybozu-API-Token: {APIToken}' \
-H 'Content-Type: application/json' \
-d '{
    "app": 1,
    "updateKey": {
        "field": "unique_key",
        "value": "unique_code"
    },
    "record": {
        "Text": {
            "value": "ABC"
        }
    }
}'

Parámetros de respuesta

Parámetro Tipo Descripción
revision Cuerda El número de revisión del registro.

Ejemplo de respuesta

1
2
3
{
  "revision": "5"
}

Campos adjuntos y tablas

Actualización y eliminación de archivos en campos adjuntos

Si desea agregar un nuevo archivo a un campo de datos adjuntos que ya tiene varios archivos adjuntos, deberá especificar las claves de archivo de esos archivos en la solicitud. No se puede actualizar un archivo adjunto específico.
Si no se especifica una clave de archivo en la solicitud, se eliminarán los archivos.

Actualización de tablas

Si los datos de las tablas no se incluyen en la solicitud, los datos de la tabla permanecerán como están.
Si se incluyen datos de tabla en la solicitud, tenga en cuenta lo siguiente:

  • Se eliminarán todos los campos dentro de la tabla que no estén incluidos en la solicitud.
  • Para mantener datos específicos de los campos en la tabla, el valor de ese campo debe incluirse en la solicitud.
  • Al especificar el ID de una fila de tabla, se pueden actualizar filas y campos específicos. El identificador se puede recuperar mediante la API Get Record. Para obtener más información, consulte el siguiente documento:
    Obtener registro
  • Si se especifica un identificador de fila de tabla que no existe, la fila se agregará como una nueva fila. En este caso, se eliminarán las filas que existen en la tabla pero que no se especificaron en la API.

Limitaciones

  • Si hay campos con la opción "Campo obligatorio" activada y esos campos no contienen valores (lo que podría ocurrir en los casos en que el formulario de la aplicación se actualizó después de que se agregaron algunos registros a la aplicación), esos campos deben incluirse en la solicitud.
  • Los siguientes campos no se pueden actualizar:
    • Los destinos de asignaciones de campos del campo Búsqueda
    • Estado
    • Categorías
    • Calculado
    • Cesionario
    • Número de registro
    • Creado por
    • Fecha y hora creada
    • Actualizado por
    • Fecha y hora actualizada
  • Si se especifican campos que no existen dentro de la aplicación en las solicitudes, estos campos se ignorarán.
  • Si los campos calculados son valores especificados en la solicitud, estos valores se omitirán.
  • Si los campos de texto con la opción "Calcular automáticamente" son valores especificados en la solicitud, estos valores se ignorarán.
  • Los campos especificados como updateKey no se puede actualizar.
  • Para conocer otras limitaciones, consulte la sección Limitaciones del siguiente artículo:
    Descripción general de la API REST de Kintone

Actualizar varios registros

Para actualizar los datos de varios registros, consulte el siguiente documento de API:
Actualizar registros