QC template

A QC template version is the set of questions an inspection set gets filled from. Templates are versioned, so this resource lists versions rather than templates: qcTemplateId is the template, and versionNumber is the revision. Search columns: name

Fields

Every property the API returns for a QC template version.

Field	Type	Notes
`id`	UUID	Unique id of this version. Read-only.
`organizationId`	UUID	Your organization. Taken from the API key. Read-only.
`qcTemplateId`	UUID	The template these versions belong to. Read-only.
`name`	string	Template name. Read-only.
`description`	string \| null	What the template is for. Read-only.
`versionNumber`	number	Version number within the template. Read-only.
`isDraft`	boolean	`true` while the version is still a draft. Read-only.
`requiresPassFail`	boolean	`true` when the template ends in a pass/fail verdict rather than being questions-only. Read-only.
`externallyFillable`	boolean	`true` when the set can be filled by someone outside your organization. Defaults to `false`. Read-only.
`captureLocationOnSubmit`	boolean	`true` when submitting a set records the submitter’s location. Defaults to `false`. Read-only.
`questions`	object[] \| null	The template’s questions, in display order. See `questions` below. Read-only.
`template`	object	The parent template this version belongs to: `id`, `organizationId`, `createdAt`, `updatedAt`. The same id as `qcTemplateId`. Read-only.
`createdAt`	date-time	When the version was created. Read-only.
`updatedAt`	date-time	When the version last changed. Read-only.

`questions`

An array, in the order the questions are shown. Each entry:

Field	Type	Notes
`id`	UUID	Unique id of the question within the version.
`type`	string	How the question is answered, for example `text`. Set by the template editor.
`title`	string	The question itself.
`description`	string	Extra guidance for whoever fills it in. Empty when unset.
`options`	object[]	Choices for the question, each `{ id, title }`. Present even for types that take no choices, where the titles are empty.

[
  {
    "id": "ea8ab1e3-d9d4-4fc3-95be-ff74a6767a37",
    "type": "text",
    "title": "Is the framing square? What are the diagonal measurements?",
    "description": "",
    "options": [{ "id": "ab1d9746-f8aa-4aa7-979e-f1583f5954c7", "title": "" }]
  }
]

Read and delete only. POST /qc-template always fails server-side, and PATCH /qc-template/{id} accepts the request but writes nothing. Build and edit templates in the BuildingSwell app, and use this resource to read and to remove versions.

Available endpoints: GET /qc-template, GET /qc-template/{id}, GET /qc-template/count, POST /qc-template/count, POST /qc-template/query, POST /qc-template/group-and-count, and DELETE /qc-template/{id}.

Pass/fail versus questions-only

requiresPassFail separates the two kinds of template. A pass/fail template ends in a verdict and acts as a gate. A questions-only template captures a reason and records it, which is why the automatic hold and due-date forms use it.

Drafts

isDraft is true while a version is still being edited. Filter drafts out when you only want versions in use:

GET /qc-template?isDraft=false

Deleting

DELETE /qc-template/{id} is destructive.Permanently removes the template version. This cannot be undone.QC sets reference a version through templateId, and that link is ON DELETE RESTRICT, so the call comes back as 409 while any set still points at this version.

See archiving and deleting for the full picture across resources.

Getting started

Core concepts

Resources

Materials and inventory

Delivery

Organization lists

Domain concepts

Examples

Fields

`questions`

Pass/fail versus questions-only

Drafts

Deleting