Search FloorPlanLayoutOpenings

GET

api

sys

floorplanlayoutopenings

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplanlayoutopenings \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/floorplanlayoutopenings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A FloorPlanLayoutOpening represents a door, window, or other opening in a floor plan layout wall or boundary edge.

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 FloorPlanLayoutOpening-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 edge linked to this record.

string

Filter by display name of the linked floor plan layout edge (read-only).

string

Filter by the opening type value for this floor plan layout opening.

integer

Filter by the floor offset value for this floor plan layout opening.

integer

Filter by the start value for this floor plan layout opening.

integer

Filter by the height value for this floor plan layout opening.

integer

Filter by the length value for this floor plan layout opening.

string

Filter by the hinge value for this floor plan layout opening.

string

Filter by the door type value for this floor plan layout opening.

integer

Filter by the door arc angle value for this floor plan layout opening.

boolean

Filter by whether door is locked is enabled.

integer

Filter by the window pane count value for this floor plan layout opening.

string

Filter by the direction value for this floor plan layout opening.

Range Filters

integer

Filter by the floor offset value for this floor plan layout opening greater than or equal to this value.

integer

Filter by the floor offset value for this floor plan layout opening less than or equal to this value.

integer

Filter by the start value for this floor plan layout opening greater than or equal to this value.

integer

Filter by the start value for this floor plan layout opening less than or equal to this value.

integer

Filter by the height value for this floor plan layout opening greater than or equal to this value.

integer

Filter by the height value for this floor plan layout opening less than or equal to this value.

integer

Filter by the length value for this floor plan layout opening greater than or equal to this value.

integer

Filter by the length value for this floor plan layout opening less than or equal to this value.

integer

Filter by the door arc angle value for this floor plan layout opening greater than or equal to this value.

integer

Filter by the door arc angle value for this floor plan layout opening less than or equal to this value.

integer

Filter by the window pane count value for this floor plan layout opening greater than or equal to this value.

integer

Filter by the window pane count value for this floor plan layout opening 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

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings?page=1&size=15&orderBy=OpeningType&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplanlayoutopenings?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'OpeningType',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplanlayoutopenings',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'OpeningType',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by OpeningType

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings?FloorPlanLayoutOpening_OpeningType=example-value&orderBy=OpeningType&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplanlayoutopenings?' + new URLSearchParams({
    FloorPlanLayoutOpening_OpeningType: 'example-value',
    orderBy: 'OpeningType',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplanlayoutopenings',
    params={
        'FloorPlanLayoutOpening_OpeningType': 'example-value',
        'orderBy': 'OpeningType',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings?from_FloorPlanLayoutOpening_UpdatedOn=2025-01-01T00:00&to_FloorPlanLayoutOpening_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplanlayoutopenings?' + new URLSearchParams({
    from_FloorPlanLayoutOpening_UpdatedOn: '2025-01-01T00:00',
    to_FloorPlanLayoutOpening_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplanlayoutopenings',
    params={
        'from_FloorPlanLayoutOpening_UpdatedOn': '2025-01-01T00:00',
        'to_FloorPlanLayoutOpening_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

FloorPlanLayoutOpening[]

The list of FloorPlanLayoutOpening records matching the query. See the Get one FloorPlanLayoutOpening 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

{
  "Records": [
    {
      "FloorPlanLayoutEdgeId": 0,
      "FloorPlanLayoutEdgeName": null,
      "OpeningType": "",
      "FloorOffset": 0,
      "Start": 0,
      "Height": 0,
      "Length": 0,
      "Hinge": null,
      "DoorType": null,
      "DoorArcAngle": null,
      "DoorIsLocked": false,
      "WindowPaneCount": null,
      "Direction": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "FloorPlanLayoutOpening Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "OpeningType",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one FloorPlanLayoutOpeningRetrieve a single FloorPlanLayoutOpening record by its Id.

Search FloorPlanLayoutOpenings

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplanlayoutopenings \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/floorplanlayoutopenings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Search FloorPlanLayoutOpenings

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by OpeningType

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by OpeningType

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by OpeningType

Range filters

Response

200