UploadJobDoc

Sube un documento a un expediente, para todas sus órdenes de trabajo, o a una sola orden de trabajo. El documento aparece en la pestaña Documents de la orden de trabajo, en For Job o en For this Work Order only, y puede vincularse a elementos de la lista de comprobación de documentos del expediente. Para listar los documentos de un expediente, use GetJobDocs. Para los archivos de otros registros, como las facturas de proveedor, use UploadDoc.

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/UploadJobDoc
Token: your-token
Content-Type: multipart/form-data; boundary=...

Parte	Obligatoria	Significado
JobID	Una de las dos	El identificador del expediente: el documento es para todo el expediente y aparece en todas sus órdenes de trabajo.
WorkOrderID	Una de las dos	El identificador de la orden de trabajo: el documento es solo para esta orden de trabajo.
Title	No	El título del documento. Sin él, el título es el nombre del archivo sin su extensión. TrakIT conserva los primeros 300 caracteres.
IsPublic	No	true para dar a los usuarios externos, como el cliente, acceso al documento: entonces se marca como Ext. Cualquier otro valor, o ninguno, lo mantiene interno.
Checklist	No	Los nombres de los elementos de la lista de comprobación a los que se vincula el documento, separados por ~, por ejemplo Bill of Lading~Commercial Invoice. Cada nombre debe ser el nombre completo del elemento; las mayúsculas y minúsculas no importan. Los nombres que no coinciden con ningún elemento de la lista de comprobación del expediente se ignoran.
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.

Sin Checklist, TrakIT vincula el documento a los elementos de la lista de comprobación cuyo patrón de nombre coincide con el nombre del archivo, como hace con una subida en la aplicación. En ambos casos, el estado de cada elemento vinculado de la lista de comprobación pasa a Pending.

Reglas

Regla	Info si no se cumple
La solicitud es multipart/form-data.	Unsupported media type
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
JobID y WorkOrderID, cuando se indican, son números.	Parameter JobID must be a number, Parameter WorkOrderID must be a number
Se indica exactamente uno de JobID y WorkOrderID.	Either JobID or WorkOrderID must be provided, Only one of JobID or WorkOrderID must be provided
La orden de trabajo existe y está activa o abandonada.	Work Order ... not found, Work Order is not active
Con Checklist, el expediente existe.	Job Not found
Se superan las validaciones personalizadas que el soporte de TrakIT puede definir para Upload Document en las órdenes de trabajo. Consulte Validaciones y acciones.	El mensaje propio de la validación
El expediente o la orden de trabajo no tiene ningún documento, no cancelado, con el mismo título, nombre de archivo y tamaño.	Document with same title, file name and size already exists
El documento se puede guardar: por ejemplo, JobID indica un expediente que existe.	Unable to add new Document

Respuesta

Si tiene éxito, Code es 1 e Identity es el identificador del nuevo documento, el DocID que devuelve GetJobDocs. RetInfo es null; no tenga en cuenta RowsAffected ni Scalar.

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

Ejemplo

Con curl, para subir una prueba de entrega a una orden de trabajo, abierta a los usuarios externos y vinculada al elemento de la lista de comprobación con ese nombre:

curl -H "Token: your-token" -F "WorkOrderID=48211" -F "Title=Proof of delivery" -F "IsPublic=true" -F "Checklist=Proof of Delivery" -F "file=@pod-48211.pdf" https://trakit.example.com/api/v1/UploadJobDoc

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

Notas

• El usuario de la API aparece como la persona que subió el documento. La subida queda registrada en el registro de auditoría.
• Las acciones personalizadas que el soporte de TrakIT puede definir para Upload Document se ejecutan después de la subida.
• No se avisa a nadie por correo electrónico: la opción Notify Users de la aplicación no tiene equivalente aquí.
• 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 con el mismo título se rechaza, por lo que un reintento no puede añadirlo dos veces.