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

Employees

Operations

Facility

Operations

Furniture

Operations

Add furniture asset

Request

Creates a new furniture asset within the current account context.

Behavior:

  • Resolves the furniture asset type for the account
  • Applies asset details from the request body
  • Creates the furniture asset record
  • Returns the newly created asset details
  • Logs the action as a furniture addition 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/furniture/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 furniture asset

Request

Updates the specified furniture asset within the current account context.

Behavior:

  • Validates asset association with the account
  • Resolves the furniture asset type for the account
  • Applies updated asset details from the request body
  • Persists changes to the furniture asset record
  • Returns the updated asset details
  • Logs the action as a furniture update 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/furniture/{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

Get furniture asset details

Request

Returns detailed information for the specified furniture asset within the current account context.

Behavior:

  • Validates asset association with the account
  • Retrieves furniture asset details and related metadata
  • Returns structured asset detail response
  • Logs the action as a furniture view event
Path
assetIdentifierstring(uuid)required
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/furniture/{assetIdentifier}'

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

Portfolio

Operations

File Management

Operations

Filegroups

Operations

Tasks

Operations

Service Requests

Operations

PM Work Orders

Operations