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

List employee basic details

Request

Returns a simplified list of employee details within the current account context.

Behavior:

  • Retrieves all employees associated with the account
  • Returns essential employee information only
  • Excludes extended or detailed profile data
  • Logs the action as an employee basic details view event
curl -i -X GET \
  https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/basic

Responses

OK

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

Updates multiple employees

Request

Applies bulk updates to multiple employees within the current account context based on the provided request data.

Behavior:

  • Validates employee associations with the account
  • Processes update rules for multiple employee records
  • Applies changes according to the request model
  • Returns the updated employee details list
  • Logs the action as a multiple employee update event
Body
employeeInfoobject(zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetail)
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/update \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "employeeInfo": {
      "fieldValues": [
        {
          "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
          "dataFieldValue": "string",
          "dataFieldlabel": "string",
          "dataFieldValueIds": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "fromDate": "string",
          "toDate": "string",
          "dataFieldValueRangeType": "string"
        }
      ],
      "spaceDetails": {
        "buildingId": "string",
        "levelId": "string",
        "locationId": "string",
        "roomId": "string",
        "workSpaceId": "string",
        "isAssigned": true,
        "coordinates": [
          0.1
        ]
      },
      "employeeIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "isCreateUser": true,
      "userRoles": [
        "string"
      ]
    }
  }'

Responses

OK

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

Cancels employee termination

Request

Reverses the termination status of the specified employee within the current account context and restores the employee to an active state where applicable.

Behavior:

  • Validates employee association with the account
  • Ensures the employee is currently in a terminated state
  • Reverts termination details and status
  • Restores eligibility for assignments and operations if applicable
  • Returns updated employee details
  • Logs the action as an employee termination cancellation event
Path
employeeIdentifierstringrequired
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/{employeeIdentifier}/cancelTermination'

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel)
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