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

Update location geometry

Request

Updates the geometry data of the specified location within the current account context.

Behavior:

  • Validates the location belongs to the account
  • Updates spatial/geometry data using the provided feature collection
  • Persists updated geometry information
  • Returns the updated location geometry response
  • Logs the action as location geometry updated
Path
locationIdentifierstringrequired
Body
typestring or null
featuresArray of objects or null(zLink.Business.zOne.Base.Common.Feature)
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/portfolio/locations/{locationIdentifier}/location' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "type": "string",
    "features": [
      {
        "type": "string",
        "id": 0,
        "properties": {
          "property1": null,
          "property2": null
        },
        "geometry": {
          "property1": null,
          "property2": null
        }
      }
    ]
  }'

Responses

OK

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

Get all employees

Request

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

Behavior:

  • Supports pagination using the start query parameter
  • Applies filtering criteria from the request body
  • Retrieves employees accessible to the current user
  • Returns structured employee response data
  • Logs the action as employee list view
Query
startstring
Body
assignedboolean
unassignedboolean
levelIdstring or null
buildingIdstring or null
locationIdstring or null
employeeIdstring or null
roomIdstring or null
datafieldIdsArray of strings or null
selectedIdsArray of strings or null
siteIdsArray of strings or null(uuid)
buildingIdsArray of strings or null(uuid)
levelIdsArray of strings or null(uuid)
isEmployeeWithSpaceHandleboolean
statusArray of strings or null
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
isAdvancedSearchboolean or null
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/employees?start=string' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "assigned": true,
    "unassigned": true,
    "levelId": "string",
    "buildingId": "string",
    "locationId": "string",
    "employeeId": "string",
    "roomId": "string",
    "datafieldIds": [
      "string"
    ],
    "selectedIds": [
      "string"
    ],
    "siteIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "buildingIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "levelIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "isEmployeeWithSpaceHandle": true,
    "status": [
      "string"
    ],
    "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,
    "keyword": "string",
    "sortColumn": "string",
    "sortColumnId": "0f49f070-9ddb-4e23-bac3-3a9c7797ab4e",
    "sortOrder": "string",
    "filter": "string"
  }'

Responses

OK

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

List rooms by level

Request

Returns the list of rooms associated with the specified level within the current account context.

Behavior:

  • Validates the level belongs to the account
  • Retrieves room details for the given level identifier
  • Returns structured room response data
  • Logs the action as rooms viewed
Path
levelIdentifierstringrequired
locationIdentifierstringrequired
buildingIdentifierstringrequired
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms'

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