v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

floorplans

Get all floorplans in project

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

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

Query parameters

with_current_sheetstring

Set query parameter to only return the latest version Sheet

last_synced_atstring date-time

Timestamp since when further updates should be included

filters[tag_eq]string

Example:Test Value

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

filters[tag_like]string

Example:Test Value

Filter on tag field being like passed in value

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:Floorplan 1

Filter on name field being like passed in value

filters[name_eq]string

Example:Floorplan 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

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 with Sheets nested

idstring uuid required

ID of the entity

creator_user_idinteger required

ID of the user who created this entity

last_editor_user_idinteger required

ID of the user who most recently edited this entity

cascade_deleted_by_idstring uuid nullable

ID of the item that cascaded its delete to this entity

folder_idstring uuid nullable

Entity ID of the Folder the Floorplan is in.

project_idstring uuid required

ID of the project this entity belongs to

is_name_confirmedboolean required

When false indicates that User needs to confirm the Floorplan name after auto-naming it from OCR.

is_ocr_processingboolean required

Floorplan has been run through OCR processing

is_user_confirmedboolean required

When false indicates the Floorplan name is in conflict. i.e same as an existing Floorplan on the Project.

descriptionstring nullable

A short description of the entity

namestring required

Name of the entity

resolved_conflictboolean required

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

active_sheets_countinteger nullable

Number of active sheets in this Floorplan

process_state'deleting' | 'restoring' | 'null' nullable

A string indicating the state of the Floorplan.

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

latest_component_device_updated_atstring date-time nullable

Time when a device last updated a markup on the plan

deleted_by_two_way_syncboolean nullable required

Indicates if a file was deleted by two way sync