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

Adds a new employee

Request

Creates a new employee record within the current account context.

Behavior:

  • Associates the employee with the current account
  • Applies validation and business rules before persistence
  • Logs the action as an employee creation event
Body
employeeInfoobject(zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetail)
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/add \
  -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
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

Removes an employee

Request

Removes the specified employee from the current account.

Behavior:

  • Validates employee association with the account
  • Applies business rules before removal
  • Logs the action as an employee removal event
Path
employeeIdentifierstringrequired
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/{employeeidentifier}/remove'

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

Gets employee details

Request

Retrieves detailed information for the specified employee within the current account context.

Behavior:

  • Validates employee association with the account
  • Returns complete employee profile information
  • Logs the action as an employee view event
Path
employeeIdentifierstringrequired
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/{employeeIdentifier}'

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