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

Create employee account

Request

Creates a system user account associated with the specified employee within the current account context.

Behavior:

  • Retrieves employee details based on the employee identifier
  • Validates employee status before user creation
  • Maps employee information to user account fields
  • Assigns roles as provided in the request
  • Sets account activation and expiry dates
  • Creates the user in the identity management system when IsCreateUser is true
  • Returns existing employee details if IsCreateUser is false
  • Logs the action as a user creation event
Path
employeeIdentifierstringrequired
Body
isCreateUserboolean
userRolesArray of strings or null
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/{employeeIdentifier}/createuser' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "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

List employees

Request

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

Behavior:

  • Applies filtering criteria from the request body
  • Supports pagination using the start query parameter
  • Retrieves employees associated with the account
  • Returns summarised employee view details
  • Logs the action as an 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/all?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 employee qualifications

Request

Returns the list of qualifications associated with the specified employee within the current account context.

Behavior:

  • Validates employee association with the account
  • Retrieves all recorded qualifications for the employee
  • Returns qualification details including relevant metadata
  • Logs the action as an employee qualification view event
Path
employeeIdentifierstring(uuid)required
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/{employeeIdentifier}/qualifications'

Responses

OK

Body
dataArray of objects or null(zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel)
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