---
title: "FormTemplates"
slug: "formtemplates-1"
updated: 2023-06-15T18:07:00Z
published: 2023-06-15T18:07:00Z
canonical: "docs.visualvault.com/formtemplates-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.visualvault.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FormTemplates

#### **GET **/FormTemplates****

---

> **Get a list of form templates.**

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| form_status | String | Form release status. - unreleased - released - both |
| status | String | Form release status. - unreleased - released - both |
| sort | String | The name of a data column to sort by. |
| sortDir | String | Sort direction. - asc: Ascending order - desc: Descending order |
| q | String | A VisualVault REST API Data Query. |

#### **GET **/FormTemplates/{id}****

---

> **Returns a form template by ID.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The form template id. |

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| formstatus | String | Form release status. - unreleased - released - both |
| q | String | A VisualVault REST API Data Query. |

#### **GET **/FormTemplates/{id}/forms/{childId}****

---

> **Get the child form of a template.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The form template id. |
| childId* | Guid | The child form template id. |

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | List of fields to include. |
| f | String | List of requested form fields. |
| getFieldProperties | Bool | Get properties of the fields. |
| expand | Bool | Set to true to get all the form's fields. |
| offset | String | Sets an offset to the start of the search. |
| limit | Int | Sets a limit to the number of values returned. |

#### **GET **/FormTemplates/{id}/forms/{childId}/PDF****

---

> **Retrieve a child form in PDF format.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The form template id. |
| childId* | Guid | The child form template id. |

#### **GET **/FormTemplates/{id}/fields****

---

> **Get the form fields of a template.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The form template id. |

#### **GET **/FormTemplates/{id}/forms****

---

> **Get the form instances of a form template.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The form template id. |

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | List of fields to include. |
| getFieldProperties | Bool | Get properties of the fields. |
| expand | Bool | Set to true to get all the form's fields. |
| sort | String | The name of a data column to sort by. |
| sortDir | String | Sort direction. - asc: Ascending order - desc: Descending order |
| offset | String | Sets an offset to the start of the search. |
| limit | Int | Sets a limit to the number of values returned. |
| q | String | A VisualVault REST API Data Query. |

#### **GET **/FormTemplates/{id}/docInfo****

---

> **Retrieve the next sequential document ID for the template.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The form template id. |

#### **POST **/FormTemplates/{id}/forms****

---

> **Create a new form instance from the template.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The form template id. |

##### ****Body Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| formFields | {FieldList} | A list of field values to be saved. |

##### ****Response Codes****

| Code | Description |
| --- | --- |
| 201 | Created |

#### **POST **/FormTemplates/{id}/forms/{childId}****

---

> **Create a new revision of an existing form instance.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The form template id. |
| childId* | Guid | The form instance id. |

##### ****Body Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| formFields | {FieldList} | A list of field values to be saved. |

##### ****Response Codes****

| Code | Description |
| --- | --- |
| 201 | Created |

#### **GET **/formtemplates/scripts/globalscripts****

---

> **Get the global scripts for a form template.**

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| hashonly | Bool | Return only a hash code. |

#### **GET **/formtemplates/scripts/templatescripts/{id}****

---

> **Get the template scripts for a form template.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The template script id. |

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| hashonly | Bool | Return only a hash code. |