Sign in

v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
sheet uploads

Update sheet_upload by ID

patch/api/v3/projects/{project_id}/sheet_uploads/{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

is_processedboolean

Whether this upload was successfully processed into plan(s)

version_descriptionstring nullable

Description for the uploaded file

version_notesstring nullable

Notes for the uploaded file

last_editor_user_idinteger nullable

ID of the user making this update (required when authenticating via API key)

Response

Successful response

idstring uuid required

ID of the entity

user_idinteger required

ID of the user who uploaded this

folder_idstring uuid nullable

ID of the folder this was uploaded into

project_idstring uuid required

ID of the project this entity belongs to

active_sheets_countinteger nullable

Number of active Sheets in the Project, returned when query param count_active_sheets is set to true.

status'errored' | 'processed' | 'queued' | 'processing' | 'uploading' | 'splitting' nullable

Status of the Sheet upload in the project.

has_errorsboolean required

Whether any errors were hit while processing this upload

is_processedboolean required

Whether this upload was successfully processed into plan(s)

file_sizestring nullable

Size in bytes of the uploaded file

file_urlstring nullable

URL of the file uploaded

namestring required

Name of the entity

version_descriptionstring nullable

Description for the uploaded file

pagesinteger nullable

Count of pages in the uploaded file

pages_splitinteger nullable

Count of pages so far this has been split into (useful to show the state of processing)

pages_uploadedinteger nullable

Count of split pages so far that have been uploaded (useful to show the state of processing)

plans_createdinteger nullable

Count of plans created out of this upload

version_notesstring nullable

Notes for the uploaded file

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