Sign in

v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
sheets

Get all sheets in project

get/api/v3/projects/{project_id}/sheets

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

Query parameters

last_synced_atstring date-time

Timestamp since when further updates should be included

filters[creator_user_id_eq]string
Example:100

Filter on creator_user_id field being equal to the passed in value, allows for filtering with a array of values

filters[last_editor_user_id_eq]string
Example:100

Filter on last_editor_user_id field being equal to the passed in value, allows for filtering with a array of values

filters[floorplan_id_eq]string
Example:26462387-8f00-4118-8f1c-419ec8761c23

Filter on floorplan_id field being equal to passed in value, allows for filtering with a array of values

filters[folder_id_eq]string
Example:26462387-8f00-4118-8f1c-419ec8761c23

Filter on folder_id field being equal to passed in value, allows for filtering with a array of values

filters[file_name_like]string
Example:Example.png

Filter on file_name field being like passed in value

filters[file_name_eq]string
Example:Example.png

Filter on file_name field being equal to passed in value, allows for filtering with a array of values

filters[created_at_gte]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than or equal to the passed in value

filters[created_at_gt]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than the passed in value

filters[created_at_lte]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being less than or equal to the passed in value

filters[created_at_lt]string
Example:2009-06-15T13:45:30Z

Filter on created_at field being less than to the passed in value

filters[name_like]string
Example:Sheet 1

Filter on name field being like passed in value

filters[name_eq]string
Example:Sheet 1

Filter on name field being equal to passed in value, allows for filtering with a array of values

filters[updated_at_gte]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than or equal to the passed in value

filters[updated_at_gt]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than the passed in value

filters[updated_at_lte]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being less than or equal to the passed in value

filters[updated_at_lt]string
Example:2009-06-15T13:45:30Z

Filter on updated_at field being less than to the passed in value

filters[version_gte]string
Example:100

Filter on version field being greater than or equal to the passed in value

filters[version_gt]string
Example:100

Filter on version field being greater than the passed in value

filters[version_lte]string
Example:100

Filter on version field being less than or equal to the passed in value

filters[version_lt]string
Example:100

Filter on version field being less than to the passed in value

filters[version_eq]string
Example:100

Filter on version field being equal to the passed in value, allows for filtering with a array of values

filters[meters_per_pixel_gte]string
Example:100

Filter on meters_per_pixel field being greater than or equal to the passed in value

filters[meters_per_pixel_gt]string
Example:100

Filter on meters_per_pixel field being greater than the passed in value

filters[meters_per_pixel_lte]string
Example:100

Filter on meters_per_pixel field being less than or equal to the passed in value

filters[meters_per_pixel_lt]string
Example:100

Filter on meters_per_pixel field being less than to the passed in value

filters[meters_per_pixel_eq]string
Example:100

Filter on meters_per_pixel field being equal to the passed in value, allows for filtering with a array of values

filters[deleted_at_gte]string
Example:2009-06-15T13:45:30Z

Filter on deleted_at field being greater than or equal to the passed in value

filters[deleted_at_gt]string
Example:2009-06-15T13:45:30Z

Filter on deleted_at field being greater than the passed in value

filters[deleted_at_lte]string
Example:2009-06-15T13:45:30Z

Filter on deleted_at field being less than or equal to the passed in value

filters[deleted_at_lt]string
Example:2009-06-15T13:45:30Z

Filter on deleted_at field being less than to the passed in value

filters[sheet_upload_id_eq]string
Example:26462387-8f00-4118-8f1c-419ec8761c23

Filter on sheet_upload_id field being equal to passed in value, allows for filtering with a array of values

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Fieldwire-Filter'active' | 'deleted'

Specifies if request should include active, deleted or all (default) entities

Fieldwire-Per-Pageinteger

Specifies the number of entities to include in the request

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