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

Furniture

Operations

Portfolio

Operations

List buildings

Request

Returns a filtered and paginated list of buildings within the current account context.

Behavior:

  • Applies filtering criteria from the request body
  • Supports pagination using the start query parameter
  • Retrieves buildings accessible to the current user
  • Returns structured building list response data
  • Logs the action as building grid view
Query
startstring
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/portfolio/locations/buildings/list?start=string' \
  -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.BuildingListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

List levels

Request

Returns a filtered and paginated list of levels within the current account context.

Behavior:

  • Applies filtering criteria from the request body
  • Supports pagination using the start query parameter
  • Retrieves levels accessible to the current user
  • Returns structured level list response data
  • Logs the action as a level list view
Query
startstring
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/portfolio/locations/buildings/levels/list?start=string' \
  -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.LevelListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

List rooms and workspaces by level

Request

Returns rooms and their associated workspaces for the specified level within the current account context.

Behavior:

  • Validates the level belongs to the account
  • Retrieves rooms along with related workspace details
  • Returns structured room and workspace response data
  • Logs the action as spaces viewed
Path
levelIdentifierstring(uuid)required
locationIdentifierstringrequired
buildingIdentifierstringrequired
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms/workspaces'

Responses

OK

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

File Management

Operations

Filegroups

Operations

Tasks

Operations

Service Requests

Operations

PM Work Orders

Operations