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

Get general asset types

Request

Returns the list of general asset types available within the current account context.

Behavior:

  • Validates manage or view privilege for asset types
  • Retrieves all configured general asset types
  • Returns structured asset type response data
  • Logs the action as an equipment category list view event
curl -i -X GET \
  https://demozone.zlinkfm.com/RND/api/v1/assets/general/assettypes/list

Responses

OK

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

List general asset classes

Request

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

Behavior:

  • Validates manage or view privilege for asset classes
  • Applies keyword filtering from the request body
  • Retrieves matching general asset classes
  • Returns structured asset class response data
  • Logs the action as an equipment type list view event
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/general/assetclass/list \
  -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
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 general asset class

Request

Returns details of the specified general asset class within the current account context.

Behavior:

  • Validates manage privilege for asset classes
  • Verifies the asset class belongs to the account
  • Retrieves asset class details by identifier
  • Returns structured asset class response data
  • Logs the action as an equipment type view event
Path
assetClassIdentifierstring(uuid)required
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/assets/general/assetclass/{assetClassIdentifier}'

Responses

OK

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

Employees

Operations

Facility

Operations

Furniture

Operations

Portfolio

Operations

File Management

Operations

Filegroups

Operations

Tasks

Operations

Service Requests

Operations

PM Work Orders

Operations