Batch export Floorplans

post

https://client-api.{region}.fieldwire.com/api/v3/projects/{project_id}/floorplans/batch_export

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

uuid

required

ID of the project this entity belongs to

Body Params

Schema for batch export floorplan input. Eligible Floorplans are the ones in your Project.

floorplan_ids

array of uuids | null

List of Floorplan IDs to further filter the export list by

floorplan_ids

folder_id

uuid | null

Only export Floorplans in this Folder ID.

layers

object

required

The layers of the Floorplan to batch export.

export_type

string | null

enum

Control the type of output that will be generated on export. Defaults to zip.

Allowed:

sheet_ids

array of uuids | null

List of Sheet IDs to export specific plan versions instead of the current version for each Floorplan. The Floorplan owning each Sheet ID must be part of the exported set (via floorplan_ids, folder_id, or the default export-all when neither is given), or the override has no effect for that Sheet ID.

sheet_ids

Headers

Fieldwire-Version

date

required

Specifies the version of the API to talk to

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Successful response