Aller au contenu
Documentation TrakIT

CloseWO

Clôture les ordres de travail que vous listez, comme le fait Close Work Order sur la page Ordre de travail. Utilisez-le lorsque le travail est terminé dans votre système. Pour annuler plutôt des ordres de travail, utilisez CancelWO ; pour rouvrir des ordres de travail clôturés, utilisez ReopenWO.

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

POST /api/v1/CloseWO
Token: your-token
Content-Type: application/json
[48211, 48212, 48299]
Champ Obligatoire Signification
Le corps Oui Une liste JSON d’identifiants d’ordres de travail, des nombres entiers. Pas un objet : la liste elle-même est le corps.

TrakIT clôture les ordres de travail un par un, dans l’ordre de la liste. Chacun est clôturé ou refusé séparément : un refus n’arrête pas les autres et ne revient pas sur ceux déjà clôturés. Les autres ordres de travail de leurs dossiers ne sont pas clôturés.

Règles

Section intitulée « Règles »

Pour la requête :

Règle Info en cas d’échec
L’en-tête Token contient un jeton valide. Token missing in header, Token invalid or expired, ou une autre réponse listée dans Jeton de connexion
L’utilisateur est un administrateur système avec un accès à l’API. API User must be SysAdmin with API Access
Le corps est une liste d’au moins un identifiant. No WO IDs supplied

Pour chaque ordre de travail, dans le Info de son élément dans RetInfo :

Règle Info en cas d’échec
Un ordre de travail a cet identifiant. No such work order
Les validations de votre société pour Save WO Header, Save Job Header et Close Manually sont satisfaites. Leurs propres messages
Si le workflow a des opérations d’entrepôt et que l’ordre de travail a des articles d’entrepôt, ceux-ci sont confirmés. Items not committed

Un ordre de travail déjà clôturé ou annulé reste tel quel, et son Info indique Work Order is already closed. ou Work Order is already cancelled.

Réponse

Section intitulée « Réponse »

RetInfo contient un élément pour chaque identifiant, dans l’ordre où vous les avez envoyés. RowsAffected est le nombre d’éléments dont Success vaut true. Code vaut 1 quand au moins un élément a Success à true, et 0 quand aucun ne l’a ; Info est vide dans les deux cas. Lisez toujours les éléments.

{
  "Code": 1,
  "Info": "",
  "RetInfo": [
    { "WOID": 48211, "Success": true, "Info": "" },
    { "WOID": 48212, "Success": false, "Info": "Items not committed" },
    { "WOID": 48299, "Success": false, "Info": "No such work order" }
  ],
  "RowsAffected": 1,
  "Scalar": null,
  "Identity": 0
}
Champ Signification
WOID L’identifiant de l’ordre de travail, tel que vous l’avez envoyé.
Success true quand TrakIT a accepté l’ordre de travail, false quand il l’a refusé.
Info La raison du refus de l’ordre de travail, ou une note. Vide quand cette requête l’a clôturé. Lisez-le avec Success : voir Règles pour un ordre de travail déjà clôturé ou annulé.

Notes

Section intitulée « Notes »
  • Un ordre de travail clôturé prend le statut Closed (3 dans GetWO), avec la date et l’utilisateur de l’API comme utilisateur qui l’a clôturé. Son journal d’audit indique Closed via API.
  • Pour chaque ordre de travail clôturé, TrakIT évalue ses champs de données calculés, exécute les actions d’événements et de données qui sont dues et les actions de votre société pour Close Manually, et avertit les utilisateurs abonnés aux notifications Close WO.
  • Si une requête expire, vous pouvez la renvoyer : les ordres de travail déjà clôturés restent tels quels.