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

List asset classes by type

Request

Returns the list of asset classes associated with the specified general asset type within the current account context.

Behavior:

  • Validates the asset type belongs to the account
  • Retrieves associated asset classes for the given asset type identifier
  • Returns structured asset class response data
  • Logs the action as an equipment type list view event
Path
assetTypeIdentifierstring(uuid)required
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/assets/general/assettypes/{assetTypeIdentifier}/assetclass/list'

Responses

OK

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

Get paginated asset classes

Request

Returns a filtered and paginated list of general asset classes within the current account context.

Behavior:

  • Validates manage or view privilege for asset classes
  • Applies filtering criteria from the request body
  • Supports pagination using the start query parameter
  • Retrieves matching asset classes
  • Returns structured asset class list response data
  • Logs the action as an equipment type list view event
Query
startinteger(int32)
Body
siteIdsArray of strings or null(uuid)
buildingIdsArray of strings or null(uuid)
levelIdsArray of strings or null(uuid)
roomIdstring or null
assetClassIdstring or null
assetTypeIdstring or null
assignedboolean
unassignedboolean
datafieldIdsArray of strings or null
selectedIdsArray of strings or null
statusArray of strings or null
isEquipmentWithSpaceHandleboolean
includeFurnitureboolean or null
levelNamestring or null
levelPositioninteger(int32)
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
isAdvancedSearchboolean or null
isLinkAssetboolean
assetClassIdsArray of strings or null(uuid)
assetTypeIdsArray of strings or null(uuid)
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/assets/general/assetclass/list/all?start=0' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "siteIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "buildingIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "levelIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "roomId": "string",
    "assetClassId": "string",
    "assetTypeId": "string",
    "assigned": true,
    "unassigned": true,
    "datafieldIds": [
      "string"
    ],
    "selectedIds": [
      "string"
    ],
    "status": [
      "string"
    ],
    "isEquipmentWithSpaceHandle": true,
    "includeFurniture": true,
    "levelName": "string",
    "levelPosition": 0,
    "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,
    "isLinkAsset": true,
    "assetClassIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "assetTypeIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "keyword": "string",
    "sortColumn": "string",
    "sortColumnId": "0f49f070-9ddb-4e23-bac3-3a9c7797ab4e",
    "sortOrder": "string",
    "filter": "string"
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Get asset tasks

Request

Returns a filtered and paginated list of tasks associated with the specified asset within the current account context.

Behavior:

  • Validates the asset belongs to the account
  • Applies filtering criteria from the request body
  • Supports pagination using the start query parameter
  • Retrieves tasks linked to the given asset identifier
  • Returns structured task list response data
  • Logs the action as a task viewed event
Path
assetIdstring(uuid)required
Query
startinteger(int32)
Body
keywordstring or null
sortColumnstring or null
sortColumnIdstring or null(uuid)
sortOrderstring or null
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
selectedIdsArray of strings or null(uuid)
datafieldIdsArray of strings or null(uuid)
filterstring or null
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/assets/{assetId}/tasks?start=0' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "keyword": "string",
    "sortColumn": "string",
    "sortColumnId": "0f49f070-9ddb-4e23-bac3-3a9c7797ab4e",
    "sortOrder": "string",
    "fieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "selectedIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "datafieldIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "filter": "string"
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Employees

Operations

Facility

Operations

Furniture

Operations

Portfolio

Operations

File Management

Operations

Filegroups

Operations

Tasks

Operations

Service Requests

Operations

PM Work Orders

Operations