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

Complete and close a task

Request

Marks the specified task as completed and closed within the current account context.

Behavior:

  • Validates account and user context
  • Verifies the task belongs to the account
  • Processes completion and closure using provided action details
  • Updates the task status to completed and closed
  • Returns the updated task response data
  • Logs the action as task completed and closed
Path
taskIdstring(uuid)required
Body
uniqueIdstring(uuid)
labourHourDetailsArray of objects or null(zLink.Business.zOne.TasksManagement.RequestModel.LabourHourDetail)
closeRelatedProjectboolean
actionPointUserIdsArray of strings or null(uuid)
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/tm/tasks/{taskid}/completeandclose' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    "labourHourDetails": [
      {
        "technicianId": "dcb67e93-dd0c-4706-9d67-7ccc5cf44418",
        "description": "string",
        "action": "string",
        "endTime": "2019-08-24T14:15:22Z",
        "hoursWorked": 0.1,
        "cost": 0.1,
        "taskLaborId": "0df24608-6dda-4064-a2a7-c6b02c288d78",
        "startTime": "2019-08-24T14:15:22Z"
      }
    ],
    "closeRelatedProject": true,
    "actionPointUserIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

OK

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

Get task summary counts

Request

Returns aggregated task counts for the current user within the account context.

Behavior:

  • Validates account and user context
  • Retrieves task count metrics for the user
  • Returns structured task dashboard summary data
  • Logs the action as task count view
curl -i -X GET \
  https://demozone.zlinkfm.com/RND/api/v1/tm/tasks/summary

Responses

OK

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

Reopen a task

Request

Reopens the specified task within the current account context.

Behavior:

  • Validates account and user context
  • Verifies the task belongs to the account
  • Reassigns and reopens the task using provided details
  • Updates the task status to reopened
  • Returns the updated task response data
  • Logs the action as the task reopened
Path
taskIdstring(uuid)required
Body
workflowActionPointIdstring(uuid)
actionPointUserIdsArray of strings or null(uuid)
labourHourDetailsArray of objects or null(zLink.Business.zOne.TasksManagement.RequestModel.LabourHourDetail)
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/tm/tasks/{taskid}/reopen' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "workflowActionPointId": "d13693c9-f26f-49ff-842d-f499d66a5c63",
    "actionPointUserIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "labourHourDetails": [
      {
        "technicianId": "dcb67e93-dd0c-4706-9d67-7ccc5cf44418",
        "description": "string",
        "action": "string",
        "endTime": "2019-08-24T14:15:22Z",
        "hoursWorked": 0.1,
        "cost": 0.1,
        "taskLaborId": "0df24608-6dda-4064-a2a7-c6b02c288d78",
        "startTime": "2019-08-24T14:15:22Z"
      }
    ]
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel)
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