> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/field-service/form/template.md).

# Form templates

The reusable definition a single-use form is created from.

A form template is the definition a [form](/docs/navixy-api/user-api/resources/field-service/form.md) is created from. The paper analogy is exact: the template is the printed master, and each form filled from it is one sheet, filled once and then kept as it was.

That separation is why the API works this way. A template's fields can be added, removed, or reordered over time, and none of that changes a form already filled, so an old form always reads exactly as it was submitted. It also means a user attaching a form to a task or a check-in picks a template rather than rebuilding the fields each time.

## Form template object

## The FormTemplate object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"FormTemplate":{"type":"object","description":"A reusable set of form fields. Each form is issued from a template, and changing a template afterwards does not alter forms already issued from it.","properties":{"id":{"type":"integer","description":"ID of the template."},"label":{"type":"string","description":"Template label, 1 to 100 characters.","minLength":1,"maxLength":100},"description":{"type":["string","null"],"description":"Template description. May be empty or null."},"version":{"type":"integer","description":"Auto-incrementing version number, raised on every modification."},"fields":{"type":"array","description":"The template fields. See the form fields and values reference for the shape of each type.","items":{"type":"object","additionalProperties":true}},"created":{"type":"string","description":"When this template was created. **Read-only.**","readOnly":true},"updated":{"type":"string","description":"When this template was last modified. **Read-only.**","readOnly":true},"submit_in_zone":{"type":"boolean","description":"When `true`, forms from this template can only be submitted inside the task zone."},"default":{"type":"boolean","description":"When `true`, this template is chosen by default for every new task that takes a form."}}}}}}
```

The `fields` entries are described in [Form fields and values](/docs/navixy-api/user-api/resources/field-service/form/field-types.md).

## API actions

API base path: `/form/template`.

Operations that list no errors of their own return only the [general error codes](/docs/navixy-api/general/errors.md#error-codes).

***

## List form templates

> List the form templates of the current user.\
> \
> Callable with an empty body. Also accepts GET.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Forms","description":"Forms and the templates they are issued from. All resources under the /form/ path. Forms attached to tasks are under /task/form/ and carry the Tasks tag."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"FormTemplate":{"type":"object","description":"A reusable set of form fields. Each form is issued from a template, and changing a template afterwards does not alter forms already issued from it.","properties":{"id":{"type":"integer","description":"ID of the template."},"label":{"type":"string","description":"Template label, 1 to 100 characters.","minLength":1,"maxLength":100},"description":{"type":["string","null"],"description":"Template description. May be empty or null."},"version":{"type":"integer","description":"Auto-incrementing version number, raised on every modification."},"fields":{"type":"array","description":"The template fields. See the form fields and values reference for the shape of each type.","items":{"type":"object","additionalProperties":true}},"created":{"type":"string","description":"When this template was created. **Read-only.**","readOnly":true},"updated":{"type":"string","description":"When this template was last modified. **Read-only.**","readOnly":true},"submit_in_zone":{"type":"boolean","description":"When `true`, forms from this template can only be submitted inside the task zone."},"default":{"type":"boolean","description":"When `true`, this template is chosen by default for every new task that takes a form."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/form/template/list":{"post":{"tags":["Forms"],"summary":"List form templates","description":"List the form templates of the current user.\n\nCallable with an empty body. Also accepts GET.","operationId":"formTemplateList","responses":{"200":{"description":"The templates","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","items":{"$ref":"#/components/schemas/FormTemplate"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

***

*Required sub-user rights:* `form_template_update`.

## Create form template

> Create a form template, and return its ID.\
> \
> A form is a one-shot entity: once someone fills it in, it is stored with its values for reference and cannot be reused. Templates exist so the same set of fields can be issued over and over, and so that changing the template later does not alter forms already filled in.\
> \
> Requires the \`form\_template\_update\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Forms","description":"Forms and the templates they are issued from. All resources under the /form/ path. Forms attached to tasks are under /task/form/ and carry the Tasks tag."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"FormTemplate":{"type":"object","description":"A reusable set of form fields. Each form is issued from a template, and changing a template afterwards does not alter forms already issued from it.","properties":{"id":{"type":"integer","description":"ID of the template."},"label":{"type":"string","description":"Template label, 1 to 100 characters.","minLength":1,"maxLength":100},"description":{"type":["string","null"],"description":"Template description. May be empty or null."},"version":{"type":"integer","description":"Auto-incrementing version number, raised on every modification."},"fields":{"type":"array","description":"The template fields. See the form fields and values reference for the shape of each type.","items":{"type":"object","additionalProperties":true}},"created":{"type":"string","description":"When this template was created. **Read-only.**","readOnly":true},"updated":{"type":"string","description":"When this template was last modified. **Read-only.**","readOnly":true},"submit_in_zone":{"type":"boolean","description":"When `true`, forms from this template can only be submitted inside the task zone."},"default":{"type":"boolean","description":"When `true`, this template is chosen by default for every new task that takes a form."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/form/template/create":{"post":{"tags":["Forms"],"summary":"Create form template","description":"Create a form template, and return its ID.\n\nA form is a one-shot entity: once someone fills it in, it is stored with its values for reference and cannot be reused. Templates exist so the same set of fields can be issued over and over, and so that changing the template later does not alter forms already filled in.\n\nRequires the `form_template_update` right.","operationId":"formTemplateCreate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"allOf":[{"$ref":"#/components/schemas/FormTemplate"}],"description":"The template to create, without `id`, `created` or `updated`. **`default` must be sent**, including as `false`: omitting it fails with error 7 and `template.default must not be null`. Each entry in `fields` also carries required properties that depend on its `type`, for example `max_length` on a text field; the form field types reference documents them per type."}},"required":["template"]}}}},"responses":{"200":{"description":"The created template","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"id":{"type":"integer","description":"ID of the new form template."}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 101: the current user has the demo flag, and this operation is disabled in demo mode.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 101 - In demo mode this function disabled - if current user has "demo" flag.

***

## Read form template

> Return one form template by ID.\
> \
> Also accepts GET with the same parameters as query-string values.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Forms","description":"Forms and the templates they are issued from. All resources under the /form/ path. Forms attached to tasks are under /task/form/ and carry the Tasks tag."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"FormTemplate":{"type":"object","description":"A reusable set of form fields. Each form is issued from a template, and changing a template afterwards does not alter forms already issued from it.","properties":{"id":{"type":"integer","description":"ID of the template."},"label":{"type":"string","description":"Template label, 1 to 100 characters.","minLength":1,"maxLength":100},"description":{"type":["string","null"],"description":"Template description. May be empty or null."},"version":{"type":"integer","description":"Auto-incrementing version number, raised on every modification."},"fields":{"type":"array","description":"The template fields. See the form fields and values reference for the shape of each type.","items":{"type":"object","additionalProperties":true}},"created":{"type":"string","description":"When this template was created. **Read-only.**","readOnly":true},"updated":{"type":"string","description":"When this template was last modified. **Read-only.**","readOnly":true},"submit_in_zone":{"type":"boolean","description":"When `true`, forms from this template can only be submitted inside the task zone."},"default":{"type":"boolean","description":"When `true`, this template is chosen by default for every new task that takes a form."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/form/template/read":{"post":{"tags":["Forms"],"summary":"Read form template","description":"Return one form template by ID.\n\nAlso accepts GET with the same parameters as query-string values.","operationId":"formTemplateRead","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template_id":{"type":"integer","description":"ID of the form template.","minimum":1}},"required":["template_id"]}}}},"responses":{"200":{"description":"The template","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"value":{"$ref":"#/components/schemas/FormTemplate"}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 201 - Not found in the database - if there is no template with such an ID.

***

*Required sub-user rights:* `form_template_update`.

## Update form template

> Update a form template. Pass a full template object including its \`id\`.\
> \
> \*\*Forms already created from this template are not changed.\*\* Each keeps the fields it was issued with, which is the reason templates and forms are separate entities. \`version\` increments on every modification.\
> \
> Requires the \`form\_template\_update\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Forms","description":"Forms and the templates they are issued from. All resources under the /form/ path. Forms attached to tasks are under /task/form/ and carry the Tasks tag."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"FormTemplate":{"type":"object","description":"A reusable set of form fields. Each form is issued from a template, and changing a template afterwards does not alter forms already issued from it.","properties":{"id":{"type":"integer","description":"ID of the template."},"label":{"type":"string","description":"Template label, 1 to 100 characters.","minLength":1,"maxLength":100},"description":{"type":["string","null"],"description":"Template description. May be empty or null."},"version":{"type":"integer","description":"Auto-incrementing version number, raised on every modification."},"fields":{"type":"array","description":"The template fields. See the form fields and values reference for the shape of each type.","items":{"type":"object","additionalProperties":true}},"created":{"type":"string","description":"When this template was created. **Read-only.**","readOnly":true},"updated":{"type":"string","description":"When this template was last modified. **Read-only.**","readOnly":true},"submit_in_zone":{"type":"boolean","description":"When `true`, forms from this template can only be submitted inside the task zone."},"default":{"type":"boolean","description":"When `true`, this template is chosen by default for every new task that takes a form."}}}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/form/template/update":{"post":{"tags":["Forms"],"summary":"Update form template","description":"Update a form template. Pass a full template object including its `id`.\n\n**Forms already created from this template are not changed.** Each keeps the fields it was issued with, which is the reason templates and forms are separate entities. `version` increments on every modification.\n\nRequires the `form_template_update` right.","operationId":"formTemplateUpdate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"allOf":[{"$ref":"#/components/schemas/FormTemplate"}],"description":"The template to update, including its `id`."}},"required":["template"]}}}},"responses":{"200":{"description":"Template updated","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 101: the current user has the demo flag, and this operation is disabled in demo mode.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 101 - In demo mode this function disabled - if current user has "demo" flag.
* 201 - Not found in the database - if there is no template with such an ID.

***

*Required sub-user rights:* `form_template_update`.

## Delete form template

> Delete a form template by ID.\
> \
> Forms already created from it survive, with \`template\_id\` set to null.\
> \
> Also accepts GET with the same parameters as query-string values.\
> \
> Requires the \`form\_template\_update\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Forms","description":"Forms and the templates they are issued from. All resources under the /form/ path. Forms attached to tasks are under /task/form/ and carry the Tasks tag."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/form/template/delete":{"post":{"tags":["Forms"],"summary":"Delete form template","description":"Delete a form template by ID.\n\nForms already created from it survive, with `template_id` set to null.\n\nAlso accepts GET with the same parameters as query-string values.\n\nRequires the `form_template_update` right.","operationId":"formTemplateDelete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template_id":{"type":"integer","description":"ID of the form template to delete.","minimum":1}},"required":["template_id"]}}}},"responses":{"200":{"description":"Template deleted","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 101: the current user has the demo flag, and this operation is disabled in demo mode.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 101 - In demo mode this function disabled - if current user has "demo" flag.
* 201 - Not found in the database - if there is no template with such an ID.

***

*Required sub-user rights:* none.

## Read template usage

> Return how many tasks and task schedules use a form template.\
> \
> Useful before deleting a template, to see what is still relying on it.\
> \
> Also accepts GET with the same parameters as query-string values.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Forms","description":"Forms and the templates they are issued from. All resources under the /form/ path. Forms attached to tasks are under /task/form/ and carry the Tasks tag."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/form/template/stats/read":{"post":{"tags":["Forms"],"summary":"Read template usage","description":"Return how many tasks and task schedules use a form template.\n\nUseful before deleting a template, to see what is still relying on it.\n\nAlso accepts GET with the same parameters as query-string values.","operationId":"formTemplateStatsRead","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template_id":{"type":"integer","description":"ID of the form template.","minimum":1}},"required":["template_id"]}}}},"responses":{"200":{"description":"The usage counts","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"tasks":{"type":"object","description":"How many tasks use this template, broken down by task status.","properties":{"unassigned":{"type":"integer","description":"Tasks not assigned to anyone."},"assigned":{"type":"integer","description":"Tasks assigned to a performer."},"done":{"type":"integer","description":"Completed tasks."},"failed":{"type":"integer","description":"Failed tasks."},"delayed":{"type":"integer","description":"Delayed tasks."},"arrived":{"type":"integer","description":"Tasks whose performer reached the zone without completing them."},"faulty":{"type":"integer","description":"Tasks completed with problems."}}},"scheduled":{"type":"integer","description":"Number of task schedules using this template."}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 201 - Not found in the database - if template with the specified ID does not exist.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/resources/field-service/form/template.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.