Skip to main content
GET
Search FloorPlanLayoutAssets
A FloorPlanLayoutAsset positions a physical asset within a specific floor plan layout, defining its coordinates, rotation, and visual properties on the plan.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the FloorPlanLayoutAsset-List role.

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the floor plan layout linked to this record.
string
Filter by display name of the linked floor plan layout (read-only).
string
Filter by iD of the area unique associated with this record.
string
Filter by the asset type value for this floor plan layout asset.
number
Filter by the angle value for this floor plan layout asset.
integer
Filter by the height value for this floor plan layout asset.
integer
Filter by the length value for this floor plan layout asset.
integer
Filter by the width value for this floor plan layout asset.
integer
Filter by the x value for this floor plan layout asset.
integer
Filter by the y value for this floor plan layout asset.
integer
Filter by the floor offset value for this floor plan layout asset.

Range Filters

number
Filter by the angle value for this floor plan layout asset greater than or equal to this value.
number
Filter by the angle value for this floor plan layout asset less than or equal to this value.
integer
Filter by the height value for this floor plan layout asset greater than or equal to this value.
integer
Filter by the height value for this floor plan layout asset less than or equal to this value.
integer
Filter by the length value for this floor plan layout asset greater than or equal to this value.
integer
Filter by the length value for this floor plan layout asset less than or equal to this value.
integer
Filter by the width value for this floor plan layout asset greater than or equal to this value.
integer
Filter by the width value for this floor plan layout asset less than or equal to this value.
integer
Filter by the x value for this floor plan layout asset greater than or equal to this value.
integer
Filter by the x value for this floor plan layout asset less than or equal to this value.
integer
Filter by the y value for this floor plan layout asset greater than or equal to this value.
integer
Filter by the y value for this floor plan layout asset less than or equal to this value.
integer
Filter by the floor offset value for this floor plan layout asset greater than or equal to this value.
integer
Filter by the floor offset value for this floor plan layout asset less than or equal to this value.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

FloorPlanLayoutAsset[]
The list of FloorPlanLayoutAsset records matching the query. See the Get one FloorPlanLayoutAsset endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response