API de listes de contrôle

L’API /checklists/ a été créée pour permettre aux utilisateurs de télécharger et d’analyser les réponses aux questions des listes de contrôle dans le DISPATCH de L2L. Chaque enregistrement renvoyé par cette API représente une liste de contrôle créée à partir d’une Expédition, du portail opérateur ou manuellement.

Filtrage des listes de contrôle

L’API /checklists/ peut être filtrée et triée selon l’une des principales propriétés, telles que : site, nom du document, expédition, produit, ligne, machine, etc.

Questions et réponses

Les questions et les réponses se trouvent respectivement dans les propriétés tasks et answers.  

La liste tasks contient toutes les questions qui figuraient dans la version publiée de la liste de contrôle au moment de sa création. Si une nouvelle version d’une liste de contrôle est publiée et qu’un utilisateur choisit de mettre à jour les questions de la liste de contrôle, la liste tasks sera également mise à jour dans l’API.

La liste answers contient toutes les réponses saisies dans la liste de contrôle. Chaque réponse possède une propriété task_number qui correspond à l’index de la question dans la liste tasks à laquelle la réponse se rapporte. Par exemple, si une réponse possède une valeur task_number de 3, la question correspondante est le troisième élément de la liste tasks.

L’API des réponses contient également les critères de réussite, d’échec et d’avertissement si vous utilisez la notation des listes de contrôle. L’API vous donnera un nombre : 0 = réussite, 1 = avertissement, 2 = échec

 

Tableaux

Les questions et les réponses des listes de contrôle qui se trouvent dans des tableaux sont également incluses dans l’API /checklists/. L’objet task définit le tableau, y compris les en-têtes de colonnes, les informations sur les lignes et les colonnes, ainsi que les définitions des questions. Les réponses sont incluses dans la liste answers, et la question associée peut être trouvée dans la liste tasks en utilisant les propriétés task_number, table_row_number et table_column_number.

Considérations relatives au développement

• La propriété task_hash de l’objet task et de l’objet answer est présente pour des raisons de compatibilité avec les anciennes versions. Cette propriété ne doit pas être utilisée pour relier les questions et les réponses des tâches.
• L’API /checklistsanswers/ a été développée et publiée avant que les réponses ne soient incluses dans la charge utile de l’API /checklists/, et continuera à fournir des réponses à l’avenir. Cependant, l’objet answers dans la charge utile de /checklists/ est plus complet et constitue la méthode privilégiée pour recueillir les réponses aux listes de contrôle.