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

Update employee locations

Request

Applies location updates to one or more employees within the current account context based on the provided request data.

Behavior:

  • Validates employee associations with the account
  • Validates target location details
  • Updates location assignments for the specified employees
  • Ensures location rules and constraints are enforced
  • Logs the action as a bulk employee location update event
Body
updateLocationModelsArray of objects or null(zLink.Business.zOne.Portfolio.RequestModels.UpdateLocationModel)
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/locations/update \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "updateLocationModels": [
      {
        "identifier": "14d3030c-3b61-4070-b902-342f80e99364",
        "coordinates": [
          0.1
        ]
      }
    ]
  }'

Responses

OK

Body
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

List active employees

Request

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

Behavior:

  • Applies filtering criteria from the request body
  • Supports pagination using the start query parameter
  • Retrieves only employees with an active status
  • Returns summarised employee view details
  • Logs the action as an active employee list view event
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/active?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.EmployeeViewResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Get paginated employee details

Request

Returns a filtered and/or paginated list of basic employee details within the current account context.

Behavior:

  • Applies filtering criteria from the request body
  • Supports pagination using the start query parameter
  • Retrieves essential employee information only
  • Excludes extended profile or detailed data
  • Returns summarised employee basic detail results
  • Logs the action as an employee basic details list view event
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/basic/list?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.EmployeeBasicDetailListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Facility

Operations

Furniture

Operations

Portfolio

Operations

File Management

Operations

Filegroups

Operations

Tasks

Operations

Service Requests

Operations

PM Work Orders

Operations