UploadDoc

Adjunta un archivo a un registro que no es un expediente ni una orden de trabajo: un activo, una factura de proveedor, un cobro, una factura, un presupuesto, un usuario, un movimiento de patio o una actividad. El archivo aparece entonces con los archivos del registro en TrakIT, por ejemplo en la pestaña Files de una factura de proveedor. Para los documentos de un expediente o de una orden de trabajo, use UploadJobDoc.

Cómo iniciar sesión y leer la respuesta: Autenticación, Respuestas.

Envíe la solicitud como multipart/form-data, con las partes siguientes y el archivo.

POST /api/v1/UploadDoc
Token: your-token
Content-Type: multipart/form-data; boundary=...

Parte	Obligatoria	Significado
Ref	Sí	El tipo de registro, de la tabla siguiente. No distingue entre mayúsculas y minúsculas.
RefID	Sí	El identificador del registro, un número entero.
Title	No	El título del archivo, de hasta 300 caracteres. Sin él, el título es el nombre del archivo sin su extensión.
El archivo	Sí	El propio archivo, en una parte de archivo con cualquier nombre, por ejemplo file.

Envíe un archivo por solicitud: si la solicitud contiene varios, solo se guarda el primero.

Registros

Ref	RefID	Dónde aparece el archivo
asset	El identificador del activo.	La pestaña Asset Files del activo
bill	El identificador de la factura de proveedor.	La pestaña Files de la factura de proveedor
receipt	El identificador del cobro.	La pestaña Documents del cobro
invoice	El identificador de la factura.	La pestaña Files de la factura
quotation	El identificador del presupuesto.	La pestaña Documents del presupuesto
user	El número interno del usuario, no el identificador de usuario.	La pestaña User Files del usuario
yardmove	El identificador del movimiento de patio.	La pestaña Files del movimiento
activity	El identificador de la actividad.	La pestaña Activity Files de la actividad

Reglas

Regla	Info si no se cumple
La solicitud contiene un archivo.	No Files Found
El archivo no es de un tipo que TrakIT rechaza siempre, como un programa.	Cannot upload this file type
El archivo no está vacío.	File size is zero
El archivo ocupa 20 MB como máximo.	File size cannot exceed 20MB
El archivo es de un tipo que TrakIT acepta. La lista se define para cada instalación de TrakIT; de forma predeterminada es PNG, JPG, JPEG, PDF, DOCX, XLSX y TIF.	File extension not allowed
El nombre del archivo tiene 300 caracteres como máximo.	File name cannot exceed 300 characters
Se indica Ref.	Parameter Ref is missing
Se indica RefID, como número.	Parameter RefID is missing, Parameter RefID must be a number
Ref es uno de los valores anteriores.	Ref is invalid
El registro existe.	Reference object doesn't exist
El registro aún no tiene un archivo con el mismo nombre y tamaño.	A file of the same name and size already exists
El título tiene 300 caracteres como máximo.	Unable to add attachment

Respuesta

Si tiene éxito, Code es 1 e Identity es el identificador del nuevo archivo. RetInfo es null, y RowsAffected y Scalar no se utilizan.

{
  "Code": 1,
  "Info": "",
  "RetInfo": null,
  "RowsAffected": 0,
  "Scalar": null,
  "Identity": 195301
}

Ejemplo

Con curl:

curl -H "Token: your-token" -F "Ref=bill" -F "RefID=109827" -F "Title=Delivery note" -F "file=@delivery-note.pdf" https://trakit.example.com/api/v1/UploadDoc

Sustituya https://trakit.example.com por la dirección de su TrakIT.

Notas

• El archivo es solo para los usuarios internos. En una factura de proveedor, por ejemplo, no se marca como External, por lo que el proveedor no lo ve en el portal.
• El usuario de la API aparece como la persona que lo subió.
• Las imágenes PNG y JPG más grandes que el tamaño máximo de imagen de la instalación (800 píxeles en el lado más largo, de forma predeterminada) se reducen al guardarse.
• Volver a enviar el mismo archivo se rechaza con A file of the same name and size already exists, por lo que un reintento no puede añadirlo dos veces.