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

Service Requests

Operations

Create a service request

Request

Creates a new service request within the current account context for the logged-in user.

Behavior:

  • Validates account and user context
  • Creates a new service request using request data
  • Generates a request number
  • Returns the created service request details
  • Logs the action as a service request created
Body
requesterUserIdstring or null
fileFieldValuesToRemoveArray of strings or null(uuid)
locationInfoArray of objects or null(WorkHubCreateServiceRequestRequestModel+SRLocationInfo)
relatedTaskIdstring or null(uuid)
relationIdstring or null(uuid)
ruleIdstring or null(uuid)
serviceRequestDescriptionstring or null
workTypeIdstring or null(uuid)
workTypeCategoryIdstring or null(uuid)
assetsArray of strings or null(uuid)
fileFieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
additionalFieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
actionPointUsersArray of strings or null(uuid)
titlestring or null
endParentItemOnCancellingboolean
completeBeforeParentActionPointIdsArray of strings or null(uuid)
geoJsonDataobject(zLink.Business.zOne.Base.Common.FeatureCollection)
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v2/maintenance/servicerequest/createrequest \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "requesterUserId": "string",
    "fileFieldValuesToRemove": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "locationInfo": [
      {
        "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
        "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
        "levelId": "a70368c7-b12e-43a9-9830-ab2485710b95",
        "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
        "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
        "planFileInfo": [
          {
            "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
            "dataFieldValue": "string",
            "dataFieldlabel": "string",
            "dataFieldValueIds": [
              "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "fromDate": "string",
            "toDate": "string",
            "dataFieldValueRangeType": "string"
          }
        ],
        "geoJsonData": {
          "type": "string",
          "features": [
            {
              "type": "string",
              "id": 0,
              "properties": {
                "property1": null,
                "property2": null
              },
              "geometry": {
                "property1": null,
                "property2": null
              }
            }
          ]
        },
        "markupDataInfo": {
          "cadPlanId": "cbfa2ff4-dbca-4f20-8310-039efa6d984b",
          "description": "string",
          "markupData": "string"
        },
        "assetSvgFileId": "9f1aea3d-799f-4d76-9f96-fb6c4bb0dcef"
      }
    ],
    "relatedTaskId": "83b378c7-7a61-4d0c-a7c1-0c4f0e7cf8cf",
    "relationId": "4b4bc808-5132-481f-afc2-e3872bf12049",
    "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
    "serviceRequestDescription": "string",
    "workTypeId": "7180e94f-af61-4de4-a1a3-d0b22a87b10a",
    "workTypeCategoryId": "ffbe7eb1-e757-4565-accf-7cdecdd2e5dc",
    "assets": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "fileFieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "additionalFieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "actionPointUsers": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "title": "string",
    "endParentItemOnCancelling": true,
    "completeBeforeParentActionPointIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "geoJsonData": {
      "type": "string",
      "features": [
        {
          "type": "string",
          "id": 0,
          "properties": {
            "property1": null,
            "property2": null
          },
          "geometry": {
            "property1": null,
            "property2": null
          }
        }
      ]
    }
  }'

Responses

OK

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

Create a service request

Request

Creates a new service request within the current account context using the provided request details.

Behavior:

  • Validates account and user context
  • Processes the service request creation data
  • Generates a new service request record
  • Returns the created service request response
  • Logs the action as a service request created
Body
relatedTaskIdstring or null(uuid)
relationIdstring or null(uuid)
ruleIdstring or null(uuid)
serviceRequestDescriptionstring or null
workTypeIdstring or null(uuid)
workTypeCategoryIdstring or null(uuid)
assetsArray of strings or null(uuid)
fileFieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
additionalFieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
actionPointUsersArray of strings or null(uuid)
titlestring or null
endParentItemOnCancellingboolean
completeBeforeParentActionPointIdsArray of strings or null(uuid)
geoJsonDataobject(zLink.Business.zOne.Base.Common.FeatureCollection)
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/maintenance/servicerequests/create \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "relatedTaskId": "83b378c7-7a61-4d0c-a7c1-0c4f0e7cf8cf",
    "relationId": "4b4bc808-5132-481f-afc2-e3872bf12049",
    "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
    "serviceRequestDescription": "string",
    "workTypeId": "7180e94f-af61-4de4-a1a3-d0b22a87b10a",
    "workTypeCategoryId": "ffbe7eb1-e757-4565-accf-7cdecdd2e5dc",
    "assets": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "fileFieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "additionalFieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "actionPointUsers": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "title": "string",
    "endParentItemOnCancelling": true,
    "completeBeforeParentActionPointIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "geoJsonData": {
      "type": "string",
      "features": [
        {
          "type": "string",
          "id": 0,
          "properties": {
            "property1": null,
            "property2": null
          },
          "geometry": {
            "property1": null,
            "property2": null
          }
        }
      ]
    }
  }'

Responses

OK

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

Get service request details

Request

Returns detailed information for the specified service request within the current account context.

Behavior:

  • Validates the service request belongs to the account
  • Retrieves detailed service request information
  • Returns structured service request detail response data
  • Logs the action as service request detail view
Path
serviceRequestIdstring(uuid)required
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/maintenance/servicerequests/{serviceRequestId}'

Responses

OK

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

PM Work Orders

Operations