Subir archivo

Carga un archivo en Kintone.

MétodoPOST
URLhttps://{subdomain}.kintone.com/k/v1/file.json
Autenticación Autenticación de contraseña , Autenticación de token de API , Autenticación de sesión
Content-Typedatos multiparte/formulario

Cuando se carga un archivo, se produce un fileKey.
Tenga en cuenta que, aunque esta API carga un archivo en Kintone, no carga el archivo en un campo de datos adjuntos de una aplicación.
Para cargar el archivo en un campo de datos adjuntos, el campo fileKey se utiliza con la API Add Record o Update Record.

Contenido

Permisos

No se necesitan permisos relacionados con los registros, ya que esta API no adjunta directamente un archivo a una aplicación.

Parámetros de solicitud

Formato de solicitud

La solicitud se envía en un formato de datos de formulario/multiparte. Para obtener más información, consulte los siguientes documentos RFC:

Dentro de la Disposición de contenido , especifique "file" para el encabezado nombre y el nombre del archivo para el parámetro name``filenameNombre parámetro.

Encabezado de solicitud HTTP

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST /k/v1/file.json HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-API-Token: TOKEN
Content-Type: multipart/form-data; boundary="---------------------------bee48a285354"
Content-Length: 188
-----------------------------bee48a285354
Content-Disposition: form-data; name="file"; filename="sample.txt"
Content-Type: text/plain

test
-----------------------------bee48a285354--

Solicitud de muestra

JavaScript

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
var blob = new Blob(['Sample Test File'], {type: 'text/plain'});
var formData = new FormData();
formData.append('__REQUEST_TOKEN__', kintone.getRequestToken());
formData.append('file', blob, 'test.txt');

var url = 'https://{subdomain}.kintone.com/k/v1/file.json';
var xhr = new XMLHttpRequest();
xhr.open('POST', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send(formData);

Muestra de curl

1
2
3
curl -X POST 'https://{subdomain}.kintone.com/k/v1/file.json' \
  -H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
  -F 'file=@FILEPATH'

Ejemplo de API de Fetch

Para obtener más información sobre los tipos de identificación, consulte el siguiente enlace:
Fetch API (External link)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const blob = new Blob(['Sample Test File'], {
  type: 'text/plain',
});
const formData = new FormData();
// CSRF TOKEN: used for all APIs with HTTP methods of POST, PUT, and DELETE on Kintone.
formData.append('__REQUEST_TOKEN__', kintone.getRequestToken());
formData.append('file', blob, 'test.txt');

const headers = {
  'X-Requested-With': 'XMLHttpRequest',
};
const resp = await fetch('/k/v1/file.json', {
  method: 'POST',
  headers,
  body: formData,
});
const respData = await resp.json();
console.log(respData);

Parámetros de respuesta

Parámetro Tipo Descripción
fileKey Cuerda fileKey que representa un archivo cargado. Use esta clave de archivo con las siguientes API para adjuntarla a un campo de datos adjuntos de una aplicación:
Agregar registro
Agregar registros
Actualizar registro
Actualizar registros
Para obtener más información, consulte el siguiente artículo:
Tipos de campo

Ejemplo de respuesta

1
2
3
{
  "fileKey": " c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
}

fileKeys

Hay dos tipos de fileKeys que se usan en las API de REST de Kintone.

  • Clave de archivo de la API de carga de archivos
    • p. ej.. c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6
    • Esta clave de archivo se utiliza para actualizar un registro con un Archivo adjunto o agregue un registro con un archivo adjunto.
    • En este artículo se describe este tipo de fileKey
  • Obtener la clave de archivo de la API de registro
    • p. ej.. 201202061155587E339F9067544F1A92C743460E3D12B3297
    • Esta clave de archivo se utiliza cuando Descargar Un archivo de un archivo Archivo adjunto campo.
    • En este artículo no se trata este tipo de fileKey.

Adjuntar el archivo a un campo de datos adjuntos

Utilice las siguientes API y establezca el valor de la propiedad fileKey Como el fileKey obtenido de la API de carga de archivos, como se muestra en el cuerpo del ejemplo siguiente.
Agregar registro
Agregar registros
Actualizar registro
Actualizar registros

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "app": 3,
  "id": 6,
  "record": {
    "attached_file": {
      "value": [
        {
          "fileKey": " c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
        }
      ]
    }
  }
}

Limitaciones

  • Solo se puede cargar 1 archivo a la vez.
  • Una vez cargado el archivo en Kintone, el archivo se eliminará después de 3 días si no se utiliza la API Add Record o Update Record.
  • No se puede llamar a esta API con la siguiente API:
    API de solicitud de API REST de Kintone
  • Los archivos almacenados en el área de almacenamiento temporal también se incluyen en el uso del disco.
  • Las claves de archivo obtenidas a través de la API para recuperar registros no se pueden usar para cargar archivos.
  • Para conocer otras limitaciones, consulte el siguiente artículo:
    Limitaciones de la API REST de Kintone