Appearance
Export floor as PDF
POST /floor/{floorId}/pdf
Returns a PDF file URL and a PNG thumbnail URL generated from the floor's default space graph layout, valid for 30 minutes. The organisation's space label mapping is used; pass spaceLabelMapping to override, {} for none. Required API token scopes: floor.export plus either: floor.queryPublic or floor.readPublic for public floors, or either: floor.queryPrivate or floor.readPrivate for private floors.
Request
Path Parameters
floorId
string<uuid>Body
format
string ;values: a4 |a3 |letter orientation
string ;values: portrait |landscape shapeLayers
object
theme
object
spaceLabelMapping
object
Custom labels per space usage, e.g. { "meetingRoom": "Huddle" }. Defaults to the organisation's space usage mapping; an object replaces it entirely, {} renders the plain usage labels
Responses
200
Short URL redirecting to a signed AWS S3 url, valid for 30 minutes
Signed AWS S3 url of a PNG thumbnail, only returned by the PDF export
OK
downloadUrl
string<uri>Short URL redirecting to a signed AWS S3 url, valid for 30 minutes
thumbnailUrl
string<uri>Signed AWS S3 url of a PNG thumbnail, only returned by the PDF export