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

Get current user account details

Request

This endpoint returns account-related information for the logged-in user, including details of the account the user belongs to and their association with it.

The data is resolved automatically based on the authenticated user context and does not require any account or user identifiers in the request.

Use cases:

  • Display account information in user profile or dashboard screens
  • Determine the user’s current account context
  • Retrieve account metadata for self-service features
curl -i -X GET \
  https://demozone.zlinkfm.com/RND/api/v1/account/users/me/accountdetails

Responses

OK

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

Update multiple users

Request

This endpoint allows administrators to perform bulk updates on users belonging to the current account. It supports updating role assignments and related account access properties for multiple users in a single request.

Request details:

Accepts a list of user identifiers to be updated Applies role and access changes uniformly to all specified users

Behavior:

  • Each user update is processed via the identity management provider
  • Updated user data is synchronized with the account cache
  • The response includes the updated state for each processed user
Body
keywordstring or null
userRoleIdsArray of strings or null(uuid)
teamIdstring or null(uuid)
userIdstring(uuid)
namestring or null
firstNamestring or null
middleNamestring or null
lastNamestring or null
phoneNumber1string or null
phoneNumber2string or null
accountAccessobject(Models.AccountAccesDetails)
statusobject(Models.StatusResponseInfo)
emailstring or null
timezoneobject(Models.TimeZoneDetails)
profilePicstring or null
userIdsArray of strings or null(uuid)
isSSOUserboolean
userRolesArray of strings or null
statusCodestring or null
teamobject(Models.OrgUnit)
loginNamestring or null
statusDetailsobject(Models.StatusDetails)
isEmployeeboolean
employeeCodestring or null
isTwoFactorEnabledboolean
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/account/users/update \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "keyword": "string",
    "userRoleIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "name": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "phoneNumber1": "string",
    "phoneNumber2": "string",
    "accountAccess": {
      "loginName": "string",
      "resetPasswordState": true,
      "activationDate": "2019-08-24T14:15:22Z",
      "expiryDate": "2019-08-24T14:15:22Z"
    },
    "status": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "code": "string"
    },
    "email": "string",
    "timezone": {
      "timezoneId": "ec6fffce-51c8-4aa2-b751-ebde3e12856f",
      "timezoneName": "string",
      "code": "string",
      "supportsDaylightSavingTime": true,
      "daylightName": "string"
    },
    "profilePic": "string",
    "userIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "isSSOUser": true,
    "userRoles": [
      "string"
    ],
    "statusCode": "string",
    "team": {
      "accountOrgUnitId": "b9e3953d-56f9-4bc0-9b59-60fd4682ccf6",
      "levelOrdinal": 0,
      "accountOrgUnitName": "string",
      "accountOrgUnitCode": "string",
      "parentAccountOrgUnitId": "d148c557-9fa6-487a-85c9-8fd3a8f5a469",
      "subLevelUnits": [
        {}
      ]
    },
    "loginName": "string",
    "statusDetails": {
      "statusId": 0,
      "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      "statusName": "string",
      "statusCode": "string",
      "statusColor": "string"
    },
    "isEmployee": true,
    "employeeCode": "string",
    "isTwoFactorEnabled": true
  }'

Responses

OK

Body
dataArray of objects or null(zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Get active account users

Request

This endpoint returns active users associated with the current account, supporting keyword-based filtering, sorting, and pagination.

Behavior:

  • Only users in active status are included
  • User data is retrieved from the account cache
  • The response contains a paginated and sorted user list
Query
startstring
Body
keywordstring or null
sortColumnstring or null
sortOrderstring or null
isTileViewboolean
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/account/users/active?start=string' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "keyword": "string",
    "sortColumn": "string",
    "sortOrder": "string",
    "isTileView": true
  }'

Responses

OK

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

User Preferences

Operations

Reference Data

Operations

Organizational Contacts

Operations

Audit Trails

Operations

Equipment

Operations

Employees

Operations

Facility

Operations

Furniture

Operations

Portfolio

Operations

File Management

Operations

Filegroups

Operations

Tasks

Operations

Service Requests

Operations

PM Work Orders

Operations