API de listas de verificação

A API /checklists/ foi criada para permitir que os usuários baixem e analisem as respostas às perguntas de checklist no DISPATCH da L2L. Cada registro retornado por esta API representa um checklist que foi criado a partir de um Despacho, do Portal do Operador ou manualmente.

Filtrando checklists

A API /checklists/ pode ser filtrada e classificada por qualquer uma das principais propriedades, como: site, nome do documento, despacho, produto, linha, máquina etc.

Perguntas e respostas

As perguntas e respostas são encontradas nas propriedades tasks e answers, respectivamente.  

A lista tasks contém todas as perguntas que estavam na versão publicada do checklist no momento em que o checklist foi criado. Se uma nova versão de um checklist for publicada e um usuário optar por atualizar as perguntas do checklist, a lista tasks também será atualizada na API.

A lista answers contém todas as respostas inseridas no checklist. Cada resposta possui uma propriedade task_number, que é o índice da pergunta na lista tasks à qual a resposta corresponde. Por exemplo, se uma resposta tiver um task_number igual a 3, a pergunta relacionada será o terceiro item da lista tasks.

A API de respostas também possui os critérios de aprovado, reprovado e aviso, caso você esteja usando a pontuação do checklist. A API fornecerá um número: 0 = Aprovado, 1 = Aviso, 2 = Reprovado

 

Tabelas

As perguntas e respostas dos checklists que estão dentro de tabelas também são incluídas na API /checklists/. O objeto task define a tabela, incluindo os cabeçalhos das colunas, as informações de linhas e colunas e as definições das perguntas. As respostas são incluídas na lista answers, e a pergunta associada pode ser encontrada na lista tasks usando as propriedades task_number, table_row_number e table_column_number.

Considerações de desenvolvimento

• A propriedade task_hash no objeto de tarefa e no objeto de resposta existe por motivos de legado. Essa propriedade não deve ser usada para vincular perguntas e respostas de tarefas.
• A API /checklistsanswers/ foi desenvolvida e lançada antes que as respostas fossem incluídas no payload da API /checklists/ e continuará fornecendo respostas no futuro. No entanto, o objeto de respostas no payload de /checklists/ é mais robusto e é o método preferencial para obter respostas de checklists.