UploadDoc

Joint un fichier à une fiche autre qu’un dossier ou un ordre de travail : un actif, une facture fournisseur, un encaissement, une facture, un devis, un utilisateur, un mouvement de parc ou une activité. Le fichier apparaît ensuite avec les fichiers de la fiche dans TrakIT, par exemple dans l’onglet Files d’une facture fournisseur. Pour les documents d’un dossier ou d’un ordre de travail, utilisez UploadJobDoc.

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

Partie	Obligatoire	Signification
`Ref`	Oui	Le type de fiche, d’après le tableau ci-dessous. Insensible à la casse.
`RefID`	Oui	L’identifiant de la fiche, un nombre entier.
`Title`	Non	Le titre du fichier, jusqu’à 300 caractères. Sans titre, le titre est le nom du fichier sans son extension.
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é.

Fiches

`Ref`	`RefID`	Où le fichier apparaît
`asset`	L’identifiant de l’actif.	L’onglet Asset Files de l’actif
`bill`	L’identifiant de la facture fournisseur.	L’onglet Files de la facture fournisseur
`receipt`	L’identifiant de l’encaissement.	L’onglet Documents de l’encaissement
`invoice`	L’identifiant de la facture.	L’onglet Files de la facture
`quotation`	L’identifiant du devis.	L’onglet Documents du devis
`user`	Le numéro interne de l’utilisateur, pas son identifiant utilisateur.	L’onglet User Files de l’utilisateur
`yardmove`	L’identifiant du mouvement de parc.	L’onglet Files du mouvement
`activity`	L’identifiant de l’activité.	L’onglet Activity Files de l’activité

Règles

Règle	`Info` en cas d’échec
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`
`Ref` est indiqué.	`Parameter Ref is missing`
`RefID` est indiqué, sous forme de nombre.	`Parameter RefID is missing`, `Parameter RefID must be a number`
`Ref` est l’une des valeurs ci-dessus.	`Ref is invalid`
La fiche existe.	`Reference object doesn't exist`
La fiche n’a pas encore de fichier de même nom et de même taille.	`A file of the same name and size already exists`
Le titre fait 300 caractères au plus.	`Unable to add attachment`

Réponse

En cas de succès, Code vaut 1 et Identity est l’identifiant du nouveau fichier. RetInfo vaut null, et RowsAffected et Scalar ne sont pas utilisés.

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

Exemple

Avec 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

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

Notes

Le fichier est réservé aux utilisateurs internes. Sur une facture fournisseur, par exemple, il n’est pas marqué External : le fournisseur ne le voit donc pas dans le portail.
L’utilisateur de l’API apparaît comme la personne qui l’a chargé.
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 est refusé avec A file of the same name and size already exists : une nouvelle tentative ne peut donc pas l’ajouter deux fois.