v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

submittals

Update submittal

patch/api/v3/projects/{project_id}/submittals/{id}

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

idstring uuid required

ID of the entity

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Request body

Response

Successful response

idstring uuid required

ID of the entity

namestring required

Name of the Submittal. Must be unique between Submittals under the same parent.

descriptionstring nullable

Description of the Submittal

numberinteger nullable

The number associated with the Submittal

codestring nullable

The code associated with the Submittal

consolidated_current_numberstring nullable

The consolidated current number of the Submittal

statusstring required

The status of the Submittal as an enum, e.g. draft, requested

revision_numberinteger nullable

The revision number associated with the Submittal

submit_by_datestring date nullable

The date the Submittal should be submitted by

requested_atstring date-time nullable

Time when the server requested the entity

submission_received_atstring date-time nullable

Time when the server submitted the entity

response_received_atstring date-time nullable

Time at which the submittal was approved

submitted_atstring date-time nullable

Time when the server submitted the entity

responded_atstring date-time nullable

Time at which the submittal was approved

assigned_atstring date-time nullable

Time when the server assigned the entity

review_by_datestring date nullable

The date the Submittal should be reviewed by

approve_by_datestring date nullable

The date the Submittal should be approved by

reviewed_atstring date-time nullable

Time when the entity was reviewed

approved_atstring date-time nullable

Time when the server approved the entity

closed_atstring date-time nullable

Time when the server closed the entity

voided_atstring date-time nullable

Time when the server voided the entity

sent_for_approval_atstring date-time nullable

Time when the submittal was sent for approval

response_timeinteger nullable

Difference between sent_for_approval_at and responded_at in days

responseinteger nullable

The last primary approval response name, e.g. Approved, Rejected

device_created_atstring date-time

Time when the device created the entity

device_updated_atstring date-time

Time when the device last updated the entity

deleted_atstring date-time nullable

Time the server deleted the entity

created_atstring date-time required

Time when the server created the entity

updated_atstring date-time required

Time when the server last updated the entity

spec_section_idstring uuid nullable

ID of the spec section the Submittal is associated with

submittal_type_idstring uuid nullable

ID of the type the Submittal is associated with

submittal_type_namestring nullable

Type name the Submittal is associated with

project_idstring uuid required

ID of the project this entity belongs to

creator_user_idinteger required

ID of the user who created this entity

creator_pm_group_idstring uuid nullable

The id of the PmGroup that the Submittal creator was in when the Submittal was created

requesting_user_idinteger nullable

The id of the user who requested the Submittal

submitting_user_idinteger nullable

The id of the user who submitted the Submittal

submitting_pm_group_idstring uuid nullable

The id of the PmGroup that the Submittal submitting user was in when the Submittal was requested

assignee_user_idinteger nullable

The id of the user assigned to the Submittal

approving_user_idinteger nullable

The id of the user who approved the Submittal

closing_user_idinteger nullable

The id of the user who closed the Submittal

last_editor_user_idinteger required

ID of the user who most recently edited this entity

submittal_codestring

The Submittal code

resolved_conflictboolean

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

workflowstring

Determines which submittal transitions are available

is_reminder_enabledboolean

Boolean flag indicating if email reminders for submittals are enabled

lead_timeinteger nullable

The number of weeks it takes to get the submittal material on-site after it is approved and closed (includes fabrication and shipping time)

on_site_datestring date nullable

The first day in the construction schedule that the submittal's material is needed

suggested_submit_by_datestring date nullable

The 'submit by' date calculated as optimal for ensuring the submittal will meet the on-site deadline (draft submittals only)

messagestring nullable

Optional message to add onto body

reference_numberstring nullable

Reference number of submittal