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 filtered assets

Request

This endpoint returns a list of assets associated with the current account based on the filters specified in the request body.

Behavior:

  • Results are scoped to the current account context
  • Supports filtering and search based on asset attributes
  • Only assets accessible to the user are returned
Body
categoryTypestring or null
keywordstring or null
statusArray of strings or null
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/assets \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "categoryType": "string",
    "keyword": "string",
    "status": [
      "string"
    ]
  }'

Responses

OK

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

Add new general asset

Request

Creates a new general asset within the current account context using the provided request data.

Behavior:

  • Validates manage privilege for equipment
  • Creates a new general asset record
  • Associates the asset with the current account and user
  • Returns the created asset details
  • Logs the action as an equipment added event
Body
isAssignedboolean
assetClassIdstring(uuid)
assetTypeIdstring or null(uuid)
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.AssetEntityDataFieldValue)
spaceDetailsobject(zLink.Business.zOne.Portfolio.RequestModels.SpaceDetail)
generalAssetIdsArray of strings or null(uuid)
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/assets/general/add \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "isAssigned": true,
    "assetClassId": "612ce5f5-12bc-4349-bd22-8eec5b4bdcd6",
    "assetTypeId": "8b5111d6-fc22-4841-bf1b-479a403efd40",
    "fieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": null,
        "dataFieldLabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "spaceDetails": {
      "buildingId": "string",
      "levelId": "string",
      "locationId": "string",
      "roomId": "string",
      "workSpaceId": "string",
      "isAssigned": true,
      "coordinates": [
        0.1
      ]
    },
    "generalAssetIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

OK

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

Update existing general asset

Request

Updates the specified general asset within the current account context using the provided request data.

Behavior:

  • Validates manage privilege for equipment
  • Verifies the asset belongs to the account
  • Updates asset details based on request data
  • Returns the updated asset information
  • Logs the action as an equipment updated event
Path
assetIdentifierstring(uuid)required
Body
isAssignedboolean
assetClassIdstring(uuid)
assetTypeIdstring or null(uuid)
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.AssetEntityDataFieldValue)
spaceDetailsobject(zLink.Business.zOne.Portfolio.RequestModels.SpaceDetail)
generalAssetIdsArray of strings or null(uuid)
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/assets/general/{assetIdentifier}' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "isAssigned": true,
    "assetClassId": "612ce5f5-12bc-4349-bd22-8eec5b4bdcd6",
    "assetTypeId": "8b5111d6-fc22-4841-bf1b-479a403efd40",
    "fieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": null,
        "dataFieldLabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "spaceDetails": {
      "buildingId": "string",
      "levelId": "string",
      "locationId": "string",
      "roomId": "string",
      "workSpaceId": "string",
      "isAssigned": true,
      "coordinates": [
        0.1
      ]
    },
    "generalAssetIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel)
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