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

Portfolio

Operations

File Management

Operations

Filegroups

Operations

Tasks

Operations

Get reactive work order tiles

Request

Returns a paginated list of reactive work order tiles for the current user within the account context.

Behavior:

  • Validates account and user context
  • Supports pagination using the start query parameter
  • Retrieves reactive work order tile data
  • Returns structured reactive work order tile response data
  • Logs the action as a reactive work orders tile view
Query
startinteger(int32)
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v2/maintenance/reactiveworkorders/basic?start=0'

Responses

OK

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

Get pending tasks for My Work

Request

Returns a filtered and paginated list of pending tasks assigned to the current user.

Behavior:

  • Validates account and user context
  • Supports pagination using the start query parameter
  • Applies grouping filter using GroupCode from request body
  • Retrieves pending tasks assigned to the user
  • Returns structured pending task list response data
  • Logs the action as a pending tasks grid view
Query
startinteger(int32)
Body
groupCodestring or null
filtersArray of objects or null(zLink.Business.zOne.Maintenance.RequestModel.ReactiveWorkOrderTileFilterModel)
datafieldIdsArray of strings or null(uuid)
selectedIdsArray of strings or null(uuid)
groupBystring or null
keywordstring or null
sortColumnstring or null
sortColumnIdstring or null(uuid)
sortOrderstring or null
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
filterstring or null
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v2/maintenance/mywork/pendingtasks/list?start=0' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "groupCode": "string",
    "filters": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValues": [
          "string"
        ]
      }
    ],
    "datafieldIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "selectedIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "groupBy": "string",
    "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"
      }
    ],
    "filter": "string"
  }'

Responses

OK

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

Get user tasks

Request

Returns tasks assigned to the current user within the account context.

Behavior:

  • Validates account and user context
  • Applies filtering using request parameters
  • Retrieves tasks assigned to the user
  • Returns structured task response data
  • Logs the action as my tasks view
Body
groupBystring or null
assetCategorystring or null
groupItemIdstring or null
groupItemCodestring or null
includeImagesboolean
isClosedOrDiscardTasksboolean or null
projectIdstring or null(uuid)
projectTaskIdstring or null(uuid)
taskItemTypestring or null
selectedCalendarDatestring or null
planIdstring or null(uuid)
isMaintenancePlanboolean
buildingIdstring or null(uuid)
locationIdstring or null(uuid)
assetIdstring or null(uuid)
isCompletedPlannedWorkboolean or null
isCompletedUnPlannedWorkboolean or null
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
isAdvancedSearchboolean or null
selectedIdsArray of strings or null(uuid)
taskIdstring or null(uuid)
datafieldIdsArray of strings or null
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/tm/users/me/tasks \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "groupBy": "string",
    "assetCategory": "string",
    "groupItemId": "string",
    "groupItemCode": "string",
    "includeImages": true,
    "isClosedOrDiscardTasks": true,
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "projectTaskId": "ba4d5958-f73c-44a6-81be-d450913180bb",
    "taskItemType": "string",
    "selectedCalendarDate": "string",
    "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
    "isMaintenancePlan": true,
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
    "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
    "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
    "isCompletedPlannedWork": true,
    "isCompletedUnPlannedWork": true,
    "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,
    "selectedIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
    "datafieldIds": [
      "string"
    ],
    "keyword": "string",
    "sortColumn": "string",
    "sortColumnId": "0f49f070-9ddb-4e23-bac3-3a9c7797ab4e",
    "sortOrder": "string",
    "filter": "string"
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.TasksManagement.ResponseModel.TaskResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Service Requests

Operations

PM Work Orders

Operations