Introduction

View as Markdown

HINDSITE API for managing instructions, forms, work orders, defects, and related resources.

Core concepts

Instruction

A reusable template that defines what data to capture during a job — questions, decision branches, validation rules, and conditional logic. An instruction has many revisions; the published revision is the one currently in use.

Instruction revision

A specific version of an instruction. Publishing creates a new revision and preserves the history of what was asked at each point in time.

Work order

A unit of work to be done — typically a maintenance job, inspection, or audit. Groups one or more tasks.

Work order task

A task within a work order that pairs the work order with an instruction so an assigned user can execute it.

Form

The captured data from one execution of an instruction by a user. A form is to an instruction revision what a filled-out paper form is to its blank template.

Defect

An issue raised during form execution — typically an equipment fault found during inspection — with its own approval and resolution lifecycle.

Contact Support: Name: HINDSITE Support