Archivos
Algunos APIs soportan archivos.
Para subir archivos (media vez esté soportado) se debe de incluir files
como parte de la petición, este es un Arreglo de File
Estándar
- Enviar un arreglo de
File
con el nombrefiles
. - Siempre se deben enviar todos los archivos, a menos que se quieran eliminar.
- Si se desea eliminar un archivo no se debe enviar dentro del arreglo de
files
. - Al subir nuevos archivos se debe de tener cuidado con el máximo límite del servidor para el cuerpo de la petición.
- Estará disponible para
POST
yPATCH
.
Ejemplo
- Petición
{ // ... "files": [ { "name": "test.json", "size_bytes": 18, "datetime_iso": "2023-06-05T18:58:09+00:00", "content_base64": "eyAiaGkiOiAid29ybGQhIiB9" }, { "name": "test2.json", "size_bytes": 18, "datetime_iso": "2023-06-05T18:58:09+00:00", "content_base64": "eyAiaGkiOiAid29ybGQhIiB9" } ] }
- Respuesta
{ // ... "files": [ { "id": 5269, "name": "test.json", "url": "http://localhost:2000/internal/api/file-v1/22/jobs/e03f0e43-e2d3-454e-9816-391b438f051f.json", "size_bytes": 18, "group_key": null, "datetime_iso": "2023-06-05T18:58:09+00:00", "creation_datetime_iso": "2024-10-30T20:28:57+00:00" }, { "id": 5270, "name": "test2.json", "url": "http://localhost:2000/internal/api/file-v1/22/jobs/e03f0e43-e2d3-454e-9816-391b438f051f.json", "size_bytes": 18, "group_key": null, "datetime_iso": "2023-06-05T18:58:09+00:00", "creation_datetime_iso": "2024-10-30T20:28:57+00:00" } ] }
O: File Data Object
Cada objeto de tarea tiene estos campos
Campo | Tipo | Sólo lectura | Requerido | Descripción |
---|---|---|---|---|
id | int | Sí | No | La identificación del archivo |
name | string | No | Sí | El nombre visible por el cliente (longitud máxima 127) |
url | string | Sí | No | El URL que se puede consultar |
content_base64 | string | No | Sí | El contenido del archivo codificado en base64. Solo para crear nuevos archivos |
size_bytes | int | No | Sí | El peso del archivo en bytes |
group_key | int | No | No | Valor utilizado por las apps para agrupar archivos (longitud máxima 31) |
datetime_iso | string | No | Sí | Fecha de subida del archivo |
create_datetime_iso | string | Sí | No | Fecha de creación |