UploadJobDoc

Charge un document dans un dossier, pour tous ses ordres de travail, ou dans un seul ordre de travail. Le document apparaît dans l’onglet Documents de l’ordre de travail, sous For Job ou For this Work Order only, et peut être lié à des éléments de la liste de contrôle des documents du dossier. Pour lister les documents d’un dossier, utilisez GetJobDocs. Pour les fichiers d’autres fiches, comme les factures fournisseurs, utilisez UploadDoc.

Comment se connecter et lire la réponse : Authentification, Réponses.

Envoyez la requête en multipart/form-data, avec les parties ci-dessous et le fichier.

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

Partie	Obligatoire	Signification
JobID	L’un des deux	L’identifiant du dossier : le document concerne tout le dossier, et apparaît sur tous ses ordres de travail.
WorkOrderID	L’un des deux	L’identifiant de l’ordre de travail : le document concerne uniquement cet ordre de travail.
Title	Non	Le titre du document. Sans titre, le titre est le nom du fichier sans son extension. TrakIT conserve les 300 premiers caractères.
IsPublic	Non	true pour donner aux utilisateurs externes, comme le client, l’accès au document : il est alors marqué Ext. Toute autre valeur, ou aucune, le garde interne.
Checklist	Non	Les noms des éléments de la liste de contrôle auxquels lier le document, séparés par ~, par exemple Bill of Lading~Commercial Invoice. Chaque nom doit être le nom complet de l’élément, quelle que soit la casse. Les noms qui ne correspondent à aucun élément de la liste de contrôle du dossier sont ignorés.
Le fichier	Oui	Le fichier lui-même, dans une partie fichier de nom quelconque, par exemple file.

Envoyez un fichier par requête : si la requête en contient plusieurs, seul le premier est enregistré.

Sans Checklist, TrakIT lie le document aux éléments de la liste de contrôle dont le masque de nom correspond au nom du fichier, comme pour un chargement dans l’application. Dans les deux cas, le statut de chaque élément lié de la liste de contrôle passe à Pending.

Règles

Règle	Info en cas d’échec
La requête est en multipart/form-data.	Unsupported media type
La requête contient un fichier.	No Files Found
Le fichier n’est pas d’un type que TrakIT refuse toujours, comme un programme.	Cannot upload this file type
Le fichier n’est pas vide.	File size is zero
Le fichier fait 20 Mo au plus.	File size cannot exceed 20MB
Le fichier est d’un type que TrakIT accepte. La liste est définie pour chaque installation de TrakIT ; par défaut, ce sont PNG, JPG, JPEG, PDF, DOCX, XLSX et TIF.	File extension not allowed
Le nom du fichier fait 300 caractères au plus.	File name cannot exceed 300 characters
JobID et WorkOrderID, lorsqu’ils sont indiqués, sont des nombres.	Parameter JobID must be a number, Parameter WorkOrderID must be a number
Exactement l’un de JobID et WorkOrderID est indiqué.	Either JobID or WorkOrderID must be provided, Only one of JobID or WorkOrderID must be provided
L’ordre de travail existe et est actif ou abandonné.	Work Order ... not found, Work Order is not active
Avec Checklist, le dossier existe.	Job Not found
Les validations personnalisées que le support TrakIT peut définir pour Upload Document sur les ordres de travail réussissent. Voir Validations et actions.	Le message propre à la validation
Le dossier ou l’ordre de travail n’a aucun document non annulé ayant le même titre, le même nom de fichier et la même taille.	Document with same title, file name and size already exists
Le document peut être enregistré : par exemple, JobID désigne un dossier qui existe.	Unable to add new Document

Réponse

En cas de succès, Code vaut 1 et Identity est l’identifiant du nouveau document, le DocID que renvoie GetJobDocs. RetInfo vaut null ; ne tenez pas compte de RowsAffected ni de Scalar.

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

Exemple

Avec curl, pour charger une preuve de livraison dans un ordre de travail, ouverte aux utilisateurs externes et liée à l’élément de la liste de contrôle de ce nom :

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

Remplacez https://trakit.example.com par l’adresse de votre TrakIT.

Notes

• L’utilisateur de l’API apparaît comme la personne qui a chargé le document. Le chargement est enregistré dans le journal d’audit.
• Les actions personnalisées que le support TrakIT peut définir pour Upload Document s’exécutent après le chargement.
• Personne n’est prévenu par e-mail : l’option Notify Users de l’application n’a pas d’équivalent ici.
• Les images PNG et JPG plus grandes que la taille d’image maximale de l’installation (800 pixels sur le plus grand côté par défaut) sont réduites lors de leur enregistrement.
• Un nouvel envoi du même fichier avec le même titre est refusé : une nouvelle tentative ne peut donc pas l’ajouter deux fois.