Documentos de API

Descargar archivo

Descarga archivos de un campo de datos adjuntos en una aplicación.

MétodoGET
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-Typeapplication/json (no es necesario si se especifica la consulta con una cadena de consulta)

Contenido

Permisos

  • Se necesitan permisos de visualización de aplicaciones para la aplicación relacionada.
  • Se necesitan permisos de visualización de registros para el registro relacionado.
  • Se necesitan permisos de vista de campo para el campo relacionado.

Parámetros de solicitud

El archivo se descarga enviando el archivo fileKey del archivo adjunto. Éste fileKey primero deberá obtenerse mediante una de las siguientes API:

Tenga en cuenta que este fileKey es diferente de la fileKey se obtiene de la respuesta cuando se utiliza la API de carga de archivos.

PARÁMETRO VALOR OBLIGATORIO DESCRIPCIÓN
fileKey Cuerda Sí El valor que se establece en el campo Datos adjuntos en los datos de respuesta devueltos cuando se utiliza la API Get Record.

Solicitud de ejemplo (cadena de consulta)

JavaScript 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

var fileKey = kintone.app.record.get().record.file.value[0].fileKey;
var url = 'https://{subdomain}.kintone.com/k/v1/file.json?fileKey=' + fileKey;
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.responseType = 'blob';
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    var blob = new Blob([xhr.response]);
    var windowUrl = window.URL || window.webkitURL;
    var blobUrl = windowUrl.createObjectURL(blob);
    console.log(blobUrl);
  } else {
    // error
    console.log(xhr.responseText);
  }
};
xhr.send();

Muestra de curl

Utilice la función -o para guardar la salida en un archivo.

1
2
3

curl -X GET 'https://{subdomain}.kintone.com/k/v1/file.json?fileKey=20150417022053715283FF97DC413CBC4B7A41C' \
  -H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx'
  -o ./sample.txt

Solicitud de ejemplo (JSON)

JavaScript

N/A.
Los datos no se pueden establecer en el cuerpo de los métodos GET cuando se utiliza XMLHttpRequest (XHR). Para obtener más información, consulte el siguiente documento en MDN Web Docs:
XMLHttpRequest (External link)

Muestra de curl 

1
2
3
4
5
6

curl -X GET 'https://{subdomain}.kintone.com/k/v1/file.json' \
  -H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileKey": "20150417022053715283FF97DC413CBC4B7A41C"
  }'

Ejemplo de respuesta

El tipo de medio MIME del archivo cargado se indicará en el Content-Type, y la información del archivo se establecerá dentro del cuerpo de la respuesta.

Obtención de la clave de archivo

El fileKey de un archivo se puede encontrar en la respuesta de la siguiente API:
Obtener registro
A continuación se muestra un ejemplo de respuesta que incluye el fileKey para ser utilizado con la API de Download File.

 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

{
  "record": {
    "updated_time": {
      "type": "UPDATED_TIME",
      "value": "2017-03-15T11:59:06Z"
    },
    "file": {
      "type": "FILE",
      "value": [
        {
          "contentType": "text/plain",
          "fileKey": "20150417022053715283FF97DC413CBC4B7A41C",
          "name": "kintoneUpdates.txt",
          "size": "25302"
        },
        {
          "contentType": "text/plain",
          "fileKey": "20150417022159ECFC1223C4B34C939E1B9BD25",
          "name": "APIUpdatestxt",
          "size": "20311"
        }
      ]
    }
  }
}

Limitaciones

No se puede llamar a esta API con la siguiente API:
Solicitud de API REST de Kintone