Checklist-API

De /checklists/-API is gemaakt om gebruikers in staat te stellen antwoorden op checklistvragen in L2L's DISPATCH te downloaden en te analyseren. Elk record dat door deze API wordt geretourneerd, vertegenwoordigt een checklist die is aangemaakt vanuit een Verzenden, het Operator Portal of handmatig.

Checklists filteren

De /checklists/-API kan worden gefilterd en gesorteerd op alle belangrijke eigenschappen, zoals: site, documentnaam, Verzenden, product, lijn, machine, enzovoort.

Vragen en antwoorden

Vragen en antwoorden zijn te vinden onder respectievelijk de eigenschappen tasks en answers.  

De lijst tasks bevat alle vragen die in de gepubliceerde versie van de checklist stonden op het moment dat de checklist werd aangemaakt. Als er een nieuwe versie van een checklist wordt gepubliceerd en een gebruiker ervoor kiest om de checklistvragen bij te werken, wordt de lijst tasks ook bijgewerkt in de API.

De lijst answers bevat alle antwoorden die op de checklist zijn ingevoerd. Elk antwoord heeft een eigenschap task_number, die de index is van de vraag in de lijst tasks waarop het antwoord betrekking heeft. Als een antwoord bijvoorbeeld een task_number van 3 heeft, is de bijbehorende vraag het derde item in de lijst tasks.

De antwoorden-API bevat ook de criteria voor geslaagd, mislukt en waarschuwing als je checklistscoring gebruikt. De API geeft je een getal: 0 = Geslaagd, 1 = Waarschuwing, 2 = Mislukt

 

Tabellen

Vragen en antwoorden voor checklists die zich in tabellen bevinden, zijn ook opgenomen in de /checklists/-API. Het task-object definieert de tabel, inclusief kolomkoppen, rij- en kolominformatie en vraagdefinities. Antwoorden zijn opgenomen in de lijst answers en de bijbehorende vraag kan in de lijst tasks worden gevonden door de eigenschappen task_number, table_row_number en table_column_number te gebruiken.

Ontwikkelingsoverwegingen

• De eigenschap task_hash op het task-object en answer-object is aanwezig om legacyredenen. Deze eigenschap mag niet worden gebruikt om taakvragen en antwoorden aan elkaar te koppelen.
• De /checklistsanswers/-API is ontwikkeld en uitgebracht voordat antwoorden werden opgenomen in de payload van de /checklists/-API en zal in de toekomst antwoorden blijven leveren. Het answers-object in de payload van de /checklists/ is echter robuuster en heeft de voorkeur voor het verzamelen van checklistantwoorden.