チェックリスト API

/checklists/ API は、L2L の DISPATCH でチェックリストの質問への回答をダウンロードして分析できるように作成されました。この API で返される各レコードは、発送、オペレーターポータル、または手動で作成されたチェックリストを表します。

チェックリストのフィルタリング

/checklists/ API は、サイト、ドキュメント名、発送、製品、ライン、機械など、主要なプロパティのいずれかでフィルタリングおよび並べ替えができます。

質問と回答

質問と回答は、それぞれ tasks プロパティと answers プロパティ内にあります。  

tasks リストには、チェックリストが作成された時点で公開されていたチェックリストのバージョンに含まれるすべての質問が格納されます。チェックリストの新しいバージョンが公開され、ユーザーがチェックリストの質問を更新することを選択した場合、API の tasks リストも更新されます。

answers リストには、チェックリストに入力されたすべての回答が格納されます。各回答には、回答対象の質問が tasks リスト内のどの位置にあるかを示す task_number プロパティがあります。たとえば、回答の task_number が 3 の場合、関連する質問は tasks リストの 3 番目の項目です。

回答 API には、チェックリストのスコアリングを使用している場合の合格、失格、警告の基準も含まれています。API は数値を返します。0 = 合格、1 = 警告、2 = 失格

 

テーブル

テーブル内にあるチェックリストの質問と回答も /checklists/ API に含まれます。task オブジェクトでは、列見出し、行と列の情報、質問の定義など、テーブルが定義されています。回答は answers リストに含まれており、task_number、table_row_number、table_column_number プロパティを使用して、関連する質問を tasks リスト内から見つけることができます。

開発に関する考慮事項

• タスクオブジェクトと回答オブジェクトの task_hash プロパティは、レガシー上の理由で存在します。このプロパティを使用してタスクの質問と回答を関連付けないでください。
• /checklistsanswers/ API は、回答が /checklists/ API のペイロードに含まれるようになる前に開発・リリースされ、今後も回答を提供し続けます。ただし、/checklists/ ペイロードの answers オブジェクトの方が堅牢であり、チェックリストの回答を取得するための推奨方法です。