Uploading Spec Books via API

Specifications are the newest entry to Fieldwire’s core product offering. To utilize this offering, users must first upload a spec book onto a project.

Disclaimer: we recommend against using Fieldwire’s API for specifications outside of what is described in our user guides, as doing so can lead to unintended consequences.

Prerequisite Steps

Uploading a spec book to Fieldwire requires the same prerequisite steps as the Plan Uploads. You will have to first generate an AWS token and upload your spec book file to s3.

Once your file is uploaded to s3 after following the aforementioned guide, you are now ready to upload your spec book to Fieldwire.

Uploading a Spec Book to a Project

Combine the post_address and key from the prerequisite steps to generate a file url, and make a POST request as described in https://developers.fieldwire.com/reference/create_spec_upload_in_project.

Once your POST request is successful, head over to the Specifications section under your project on the web app. Once there, you will be able to review the sections which our service detected from your spec book, and make any necessary edits before confirming the sections you want to create.

Note: it may take up to a few minutes for your uploaded spec book to become ready for review.

Extracting Submittal Logs via API

Specifications can be a key entry point in the creation of submittals. To support this fact, Fieldwire allows users to extract a CSV log of detected submittals from specifications which exist on a project. This extracted CSV log can then be uploaded to the Submittals section on a project (via the web app) to create submittals.

Disclaimer: we recommend against using Fieldwire’s API for specifications and/or submittals outside of what is described in our user guides, as doing so can lead to unintended consequences.

Getting an Extracted Submittals log

Make a POST request as described in https://developers.fieldwire.com/reference/create_extracted_submittal_logs.

After making a successful POST request, an email containing a CSV of identified submittals will be sent to the email of the user associated with the API token.
Note: it may take up to a few minutes for this email to be delivered.