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

Update account user

Request

This endpoint updates profile information and role assignments for a specified user within the current account.

The user’s email domain is validated against the list of mail domains configured for the account before the update is processed.

Process overview:

  • Validate the user’s email domain
  • Update user details through the Identity Provider
  • Refresh cached account user data
  • Invalidate licensing and permission-related caches
Path
userIdentifierstringrequired
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/{useridentifier}' \
  -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
dataobject(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

Add account user

Request

This endpoint creates a new user within the currently active account and assigns the specified roles and permissions.

Before user creation, the user’s email domain is validated against the list of mail domains configured for the account. If the domain is not allowed, the request is rejected.

Process overview:

  • Validate the user’s email domain against configured account domains
  • Create the user through the Identity Provider
  • Update account user caches and licensing state
  • Return the newly created user details and role information
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/add \
  -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
dataobject(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

Remove account user

Request

This endpoint deletes a specified user from the currently active account. The operation is processed through the Identity Provider and reflected in the account’s user and licensing state.

Process overview:

  • Delete the user through the Identity Provider
  • Update account user and licensed user caches
  • Preserve employee-related metadata where applicable
Path
userIdentifierstringrequired
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/account/users/{useridentifier}/remove'

Responses

OK

Body
dataobject(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

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