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 asset changesets

Request

Returns the change history of the specified asset based on the provided filters.

Behavior:

  • Validates the asset belongs to the account
  • Applies changeset filtering criteria
  • Supports pagination using limit and start parameters
  • Retrieves asset change history records
  • Logs the action as equipment changeset view
Path
assetIdstring(uuid)required
Query
limitinteger(int32)
Default 100
startinteger(int32)
Default 0
Body
startTimestring or null(date-time)
endTimestring or null(date-time)
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/assets/general/{assetId}/changesets?limit=100&start=0' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z"
  }'

Responses

OK

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

Get asset grid list

Request

Returns a filtered and paginated grid list of general assets.

Behavior:

  • Applies portfolio filtering criteria
  • Supports pagination using the start parameter
  • Retrieves general assets for the account
  • Returns structured asset grid response data
  • Logs the action as equipment grid view
Query
startstring
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/basic/list?start=string' \
  -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.GeneralAssetListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Get basic asset nodes

Request

Returns child asset nodes based on the provided portfolio filters and asset type.

Behavior:

  • Applies portfolio filtering criteria
  • Filters results using the asset type identifier
  • Retrieves child asset node details
  • Returns structured asset node response data
  • Logs the action as asset child list view
Query
assetTypeIdstring
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/nodes/basic?assetTypeId=string' \
  -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
dataArray of objects or null(zLink.Business.zOne.Portfolio.ResponseModels.AssetNodesResponseModel)
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