--- title: "Show the full form corresponding to the provided id" method: GET path: "/api/v3/projects/{project_id}/forms/{id}/full" tags: ["forms"] --- # Show the full form corresponding to the provided id `GET /api/v3/projects/{project_id}/forms/{id}/full` ## Path parameters - `project_id` string, uuid, required - `id` string, uuid, required ## Query parameters - `jid` string ## Headers - `Fieldwire-Version` string, date, required ## Response `200` Successful full response - FormFull — Entity that denotes a form - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `owner_user_id` integer, required — ID of the user who owns this form - `form_template_form_status_id` string, uuid, required — ID of the status this form currently is in - `form_template_id` string, uuid, required — ID of the template this form was created from - `project_id` string, uuid, required — ID of the project this entity belongs to - `is_generated` boolean, required — Whether this form is fully generated (in case cloning from another form) - `checksum` string, required — Checksum used for verifying whether all relevant structural information for a form is at hand - `name` string, required — Name of the entity - `kind` 'default' | 'time_range' | 'single_day', required — Kind of the entity - `sequence_number` integer, required — Unique number that denotes this form scoped to the template - `version` integer, required — Version of the template this form was built out of - `created_at` string, date-time, required — Time when the server created the form - `deleted_at` string, date-time, nullable — Time the server deleted the form - `device_created_at` string, date-time, required — Time when the device created the form - `device_updated_at` string, date-time, required — Time when the device last updated the form - `end_at` string, date-time, nullable — Time when this form is marked as ending - `start_at` string, date-time, nullable — Time when this form is marked as starting - `due_date` string, date, nullable — Time when this form is marked as due - `due_date_notified` boolean, nullable — Whether due date notification for this form has been sent - `resolved_conflict` boolean, nullable, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `updated_at` string, date-time, required — Time when the server last updated the form - `view_edit_permissions` 'assignee' | 'all_users' | 'null', nullable — View/edit permissions for the form, e.g. assignee, all_users. Consider using form_permissions instead. - `form_type` 'default' | 'fillable_pdf', required — The type of form either custom fieldwire or a fillable_pdf - `form_sections` object[] - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `form_id` string, uuid, required — ID of the form this belongs to - `form_template_section_id` string, uuid, required — ID of the template this section was created from - `project_id` string, uuid, required — ID of the project this entity belongs to - `name` string, required — Name of the entity - `ordinal` integer, required — Specifies the ordering among siblings - `description` string, nullable — A short description of the entity - `created_at` string, date-time, required — Time when the server created the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time, required — Time when the device created the entity - `device_updated_at` string, 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` string, date-time, required — Time when the server last updated the entity - `form_section_records` object[] - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `form_section_id` string, uuid, required — ID fo the section this belongs to - `form_template_section_record_id` string, uuid, required — ID of the template this record was created from - `project_id` string, uuid, required — ID of the project this entity belongs to - `name` string, nullable — Name of the entity - `max_values` integer, required — Max number of values this record can have - `min_values` integer, required — Min number of values this record should have - `ordinal` integer, required — Specifies the ordering among siblings - `created_at` string, date-time, required — Time when the server created the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time, required — Time when the device created the entity - `device_updated_at` string, 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` string, date-time, required — Time when the server last updated the entity - `form_section_record_inputs` object[] - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `data_type_id` string, uuid, nullable — ID of the `DataType` this input wants a value of (for kind `data_input`) - `form_section_record_id` string, uuid, required — ID of the record this belongs to - `form_template_section_record_input_id` string, uuid, required — ID of the template this input was created from - `project_id` string, uuid, required — ID of the project this entity belongs to - `entity_type` 'Attachment' | 'Floorplan' | 'User' | 'null', nullable — Type of entity this input wants a value of (for kind `entity_input`) - `expression` string, nullable — Expression to use to automatically compute the value using - `kind` 'data_input' | 'entity_input' | 'sign_input' | 'weather', required — Kind of the entity - `max_values` integer, required — Max number of values this input can have - `min_values` integer, required — Min number of values this input should have - `ordinal` integer, required — Specifies the ordering among siblings - `created_at` string, date-time, required — Time when the server created the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time, required — Time when the device created the entity - `device_updated_at` string, 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` string, date-time, required — Time when the server last updated the entity - `summary_expression` string, nullable — Represents types of summary expressions where the record input is included - `default_entity_id` string, uuid, nullable, required — ID of the entity use when creating a new form - `data_type` object, nullable — Represents a kind of value (usually as part of a `Form` entry) - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `project_id` string, uuid, required — ID of the project this entity belongs to - `default_bigint_value` integer, nullable — Default big integer value if the kind is bigint - `default_boolean_value` boolean, nullable — Default boolean value if the kind is boolean - `is_strict` boolean, required — Whether this is strict which means only values from the pre-approved list can be used (denoted by `DataTypeValue`s) - `default_string_value` string, nullable — Default string value if the kind is string (suitable for short form text) - `name` string, required — Name of the entity - `placeholder` string, nullable — Placeholder name to use for this data type to be shown in the UI - `default_date_value` string, date, nullable — Default date value if the kind is date - `default_checkbox_value` 'empty' | 'yes' | 'no' | 'not_applicable' | 'null', nullable — Default checkbox value if the kind is checkbox - `kind` 'bigint' | 'string' | 'text' | 'boolean' | 'decimal' | 'date' | 'datetime' | 'checkbox', required — Kind of the entity - `unit` 'temperature' | 'currency' | 'hours' | 'length' | 'area' | 'volume' | 'mass' | 'null', nullable — The unit of the value this type carries - `default_decimal_value` string, nullable — Default decimal value if the kind is decimal - `default_text_value` string, nullable — Default text value if the kind is text (suitable for long form text) - `created_at` string, date-time, required — Time when the server created the entity - `default_datetime_value` string, date-time, nullable — Default datetime value if the kind is datetime - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time, required — Time when the device created the entity - `device_updated_at` string, date-time, required — Time when the device last updated the entity - `hidden_at` string, date-time, nullable — Time when this type was marked as hidden (can be only done if this is marked as strict) - `resolved_conflict` boolean, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `updated_at` string, date-time, required — Time when the server last updated the entity - `data_type_values` object[] - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `data_type_id` string, uuid, required — ID of the `DataType` this value denotes - `project_id` string, uuid, required — ID of the project this entity belongs to - `bigint_value` integer, nullable — Big integer value if this belongs to a bigint `DataType` - `boolean_value` boolean, nullable — Boolean value if this belongs to a boolean `DataType` - `string_value` string, nullable — String value if this belongs to a string `DataType` (suitable for short form text) - `date_value` string, date, nullable — Date value if this belongs to a date `DataType` - `checkbox_value` 'empty' | 'yes' | 'no' | 'not_applicable' | 'null', nullable — Checkbox value if this belongs to a checkbox `DataType` - `decimal_value` string, nullable — Decimal value if this belongs to a decimal `DataType` - `text_value` string, nullable — Text value if this belongs to a bigint `DataType` (suitable for long form text) - `created_at` string, date-time, required — Time when the server created the entity - `datetime_value` string, date-time, nullable — Date & time value if this belongs to a datetime `DataType` - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time, required — Time when the device created the entity - `device_updated_at` string, date-time, required — Time when the device last updated the entity - `hidden_at` string, date-time, nullable — Time when this value was marked as hidden (can be only done if this belongs to a strict `DataType`) - `resolved_conflict` boolean, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `updated_at` string, date-time, required — Time when the server last updated the entity - `default_entity` union - string, nullable — To allow null values - FillablePdfFormTemplateAttachment — Entity that denotes a form template attachment used for fillable forms - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `project_id` string, uuid, required — ID of the project this entity belongs to - `name` string, required — Name of file - `file_url` string, required — Url of the attachment - `file_size` integer, nullable, required — Size of the attachment - `created_at` string, date-time, required — Time when the server created the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time, required — Time when the device created the entity - `device_updated_at` string, date-time, required — Time when the device last updated the entity - `resolved_conflict` boolean, nullable, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `updated_at` string, date-time, required — Time when the server last updated the entity - `form_section_record_values` object[] - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `form_section_record_id` string, uuid, required — ID of th record this carries the value for - `project_id` string, uuid, required — ID of the project this entity belongs to - `ordinal` integer, required — Specifies the ordering among siblings - `created_at` string, date-time, required — Time when the server created the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time, required — Time when the device created the entity - `device_updated_at` string, date-time, required — Time when the device last updated the entity - `resolved_conflict` boolean, nullable, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `updated_at` string, date-time, required — Time when the server last updated the entity - `form_section_record_input_values` object[] - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, required — ID of the user who created this entity - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity - `user_id` integer, nullable — ID of the user in case the `entity_type` of the input this belongs to is `User` - `form_section_record_input_id` string, uuid, required — ID of the input this is value of - `form_section_record_value_id` string, uuid, required — ID of the record value this belongs to (which groups the appropriate input values together) - `project_id` string, uuid, required — ID of the project this entity belongs to - `value_id` string, uuid, nullable — ID of the value for this input (entity type is denoted by `value_type`) - `value_type` 'Attachment' | 'DataTypeValue' | 'Floorplan' | 'Signature', nullable — Type of the entity `value_id` points to - `created_at` string, date-time, required — Time when the server created the entity - `deleted_at` string, date-time, nullable — Time the server deleted the entity - `device_created_at` string, date-time, required — Time when the device created the entity - `device_updated_at` string, date-time, required — Time when the device last updated the entity - `resolved_conflict` boolean, nullable, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `updated_at` string, date-time, required — Time when the server last updated the entity - `thumb_url` string, nullable, required — URL of the thumb version of image attachment - `flattened_file_url` string, nullable, required — URL of the file that has the markups flattened - `user` union - string, nullable — To allow null values - User — General information of a user - … - `value` union - string, nullable — To allow null values - Attachment — Entity that usually show up in the "files" tab - … - DataTypeValue — Represents a value (usually as part of a `Form` entry) - … - Floorplan — Floorplan Entity schema - … - Signature — Entity that denotes a user's signature - … - FillablePdfFormAttachment — Entity that denotes a form attachment used for fillable forms - … ## Other responses - `202` — Successful jid echo response --- [API](https://skmtc.dev/fieldwire/apis/fieldwire-super-api.md) · [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-super-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fieldwire/fieldwire-super-api/revisions/66ee1c20b92d/schema)