v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

sheets

Update sheet by ID

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

last_editor_user_idinteger nullable

ID of the user who most recently edited this entity

floorplan_idstring uuid nullable

ID of the plan this belongs to

has_conflictsboolean nullable

Whether this has conflicts with other versions of the plan

version_descriptionstring nullable

Description for this version of the plan

meters_per_pixelnumber double nullable

Count of meters each pixel in file_url corresponds to

version_notesstring nullable

Notes for this version of the plan

device_updated_atstring date-time

Time when the device last updated the entity

Response

Successful response

idstring uuid required

ID of the entity

creator_user_idinteger nullable required

ID of the user who created this entity

last_editor_user_idinteger nullable required

ID of the user who most recently edited this entity

user_idinteger nullable

ID of the user who uploaded this version

floorplan_idstring uuid nullable

ID of the plan this belongs to

folder_idstring uuid nullable

ID of the folder this lives in

rotate_degreesinteger

Degrees by which the sheet is rotated between 0 to 360

project_idstring uuid required

ID of the project this entity belongs to

sheet_upload_idstring uuid nullable

ID of the uploaded entity this version was derived from

has_conflictsboolean nullable

Whether this has conflicts with other versions of the plan

has_errorsboolean nullable

Whether this has any errors

has_low_res_tilesboolean nullable

Whether this has low resolution tile images

is_multipageboolean required

Whether this was derived out of a PDF with more than 1 page

is_tiledboolean nullable

Whether this carries tiles (rows & columns of images that can be put together to build this)

android_file_urlstring nullable

URL of the low resolution image of this entity (with a max dimension of 2048 pixels)

file_namestring required

Name of the uploaded file out of which this was derived

file_urlstring nullable

URL of the low resolution image of this entity

namestring required

Name of the entity

name_crop_urlstring nullable

URL of the corner of that carries the name

original_urlstring nullable

URL of the file that was processed into all the different images in this entity

suggested_namestring nullable

Name suggested by our automated text extraction process

thumb_urlstring nullable

URL of the thumb image of this entity

tiles_package_urlstring nullable

URL of the zip file that carries all the tile images for this entity

version_descriptionstring nullable

Description for this version of the plan

meters_per_pixelnumber double nullable

Count of meters each pixel in file_url corresponds to

pdf_heightnumber double nullable

Height of the original PDF file that was processed into this entity

pdf_widthnumber double nullable

Width of the original PDF file that was processed into this entity

android_file_heightinteger nullable

Height in pixels of the android_file_url image

android_file_widthinteger nullable

Width in pixels of the android_file_url image

file_heightinteger nullable

Height in pixels of the file_url image

file_widthinteger nullable

Width in pixels of the file_url image

original_heightinteger nullable

Height in pixels of the original image before it was further processed into different dimensions

original_widthinteger nullable

Height in pixels of the original image before it was further processed into different dimensions

page_numberinteger nullable

Page number this entity denotes of the uploaded file

tile_sizeinteger nullable

Dimension of each tile image

tiles_resolutioninteger nullable

Resolution of provided tiles images (in DPI)

tiles_resolution_typeinteger nullable

Resolution type of tiles images

versioninteger required

Particular version of the plan this entity denotes

version_notesstring nullable

Notes for this version of the plan

resolved_conflictboolean nullable required

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

created_atstring date-time required

Time when the server created the entity

deleted_atstring date-time nullable

Time the server deleted the entity

device_created_atstring date-time required

Time when the device created the entity

device_updated_atstring date-time required

Time when the device last updated the entity

updated_atstring date-time required

Time when the server last updated the entity

text_content_urlstring nullable

Parsed sheet's text content file url