Show the full form template corresponding to the provided id

get https://client-api.{region}.fieldwire.com/api/v3/projects/{project_id}/form_templates/{id}/full

Responses

Response body

object

uuid

required

ID of the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

project_id

uuid

required

ID of the project this entity belongs to

is_generated

boolean

required

Whether this template is fully generated (in case cloning from another template)

checksum

string | null

Checksum used for verifying whether all relevant information for a form template is at hand

name

string

required

Name of the template

kind

string

required

Kind of the template

default time_range single_day

version

int32

required

Version number of the Form Template. Publishing increases version. Starts at 0.

created_at

date-time

required

Time when the server created the entity

deleted_at

date-time | null

Time the server deleted the entity

device_created_at

date-time

required

Time when the device created the entity

device_updated_at

date-time

required

Time when the device last updated the entity

resolved_conflict

boolean | null

required

Specifies if PUT/PATCH request was rejected - do not store this field!

published_at

date-time | null

Time when the Form Template is published

updated_at

date-time

required

Time when the server last updated the entity

view_edit_permissions

string | null

View/edit permissions for the template, e.g. assignee, all_users

assignee all_users

form_type

string

required

The type of form either custom fieldwire or a fillable_pdf

default fillable_pdf

form_template_form_statuses

array of objects

form_template_form_statuses

object

uuid

required

ID of the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

owner_user_id

int32 | null

ID of the user who owns this project

form_template_id

uuid

required

ID of the template this status belongs to

project_id

uuid

required

ID of the project this entity belongs to

is_editable

boolean

required

Flag to show if status is editable (must be true if ordinal is 1)

name

string

required

Name of the entity

ordinal

int32

required

Specifies the ordering among siblings

required_role_in

string

required

User role required to move a Form into this status

member follower admin

required_role_out

string

required

User role required to move a Form out of this status

member follower admin

created_at

date-time

required

Time when the server created the entity

deleted_at

date-time | null

Time the server deleted the entity

device_created_at

date-time

required

Time when the device created the entity

device_updated_at

date-time

required

Time when the device last updated the entity

resolved_conflict

boolean

required

Specifies if PUT/PATCH request was rejected - do not store this field!

updated_at

date-time

required

Time when the server last updated the entity

form_template_sections

array of objects

form_template_sections

object

uuid

required

ID of the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

form_template_id

uuid

required

ID of the template this belongs to

project_id

uuid

required

ID of the project this entity belongs to

name

string

required

Name of the entity

ordinal

int32

required

Specifies the ordering among siblings

description

string | null

A short description of the entity

created_at

date-time

required

Time when the server created the entity

deleted_at

date-time | null

Time the server deleted the entity

device_created_at

date-time

required

Time when the device created the entity

device_updated_at

date-time

required

Time when the device last updated the entity

resolved_conflict

boolean

required

Specifies if PUT/PATCH request was rejected - do not store this field!

updated_at

date-time

required

Time when the server last updated the entity

summary_expression

string | null

Represents a type of summary expression for the section

form_template_section_records

array of objects

form_template_section_records

object

uuid

required

ID of the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

form_template_section_id

uuid

required

ID of the section this belongs to

project_id

uuid

required

ID of the project this entity belongs to

name

string | null

Name of the entity

max_values

int32

required

Max number of values this record can have

min_values

int32

required

Min number of values this record should have

ordinal

int32

required

Specifies the ordering among siblings

created_at

date-time

required

Time when the server created the entity

deleted_at

date-time | null

Time the server deleted the entity

device_created_at

date-time

required

Time when the device created the entity

device_updated_at

date-time

required

Time when the device last updated the entity

resolved_conflict

boolean

required

Specifies if PUT/PATCH request was rejected - do not store this field!

updated_at

date-time

required

Time when the server last updated the entity

form_template_section_record_inputs

array of objects

form_template_section_record_inputs

object

uuid

required

ID of the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

data_type_id

uuid | null

ID of the DataType this input wants a value of (for kind data_input)

form_template_section_record_id

uuid

required

ID of the record this belongs to

project_id

uuid

required

ID of the project this entity belongs to

entity_type

string | null

Type of entity this input wants a value of (for kind entity_input)

expression

string | null

Expression to use to automatically compute the value using

kind

string

required

Kind of the entity

data_input entity_input sign_input weather

max_values

int32

required

Max number of values this input can have

min_values

int32

required

Min number of values this input should have

ordinal

int32

required

Specifies the ordering among siblings

created_at

date-time

required

Time when the server created the entity

deleted_at

date-time | null

Time the server deleted the entity

device_created_at

date-time

required

Time when the device created the entity

device_updated_at

date-time

required

Time when the device last updated the entity

resolved_conflict

boolean | null

required

Specifies if PUT/PATCH request was rejected - do not store this field!

updated_at

date-time

required

Time when the server last updated the entity

summary_expression

string | null

Represents types of summary expressions where the record input is included

default_entity_id

uuid | null

required

ID of the entity use when creating a new form

data_type

object | null

Represents a kind of value (usually as part of a Form entry)

default_entity

Headers

object

X-Current-User-Id

integer

Current user's id

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://client-api.us.fieldwire.com/api/v3/projects/project_id/form_templates/id/full \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful full response

202Successful jid echo response