Skip to content

zOne Web Services

The zOne Web Services API enables integration with core platform capabilities,including Maintenance Management, Space Management, and Condition Assessment.

It provides secure endpoints for managing assets, user accounts, reference data, audit trails, file groups, and organizational contacts. These APIs support operational workflows, data synchronization, and system integrations.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Demo
https://demozone.zlinkfm.com/RND

Account Management

Operations

User Management

Operations

User Preferences

Operations

Reference Data

Operations

Organizational Contacts

Operations

Audit Trails

Operations

Equipment

Operations

Employees

Operations

Facility

Operations

Get workspaces by room hierarchy

Request

Returns the list of workspaces under the specified location, building, and level within the current account context.

Behavior:

  • Validates location, building, and level association with the account
  • Retrieves workspaces mapped to the specified hierarchy
  • Returns workspace details and related metadata
  • Logs the action as a room workspaces view event
Path
locationIdstring(uuid)required
buildingIdstring(uuid)required
levelIdstring(uuid)required
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/facility/spaces/locations/{locationId}/buildings/{buildingId}/levels/{levelId}/workSpaces'

Responses

OK

Body
dataArray of objects or null(zLink.Business.zOne.Portfolio.ResponseModels.RoomWorkSpacesResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Get space grid list

Request

Returns a filtered and paginated grid-style list of spaces within the current account context.

Behavior:

  • Applies filtering criteria from the request body
  • Uses the start query parameter for pagination
  • Retrieves spaces associated with the account
  • Returns structured grid/list response data
  • Logs the action as a space grid view event
Query
startinteger(int32)
Body
siteIdsArray of strings or null(uuid)
buildingIdsArray of strings or null(uuid)
levelIdsArray of strings or null(uuid)
roomIdstring or null
assetClassIdstring or null
assetTypeIdstring or null
assignedboolean
unassignedboolean
datafieldIdsArray of strings or null
selectedIdsArray of strings or null
statusArray of strings or null
isEquipmentWithSpaceHandleboolean
includeFurnitureboolean or null
levelNamestring or null
levelPositioninteger(int32)
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
isAdvancedSearchboolean or null
isLinkAssetboolean
assetClassIdsArray of strings or null(uuid)
assetTypeIdsArray of strings or null(uuid)
keywordstring or null
sortColumnstring or null
sortColumnIdstring or null(uuid)
sortOrderstring or null
filterstring or null
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/facility/spaces/list?start=0' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "siteIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "buildingIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "levelIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "roomId": "string",
    "assetClassId": "string",
    "assetTypeId": "string",
    "assigned": true,
    "unassigned": true,
    "datafieldIds": [
      "string"
    ],
    "selectedIds": [
      "string"
    ],
    "status": [
      "string"
    ],
    "isEquipmentWithSpaceHandle": true,
    "includeFurniture": true,
    "levelName": "string",
    "levelPosition": 0,
    "fieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "isAdvancedSearch": true,
    "isLinkAsset": true,
    "assetClassIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "assetTypeIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "keyword": "string",
    "sortColumn": "string",
    "sortColumnId": "0f49f070-9ddb-4e23-bac3-3a9c7797ab4e",
    "sortOrder": "string",
    "filter": "string"
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

List related shared spaces

Request

Returns the list of shared spaces associated with the specified space within the current account context.

Behavior:

  • Validates space association with the account
  • Retrieves all shared space records linked to the specified space
  • Returns structured shared space list response
  • Logs the action as a shared space view event
Path
spaceIdstring(uuid)required
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/spaces/{spaceId}/shared/all'

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Furniture

Operations

Portfolio

Operations

File Management

Operations

Filegroups

Operations

Tasks

Operations

Service Requests

Operations

PM Work Orders

Operations