{
"openapi": "3.0.1",
"info": {
"title": "zOne Web Services",
"description": "The zOne Web Services API enables integration with core platform capabilities,including Maintenance Management, Space Management, and Condition Assessment.\n\nIt 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."
},
"servers": [
{
"url": "https://demozone.zlinkfm.com/RND",
"description": "Demo"
}
],
"paths": {
"/api/v1/account/users/me": {
"get": {
"tags": [
"Account Management"
],
"summary": "Get current user profile",
"description": "This endpoint returns the account and profile information of the logged-in user,\r\nincluding personal details, contact information, timezone preferences, pagination settings,\r\nand platform access permissions.\r\n\r\nThe data is fetched from the configured Identity Provider and enriched with platform-specific\r\nmetadata such as timezone details.\r\n \r\n**Use cases:**\r\n\r\n- Display user profile information in account or settings screens\r\n- Pre-fill user details during profile updates\r\n- Determine platform control access for UI feature visibility",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.MyDetailsResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.MyDetailsResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.MyDetailsResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/current": {
"get": {
"tags": [
"Account Management"
],
"summary": "Get current account",
"description": "This endpoint returns account-level information associated with the\r\ncurrently authenticated user, including contact details, country,\r\ncurrency, timezone configuration, and branding information.\r\n\r\nThe account data is fetched from the configured Identity Provider and\r\nenriched with platform-cached reference data such as country, currency,\r\nand timezone metadata for display purposes.\r\n \r\n**Use cases:**\r\n\r\n- Display account profile and contact information\r\n- Populate account settings and configuration screens\r\n- Resolve account-level locale, currency, and timezone preferences",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.AccountDetailsResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.AccountDetailsResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.AccountDetailsResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/contacts": {
"get": {
"tags": [
"Account Management"
],
"summary": "Get account contacts",
"description": "This endpoint returns all contact records linked to the currently\r\nactive account.\r\n\r\nUse cases:\r\n\r\n- Display account contacts in management or settings screens\r\n- Select contacts for notifications or communication workflows\r\n- View contact details associated with an account",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zlink.business.platformbuilder.zOne.Models.ContactResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zlink.business.platformbuilder.zOne.Models.ContactResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zlink.business.platformbuilder.zOne.Models.ContactResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/account/users/me/changepassword": {
"post": {
"tags": [
"Account Management"
],
"summary": "Change current user password",
"description": "This endpoint allows the logged-in user to update their account password.\r\nThe password change request is forwarded to the configured Identity Provider\r\nand processed for the current user only.\r\n\r\n**Upon successful password change:**\r\n\r\n- All active user sessions are invalidated except the current session\r\n- The password change timestamp is updated for security tracking",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Models.PasswordRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Models.PasswordRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Models.PasswordRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Models.PasswordRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResponse"
}
}
}
}
}
}
},
"/api/v1/auditing/audittrails": {
"post": {
"tags": [
"Audit Trails"
],
"summary": "Get account audit logs",
"description": "This endpoint returns audit trail records generated for the current account,\r\nbased on the supplied filter criteria such as modules, features, actions,\r\nusers, and time range.\r\n\r\nThe results are normalized to the logged-in user’s timezone and returned\r\nin descending order of event occurrence time.\r\n \r\n**Notes:**\r\n\r\n- Only audit records belonging to the current account are returned\r\n- Results are enriched with user and account metadata\r\n- Timestamps are converted to the logged-in user’s timezone",
"parameters": [
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.ActivityLogRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.ActivityLogRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.ActivityLogRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.ActivityLogRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.LogDetailResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.LogDetailResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.LogDetailResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/add": {
"post": {
"tags": [
"Employees"
],
"summary": "Adds a new employee",
"description": "Creates a new employee record within the current account context.\r\n \r\n**Behavior:**\r\n- Associates the employee with the current account\r\n- Applies validation and business rules before persistence\r\n- Logs the action as an employee creation event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeidentifier}/remove": {
"post": {
"tags": [
"Employees"
],
"summary": "Removes an employee",
"description": "Removes the specified employee from the current account.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Applies business rules before removal\r\n- Logs the action as an employee removal event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}": {
"get": {
"tags": [
"Employees"
],
"summary": "Gets employee details",
"description": "Retrieves detailed information for the specified employee\r\nwithin the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Returns complete employee profile information\r\n- Logs the action as an employee view event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Updates an employee",
"description": "Updates the details of the specified employee within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Applies business rules before updating\r\n- Persists the updated employee information\r\n- Logs the action as an employee update event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/files": {
"post": {
"tags": [
"Employees"
],
"summary": "Gets employee files",
"description": "Retrieves files associated with the specified employee within the current account.\r\n \r\n**Behavior:**\r\n- Validates employee access within the account\r\n- Applies filtering or paging based on the request model\r\n- Returns files linked to the employee\r\n- Logs the action as an employee file view event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/location": {
"post": {
"tags": [
"Employees"
],
"summary": "Assign employee location",
"description": "Assigns the specified employee to a location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee and location within the account\r\n- Applies assignment rules and constraints\r\n- Updates the employee’s location details\r\n- Logs the action as an employee assignment event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/location/deassign": {
"post": {
"tags": [
"Employees"
],
"summary": "Unassigns employee location",
"description": "Removes the location assignment for the specified employee within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Removes the current location assignment\r\n- Updates employee allocation status\r\n- Logs the action as an employee de-assignment event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/terminate": {
"post": {
"tags": [
"Employees"
],
"summary": "Terminates an employee",
"description": "Terminates the specified employee within the current account context based on the provided termination details.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Applies termination date and related rules\r\n- Updates employee status to terminated\r\n- Prevents further active assignments if applicable\r\n- Logs the action as an employee termination event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeTerminateDateResponseModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeTerminateDateResponseModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeTerminateDateResponseModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeTerminateDateResponseModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/activate": {
"post": {
"tags": [
"Employees"
],
"summary": "Activates an employee",
"description": "Restores the specified employee to an active status within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Changes employee status to active\r\n- Re-enables eligibility for assignments and operations\r\n- Logs the action as an employee activation event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/location/move": {
"post": {
"tags": [
"Employees"
],
"summary": "Relocates employee",
"description": "Transfers the specified employee from their current location to another location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee and target location within the account\r\n- Ensures the employee has an existing active assignment\r\n- Updates the employee’s location to the new assignment\r\n- Maintains historical move records if applicable\r\n- Logs the action as an employee move event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/assignsupervisor": {
"post": {
"tags": [
"Employees"
],
"summary": "Assign supervisor",
"description": "Associates the specified supervisor with the given employee within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee and supervisor within the account\r\n- Ensures supervisor eligibility and role constraints\r\n- Updates reporting hierarchy for the employee\r\n- Maintains hierarchy integrity rules if applicable\r\n- Logs the action as a supervisor assignment event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.AssignSupervisorRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.AssignSupervisorRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.AssignSupervisorRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.AssignSupervisorRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/summary": {
"post": {
"tags": [
"Employees"
],
"summary": "Get employee summary",
"description": "Returns a consolidated summary of employee-related information for the\r\ncurrent account context.\r\n\r\n**Behavior:**\r\n- Aggregates employee counts and statuses\r\n- Includes active, inactive, assigned, and unassigned employees\r\n- Provides key metrics for reporting or dashboard purposes\r\n- Logs the summary view action",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeSummaryResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeSummaryResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeSummaryResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/profileimage": {
"post": {
"tags": [
"Employees"
],
"summary": "Update profile image",
"description": "Updates the employee's profile image within the current account context using the provided file identifier.\r\n**Behavior:**\r\n- Accepts a file identifier for the new profile image\r\n- Updates the employee's image in the account\r\n- Logs the image upload action\r\n- Returns file details of the uploaded image",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/createuser": {
"post": {
"tags": [
"Employees"
],
"summary": "Create employee account",
"description": "Creates a system user account associated with the specified employee within the current account context.\r\n \r\n**Behavior:**\r\n- Retrieves employee details based on the employee identifier\r\n- Validates employee status before user creation\r\n- Maps employee information to user account fields\r\n- Assigns roles as provided in the request\r\n- Sets account activation and expiry dates\r\n- Creates the user in the identity management system when IsCreateUser is true\r\n- Returns existing employee details if IsCreateUser is false\r\n- Logs the action as a user creation event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.CreateUserRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.CreateUserRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.CreateUserRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.CreateUserRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/all": {
"post": {
"tags": [
"Employees"
],
"summary": "List employees",
"description": "Returns a filtered and/or paginated list of employees within the current account context.\r\n \r\n**Behavior:**\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves employees associated with the account\r\n- Returns summarised employee view details\r\n- Logs the action as an employee list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/qualifications": {
"get": {
"tags": [
"Employees"
],
"summary": "Get employee qualifications",
"description": "Returns the list of qualifications associated with the specified employee within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Retrieves all recorded qualifications for the employee\r\n- Returns qualification details including relevant metadata\r\n- Logs the action as an employee qualification view event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/qualifications/add": {
"post": {
"tags": [
"Employees"
],
"summary": "Add employee qualification",
"description": "Associates a new qualification with the specified employee within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Validates qualification details from the request body\r\n- Creates and links the qualification record to the employee\r\n- Returns the newly added qualification details\r\n- Logs the action as an employee qualification addition event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.QualificationModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.QualificationModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.QualificationModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.QualificationModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/qualifications/{qualificationIdentifier}/remove": {
"post": {
"tags": [
"Employees"
],
"summary": "Remove employee qualification",
"description": "Deletes the specified qualification associated with the given employee within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee and qualification association within the account\r\n- Ensures the qualification exists for the specified employee\r\n- Removes the qualification record\r\n- Returns the removed qualification details if applicable\r\n- Logs the action as an employee qualification removal event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "qualificationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/createtechnician": {
"post": {
"tags": [
"Employees"
],
"summary": "Convert to technician",
"description": "Updates the specified employee to the technician role within the current account context and associates the provided trades.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Validates provided trade identifiers\r\n- Updates employee role to technician\r\n- Associates selected trades with the technician profile\r\n- Returns updated employee details\r\n- Logs the action as an employee role conversion event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeId}/moves": {
"get": {
"tags": [
"Employees"
],
"summary": "Get move history",
"description": "Returns the historical record of location moves for the specified employee within the current account context.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Retrieves chronological move history records\r\n- Includes previous and new location details for each move\r\n- Returns rollback-related information if applicable\r\n- Logs the action as an employee move history view event",
"parameters": [
{
"name": "employeeId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeId}/location/moves/current/rollback": {
"post": {
"tags": [
"Employees"
],
"summary": "Rollback employee move",
"description": "Reverts the employee’s most recent location move within the current account context based on the provided rollback details.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Ensures a current move exists that is eligible for rollback\r\n- Restores the employee to the previous location state\r\n- Updates move history accordingly\r\n- Returns updated rollback information\r\n- Logs the action as an employee move rollback event",
"parameters": [
{
"name": "employeeId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRollBackRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRollBackRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRollBackRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRollBackRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/basic": {
"get": {
"tags": [
"Employees"
],
"summary": "List employee basic details",
"description": "Returns a simplified list of employee details within the current account context.\r\n \r\n**Behavior:**\r\n- Retrieves all employees associated with the account\r\n- Returns essential employee information only\r\n- Excludes extended or detailed profile data\r\n- Logs the action as an employee basic details view event",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/update": {
"post": {
"tags": [
"Employees"
],
"summary": "Updates multiple employees",
"description": "Applies bulk updates to multiple employees within the current account context based on the provided request data.\r\n \r\n**Behavior:**\r\n- Validates employee associations with the account\r\n- Processes update rules for multiple employee records\r\n- Applies changes according to the request model\r\n- Returns the updated employee details list\r\n- Logs the action as a multiple employee update event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/{employeeIdentifier}/cancelTermination": {
"post": {
"tags": [
"Employees"
],
"summary": "Cancels employee termination",
"description": "Reverses the termination status of the specified employee within the current account context and restores the employee to an active state where applicable.\r\n \r\n**Behavior:**\r\n- Validates employee association with the account\r\n- Ensures the employee is currently in a terminated state\r\n- Reverts termination details and status\r\n- Restores eligibility for assignments and operations if applicable\r\n- Returns updated employee details\r\n- Logs the action as an employee termination cancellation event",
"parameters": [
{
"name": "employeeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/locations/update": {
"post": {
"tags": [
"Employees"
],
"summary": "Update employee locations",
"description": "Applies location updates to one or more employees within the current account context based on the provided request data.\r\n \r\n**Behavior:**\r\n- Validates employee associations with the account\r\n- Validates target location details\r\n- Updates location assignments for the specified employees\r\n- Ensures location rules and constraints are enforced\r\n- Logs the action as a bulk employee location update event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.UpdateLocationRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.UpdateLocationRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.UpdateLocationRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.UpdateLocationRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResponse"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/active": {
"post": {
"tags": [
"Employees"
],
"summary": "List active employees",
"description": "Returns a filtered and/or paginated list of active employees within the current account context.\r\n \r\n**Behavior:**\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves only employees with an active status\r\n- Returns summarised employee view details\r\n- Logs the action as an active employee list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees/basic/list": {
"post": {
"tags": [
"Employees"
],
"summary": "Get paginated employee details",
"description": "Returns a filtered and/or paginated list of basic employee details within the current account context.\r\n \r\n**Behavior:**\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves essential employee information only\r\n- Excludes extended profile or detailed data\r\n- Returns summarised employee basic detail results\r\n- Logs the action as an employee basic details list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeBasicDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeBasicDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeBasicDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets": {
"post": {
"tags": [
"Equipment"
],
"summary": "Get filtered assets",
"description": "This endpoint returns a list of assets associated with the current account\r\nbased on the filters specified in the request body.\r\n\r\n**Behavior:**\r\n\r\n- Results are scoped to the current account context\r\n- Supports filtering and search based on asset attributes\r\n- Only assets accessible to the user are returned",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.AssetsDetailRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.AssetsDetailRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.AssetsDetailRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.AssetsDetailRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.AssetsDetailResponseModel[], zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.AssetsDetailResponseModel[], zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.AssetsDetailResponseModel[], zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/add": {
"post": {
"tags": [
"Equipment"
],
"summary": "Add new general asset",
"description": "Creates a new general asset within the current account context using the provided request data.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for equipment\r\n- Creates a new general asset record\r\n- Associates the asset with the current account and user\r\n- Returns the created asset details\r\n- Logs the action as an equipment added event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/{assetIdentifier}": {
"post": {
"tags": [
"Equipment"
],
"summary": "Update existing general asset",
"description": "Updates the specified general asset within the current account context using the provided request data.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for equipment\r\n- Verifies the asset belongs to the account\r\n- Updates asset details based on request data\r\n- Returns the updated asset information\r\n- Logs the action as an equipment updated event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"get": {
"tags": [
"Equipment"
],
"summary": "Get general asset by ID",
"description": "Returns detailed information for the specified general asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the asset belongs to the account\r\n- Retrieves asset details for the given identifier\r\n- Returns structured general asset response data\r\n- Logs the action as an equipment viewed event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/{assetIdentifier}/remove": {
"post": {
"tags": [
"Equipment"
],
"summary": "Remove general asset",
"description": "Removes the specified general asset from the current account context based on the provided request data.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for equipment\r\n- Verifies the asset belongs to the account\r\n- Performs asset removal based on request criteria\r\n- Returns removal status details\r\n- Logs the action as an equipment deleted event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/assettypes/list": {
"get": {
"tags": [
"Equipment"
],
"summary": "Get general asset types",
"description": "Returns the list of general asset types available within the current account context.\r\n \r\n**Behavior:**\r\n- Validates manage or view privilege for asset types\r\n- Retrieves all configured general asset types\r\n- Returns structured asset type response data\r\n- Logs the action as an equipment category list view event",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/assetclass/list": {
"post": {
"tags": [
"Equipment"
],
"summary": "List general asset classes",
"description": "Returns a filtered list of general asset classes within the current account context.\r\n \r\n**Behavior:**\r\n- Validates manage or view privilege for asset classes\r\n- Applies keyword filtering from the request body\r\n- Retrieves matching general asset classes\r\n- Returns structured asset class response data\r\n- Logs the action as an equipment type list view event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/assetclass/{assetClassIdentifier}": {
"get": {
"tags": [
"Equipment"
],
"summary": "Get general asset class",
"description": "Returns details of the specified general asset class within the current account context.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for asset classes\r\n- Verifies the asset class belongs to the account\r\n- Retrieves asset class details by identifier\r\n- Returns structured asset class response data\r\n- Logs the action as an equipment type view event",
"parameters": [
{
"name": "assetClassIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/assettypes/{assetTypeIdentifier}/assetclass/list": {
"get": {
"tags": [
"Equipment"
],
"summary": "List asset classes by type",
"description": "Returns the list of asset classes associated with the specified general asset type within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the asset type belongs to the account\r\n- Retrieves associated asset classes for the given asset type identifier\r\n- Returns structured asset class response data\r\n- Logs the action as an equipment type list view event",
"parameters": [
{
"name": "assetTypeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/assetclass/list/all": {
"post": {
"tags": [
"Equipment"
],
"summary": "Get paginated asset classes",
"description": "Returns a filtered and paginated list of general asset classes within the current account context.\r\n \r\n**Behavior:**\r\n- Validates manage or view privilege for asset classes\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves matching asset classes\r\n- Returns structured asset class list response data\r\n- Logs the action as an equipment type list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/{assetId}/tasks": {
"post": {
"tags": [
"Equipment"
],
"summary": "Get asset tasks",
"description": "Returns a filtered and paginated list of tasks associated with the specified asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the asset belongs to the account\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves tasks linked to the given asset identifier\r\n- Returns structured task list response data\r\n- Logs the action as a task viewed event",
"parameters": [
{
"name": "assetId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/{assetIdentifier}/warranties": {
"post": {
"tags": [
"Equipment"
],
"summary": "Get asset warranties",
"description": "Returns a filtered and paginated list of warranty documents associated with the specified general asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the asset belongs to the account\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves warranty-type operational documents for the asset\r\n- Returns structured operational document list response data\r\n- Logs the action as an equipment warranty list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OperationalDocumentListRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OperationalDocumentListRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OperationalDocumentListRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OperationalDocumentListRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OperationalDocumentListResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OperationalDocumentListResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OperationalDocumentListResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/{assetIdentifier}/relatedAssets": {
"post": {
"tags": [
"Equipment"
],
"summary": "Get related assets",
"description": "Returns related assets associated with the specified general asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the asset belongs to the account\r\n- Applies relation filter from the request body\r\n- Retrieves assets linked to the given asset identifier\r\n- Returns structured related asset response data\r\n- Logs the action as a related asset view event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/{assetIdentifier}/summary": {
"get": {
"tags": [
"Equipment"
],
"summary": "Get asset summary",
"description": "Returns summary details of the specified asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the asset belongs to the account\r\n- Retrieves summary information for the given asset identifier\r\n- Returns structured asset summary response data\r\n- Logs the action as an asset summary view event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetSummaryDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetSummaryDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetSummaryDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/list/basic": {
"post": {
"tags": [
"Equipment"
],
"summary": "List basic assets",
"description": "Returns basic asset details based on the provided portfolio filters.\r\n \r\n**Behavior:**\r\n- Applies portfolio filtering criteria\r\n- Supports pagination using the start parameter\r\n- Returns summarized asset tile information\r\n- Logs the action as equipment tile view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/{assetId}/changesets": {
"post": {
"tags": [
"Equipment"
],
"summary": "Get asset changesets",
"description": "Returns the change history of the specified asset based on the provided filters.\r\n \r\n**Behavior:**\r\n- Validates the asset belongs to the account\r\n- Applies changeset filtering criteria\r\n- Supports pagination using limit and start parameters\r\n- Retrieves asset change history records\r\n- Logs the action as equipment changeset view",
"parameters": [
{
"name": "assetId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/basic/list": {
"post": {
"tags": [
"Equipment"
],
"summary": "Get asset grid list",
"description": "Returns a filtered and paginated grid list of general assets.\r\n \r\n**Behavior:**\r\n- Applies portfolio filtering criteria\r\n- Supports pagination using the start parameter\r\n- Retrieves general assets for the account\r\n- Returns structured asset grid response data\r\n- Logs the action as equipment grid view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/assets/nodes/basic": {
"post": {
"tags": [
"Equipment"
],
"summary": "Get basic asset nodes",
"description": "Returns child asset nodes based on the provided portfolio filters and asset type.\r\n \r\n**Behavior:**\r\n- Applies portfolio filtering criteria\r\n- Filters results using the asset type identifier\r\n- Retrieves child asset node details\r\n- Returns structured asset node response data\r\n- Logs the action as asset child list view",
"parameters": [
{
"name": "assetTypeId",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetNodesResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetNodesResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetNodesResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/assets/general/list": {
"post": {
"tags": [
"Equipment"
],
"summary": "List general assets",
"description": "Returns a filtered and paginated list of general assets for the current account.\r\n \r\n**Behavior:**\r\n- Applies portfolio filtering criteria\r\n- Supports pagination using the start parameter\r\n- Retrieves assets accessible to the current user\r\n- Returns structured general asset list response data\r\n- Logs the action as equipment list view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/shared/{spaceIdentifier}/details": {
"get": {
"tags": [
"Facility"
],
"summary": "Get shared space details",
"description": "Returns detailed information for the specified shared space within the current account context.\r\n \r\n**Behavior:**\r\n- Validates space association with the account\r\n- Retrieves complete space details and related metadata\r\n- Includes configuration and attribute information where applicable\r\n- Returns structured space detail response\r\n- Logs the action as a space details view event",
"parameters": [
{
"name": "spaceIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailsFilterResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailsFilterResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailsFilterResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/{spaceIdentifier}/assignmentinfo": {
"get": {
"tags": [
"Facility"
],
"summary": "Get space assignments",
"description": "Returns assignment-related details for the specified space within the current account context.\r\n \r\n**Behavior:**\r\n- Validates space association with the account\r\n- Retrieves current assignment configuration and occupancy details\r\n- Includes allocation rules and related metadata where applicable\r\n- Returns structured space assignment information\r\n- Logs the action as a space assignment information view event",
"parameters": [
{
"name": "spaceIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAssignmentInfoResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAssignmentInfoResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAssignmentInfoResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/{spaceIdentifier}/amenities": {
"get": {
"tags": [
"Facility"
],
"summary": "Get space amenities",
"description": "Returns the list of amenities associated with the specified space within the current account context.\r\n \r\n**Behavior:**\r\n- Validates space association with the account\r\n- Retrieves all configured amenities for the space\r\n- Returns amenity details and related attributes\r\n- Logs the action as a space amenities view event",
"parameters": [
{
"name": "spaceIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/{spaceIdentifier}/amenities/{amenityidentifier}": {
"get": {
"tags": [
"Facility"
],
"summary": "Get space amenity details",
"description": "Returns detailed information for the specified amenity associated with a space within the current account context.\r\n \r\n**Behavior:**\r\n- Validates space and amenity association with the account\r\n- Ensures the amenity exists for the specified space\r\n- Retrieves amenity configuration and attribute details\r\n- Returns structured amenity detail response\r\n- Logs the action as a space amenity view event",
"parameters": [
{
"name": "spaceIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "amenityidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/{spaceIdentifier}/workspaces": {
"get": {
"tags": [
"Facility"
],
"summary": "Get space workspaces",
"description": "Returns the list of workspaces associated with the specified space within the current account context.\r\n \r\n**Behavior:**\r\n- Validates space association with the account\r\n- Retrieves all workspaces configured under the space\r\n- Returns workspace details and related attributes\r\n- Logs the action as a workspace list view event",
"parameters": [
{
"name": "spaceIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/{spaceIdentifier}/workspaces/{workspaceidentifier}": {
"get": {
"tags": [
"Facility"
],
"summary": "Get workspace details",
"description": "Returns detailed information for the specified workspace associated with a space within the current account context.\r\n \r\n**Behavior:**\r\n- Validates space and workspace association with the account\r\n- Ensures the workspace exists under the specified space\r\n- Retrieves workspace configuration and attribute details\r\n- Returns structured workspace detail response\r\n- Logs the action as a workspace view event",
"parameters": [
{
"name": "spaceIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workspaceidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces": {
"post": {
"tags": [
"Facility"
],
"summary": "List spaces",
"description": "Returns a filtered and/or paginated list of spaces within the current account context.\r\n \r\n**Behavior:**\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves spaces associated with the account\r\n- Returns summarized space detail results\r\n- Logs the action as a spaces list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/summary": {
"post": {
"tags": [
"Facility"
],
"summary": "Get space summary",
"description": "Returns aggregated summary details for spaces within the current account context based on the provided request criteria.\r\n \r\n**Behavior:**\r\n- Applies summary filters from the request body\r\n- Aggregates space-related metrics and statistics\r\n- Retrieves summary data scoped to the account\r\n- Returns structured space summary response\r\n- Logs the action as a space summary view event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.SpaceSummaryRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.SpaceSummaryRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.SpaceSummaryRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.SpaceSummaryRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceSummaryResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceSummaryResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceSummaryResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/locations/{locationId}/buildings/{buildingId}/levels/{levelId}/workSpaces": {
"get": {
"tags": [
"Facility"
],
"summary": "Get workspaces by room hierarchy",
"description": "Returns the list of workspaces under the specified location, building, and level within the current account context.\r\n \r\n**Behavior:**\r\n- Validates location, building, and level association with the account\r\n- Retrieves workspaces mapped to the specified hierarchy\r\n- Returns workspace details and related metadata\r\n- Logs the action as a room workspaces view event",
"parameters": [
{
"name": "locationId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "buildingId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "levelId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.RoomWorkSpacesResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.RoomWorkSpacesResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.RoomWorkSpacesResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/facility/spaces/list": {
"post": {
"tags": [
"Facility"
],
"summary": "Get space grid list",
"description": "Returns a filtered and paginated grid-style list of spaces within the current account context.\r\n \r\n**Behavior:**\r\n- Applies filtering criteria from the request body\r\n- Uses the start query parameter for pagination\r\n- Retrieves spaces associated with the account\r\n- Returns structured grid/list response data\r\n- Logs the action as a space grid view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/spaces/{spaceId}/shared/all": {
"post": {
"tags": [
"Facility"
],
"summary": "List related shared spaces",
"description": "Returns the list of shared spaces associated with the specified space within the current account context.\r\n \r\n**Behavior:**\r\n- Validates space association with the account\r\n- Retrieves all shared space records linked to the specified space\r\n- Returns structured shared space list response\r\n- Logs the action as a shared space view event",
"parameters": [
{
"name": "spaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/general/files/{fileIdentifier}/download": {
"post": {
"tags": [
"File Management"
],
"summary": "Download file by ID",
"description": "This endpoint streams the requested file as an attachment for download.\r\n\r\n**Behavior:**\r\n\r\n- Validates file access against the current account and user\r\n- Determines the appropriate MIME type automatically\r\n- Sets content headers to force file download\r\n- Captures download metadata for auditing purposes",
"parameters": [
{
"name": "fileIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.LogInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.LogInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.LogInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.LogInfo"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v1/filegroups": {
"get": {
"tags": [
"Filegroups"
],
"summary": "Get active file groups",
"description": "This endpoint returns all active file groups configured\r\nunder the current account context.\r\n\r\n**Behavior:**\r\n\r\n- Only active file groups are included\r\n- Results are scoped to the authenticated account\r\n- Used to populate file classification or upload options",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.FileGroupResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.FileGroupResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.FileGroupResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/furniture/add": {
"post": {
"tags": [
"Furniture"
],
"summary": "Add furniture asset",
"description": "Creates a new furniture asset within the current account context.\r\n \r\n**Behavior:**\r\n- Resolves the furniture asset type for the account\r\n- Applies asset details from the request body\r\n- Creates the furniture asset record\r\n- Returns the newly created asset details\r\n- Logs the action as a furniture addition event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/{assetIdentifier}": {
"post": {
"tags": [
"Furniture"
],
"summary": "Update furniture asset",
"description": "Updates the specified furniture asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Resolves the furniture asset type for the account\r\n- Applies updated asset details from the request body\r\n- Persists changes to the furniture asset record\r\n- Returns the updated asset details\r\n- Logs the action as a furniture update event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"get": {
"tags": [
"Furniture"
],
"summary": "Get furniture asset details",
"description": "Returns detailed information for the specified furniture asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Retrieves furniture asset details and related metadata\r\n- Returns structured asset detail response\r\n- Logs the action as a furniture view event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/{assetIdentifier}/remove": {
"post": {
"tags": [
"Furniture"
],
"summary": "Remove furniture asset",
"description": "Removes the specified furniture asset within the current account context based on the provided removal details.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Applies removal rules from the request body\r\n- Marks or deletes the furniture asset as per business logic\r\n- Returns removal confirmation details\r\n- Logs the action as a furniture removal event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/list": {
"post": {
"tags": [
"Furniture"
],
"summary": "List furniture assets",
"description": "Returns a filtered and/or paginated list of furniture assets within the current account context.\r\n \r\n**Behavior:**\r\n- Resolves the furniture asset type for the account\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves furniture assets associated with the account\r\n- Returns structured furniture list response data\r\n- Logs the action as a furniture list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/assettypes/list": {
"get": {
"tags": [
"Furniture"
],
"summary": "List furniture asset types",
"description": "Returns the list of available furniture asset types within the current account context.\r\n \r\n**Behavior:**\r\n- Retrieves asset types configured for furniture\r\n- Filters asset types based on account scope\r\n- Returns asset type identifiers and descriptive details\r\n- Logs the action as a furniture asset type list view event",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/furniture/assetclass/list": {
"post": {
"tags": [
"Furniture"
],
"summary": "List furniture asset classes",
"description": "Returns the list of available furniture asset classes within the current account context based on the provided search criteria.\r\n \r\n**Behavior:**\r\n- Applies keyword filtering from the request body\r\n- Retrieves asset classes configured for furniture\r\n- Filters results based on account scope\r\n- Returns asset class identifiers and descriptive details\r\n- Logs the action as a furniture asset class list view event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/furniture/assetclass/{assetClassIdentifier}": {
"get": {
"tags": [
"Furniture"
],
"summary": "Get asset class details",
"description": "Returns detailed information for the specified furniture asset class within the current account context.\r\n \r\n**Behavior:**\r\n- Validates asset class association with the account\r\n- Retrieves asset class configuration and descriptive details\r\n- Returns structured asset class detail response\r\n- Logs the action as a furniture asset class view event",
"parameters": [
{
"name": "assetClassIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/assettypes/{assetTypeIdentifier}/assetclass/list": {
"get": {
"tags": [
"Furniture"
],
"summary": "List asset classes by type",
"description": "Returns the list of asset classes associated with the specified furniture asset type within the current account context.\r\n \r\n**Behavior:**\r\n- Validates asset type association with the account\r\n- Retrieves all asset classes linked to the specified asset type\r\n- Returns asset class identifiers and descriptive details\r\n- Logs the action as a furniture asset type classes view event",
"parameters": [
{
"name": "assetTypeIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/furniture/{assetIdentifier}/assetimage": {
"post": {
"tags": [
"Furniture"
],
"summary": "Update furniture asset image",
"description": "Uploads or replaces the image associated with the specified furniture asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Validates provided file identifier\r\n- Associates the file as the asset image\r\n- Updates existing image if one already exists\r\n- Returns updated file detail information\r\n- Logs the action as an asset image upload event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/{assetIdentifier}/status": {
"get": {
"tags": [
"Furniture"
],
"summary": "Get furniture asset status",
"description": "Returns the current status information for the specified furniture asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Retrieves current status details of the asset\r\n- Returns structured status information response\r\n- Logs the action as an asset status view event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.Common.StatusInfo, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.Common.StatusInfo, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.Common.StatusInfo, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Furniture"
],
"summary": "Update furniture asset status",
"description": "Updates the current status of the specified furniture asset within the current account context based on the provided status details.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Validates status details from the request body\r\n- Applies status change according to business rules\r\n- Persists updated status information\r\n- Returns updated status details\r\n- Logs the action as an asset status update event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.StatusRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.StatusRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.StatusRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.StatusRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.Common.StatusInfo, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.Common.StatusInfo, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.Common.StatusInfo, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/update": {
"post": {
"tags": [
"Furniture"
],
"summary": "Updates multiple furniture assets",
"description": "Applies bulk updates to multiple furniture assets within the current account context based on the provided request data.\r\n \r\n**Behavior:**\r\n- Resolves the furniture asset type for the account\r\n- Validates asset associations within the account\r\n- Processes update rules for multiple asset records\r\n- Applies changes according to the request model\r\n- Returns the updated furniture asset details list\r\n- Logs the action as a multiple furniture update event",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/furniture/assetclass/list/all": {
"post": {
"tags": [
"Furniture"
],
"summary": "Get paginated asset classes",
"description": "Returns a filtered and paginated list of furniture asset classes within the current account context.\r\n \r\n**Behavior:**\r\n- Applies filtering criteria from the request body\r\n- Uses the start query parameter for pagination\r\n- Retrieves asset classes associated with furniture\r\n- Returns structured asset class list response data\r\n- Logs the action as a furniture asset class list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/{assetIdentifier}/relatedAssets": {
"post": {
"tags": [
"Furniture"
],
"summary": "Get related furniture assets",
"description": "Returns assets related to the specified furniture asset within the current account context based on the provided relation criteria.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Applies relation type filtering from the request body\r\n- Retrieves assets linked to the specified asset\r\n- Returns structured related asset details\r\n- Logs the action as a related asset view event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/{assetIdentifier}/assetlocation/list": {
"post": {
"tags": [
"Furniture"
],
"summary": "Get grouped asset locations",
"description": "Returns a grouped list of location instances associated with the specified furniture asset within the current account context.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Applies filtering criteria from the request body if provided\r\n- Retrieves asset instance locations grouped by hierarchy or category\r\n- Returns structured grouped location response data\r\n- Logs the action as an asset instance location list view event",
"parameters": [
{
"name": "assetIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/assetlocation/{assetLocationIdentifier}": {
"get": {
"tags": [
"Furniture"
],
"summary": "Get asset instance location details",
"description": "Returns detailed information for the specified furniture asset instance location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates asset location identifier\r\n- Retrieves grouped asset location details and related metadata\r\n- Returns structured asset instance location response\r\n- Logs the action as an asset instance location view event",
"parameters": [
{
"name": "assetLocationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Furniture"
],
"summary": "Update asset instance location",
"description": "Updates the specified furniture asset instance location within the current account context based on the provided request details.\r\n \r\n**Behavior:**\r\n- Validates asset location association with the account\r\n- Validates update details from the request body\r\n- Applies changes to the grouped asset location record\r\n- Persists updated location information\r\n- Returns updated asset instance location details\r\n- Logs the action as an asset instance location update event",
"parameters": [
{
"name": "assetLocationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GroupedAssetLocationRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GroupedAssetLocationRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GroupedAssetLocationRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.GroupedAssetLocationRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/basic/list": {
"post": {
"tags": [
"Furniture"
],
"summary": "Get paginated furniture basics",
"description": "Returns a filtered and paginated list of basic furniture asset details within the current account context.\r\n \r\n**Behavior:**\r\n- Resolves the furniture asset type for the account\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the start query parameter\r\n- Retrieves essential furniture asset information only\r\n- Returns structured basic asset list response data\r\n- Logs the action as a furniture basic list view event",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/furniture/{assetId}/changesets": {
"post": {
"tags": [
"Furniture"
],
"summary": "Get furniture changeset history",
"description": "Returns the changeset history for the specified furniture asset within the current account context based on the provided request criteria.\r\n \r\n**Behavior:**\r\n- Validates asset association with the account\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using limit and start query parameters\r\n- Retrieves historical changesets for the asset\r\n- Returns structured changeset history response\r\n- Logs the action as a furniture changeset view event",
"parameters": [
{
"name": "assetId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/current/contacts": {
"post": {
"tags": [
"Organizational Contacts"
],
"summary": "Get organizational contacts",
"description": "This endpoint returns organizational contacts associated with\r\nthe currently authenticated account.\r\n\r\n**Behavior:**\r\n\r\n- Fetches organizational contacts for the current account\r\n- Supports filtering, paging, or sorting via the request model\r\n- Returns a list of organizational contact details",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.CommonRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/account/current/contacts/Add": {
"post": {
"tags": [
"Organizational Contacts"
],
"summary": "Add organizational contact",
"description": "This endpoint creates a new organizational contact associated with\r\nthe currently authenticated account.\r\n\r\n**Behavior:**\r\n\r\n- Validates and persists the organizational contact details\r\n- Associates the contact with the current account\r\n- Returns the newly created contact information",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/current/contacts/{orgContactIdentifier}": {
"get": {
"tags": [
"Organizational Contacts"
],
"summary": "Get organizational contact details",
"description": "This endpoint returns detailed information for a single\r\norganizational contact associated with the current account.\r\n\r\n**Behavior:**\r\n\r\n- Fetches organizational contact details by identifier\r\n- Validates the contact against the current account\r\n- Returns full contact information if found",
"parameters": [
{
"name": "orgContactIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Organizational Contacts"
],
"summary": "Update organizational contact",
"description": "This endpoint updates the details of an organizational contact\r\nassociated with the current account.\r\n\r\n**Behavior:**\r\n\r\n- Updates the organizational contact identified by the route parameter\r\n- Validates the contact against the current account\r\n- Persists the updated contact information",
"parameters": [
{
"name": "orgContactIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v2/maintenance/pmworkorders/basic": {
"post": {
"tags": [
"PM Work Orders"
],
"summary": "Get PM work order tiles",
"description": "Returns a paginated list of preventive maintenance work order tiles for the current user within the account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Supports pagination using the `start` query parameter\r\n- Retrieves preventive maintenance work order tile data\r\n- Returns structured PM work order tile response data\r\n- Logs the action as PM work orders tile view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.PmWorkOrdersTileResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.PmWorkOrdersTileResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.PmWorkOrdersTileResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio": {
"get": {
"tags": [
"Portfolio"
],
"summary": "Get portfolio details",
"description": "Returns the portfolio hierarchy for the current account and user.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Retrieves accessible portfolio locations\r\n- Returns structured location response data\r\n- Logs the action as a map view",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations": {
"get": {
"tags": [
"Portfolio"
],
"summary": "Get portfolio locations",
"description": "Returns all accessible locations within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Retrieves location records associated with the portfolio\r\n- Returns structured location response data\r\n- Logs the action as a location view",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List buildings by location",
"description": "Returns the list of buildings associated with the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the location belongs to the account\r\n- Retrieves buildings linked to the given location identifier\r\n- Returns structured building response data\r\n- Logs the action as a building's view",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List levels by building",
"description": "Returns the list of levels associated with the specified building within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the building belongs to the account\r\n- Retrieves levels linked to the given building identifier\r\n- Returns structured building level response data\r\n- Logs the action as building levels view",
"parameters": [
{
"name": "buildingidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingLevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingLevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingLevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/add": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Add level to building",
"description": "Creates a new level under the specified building and location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for portfolio/buildings\r\n- Verifies location and building belong to the account\r\n- Creates a new building level using request data\r\n- Returns the created level details\r\n- Logs the action as level added",
"parameters": [
{
"name": "locationidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/add": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Add building to location",
"description": "Creates a new building under the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for portfolio/buildings\r\n- Verifies the location belongs to the account\r\n- Creates a new building using request data\r\n- Returns the created building details\r\n- Logs the action as building added",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/plans": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List building plans",
"description": "Returns the list of CAD plans associated with the specified building and location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates building and location belong to the account\r\n- Retrieves CAD plan records for the given identifiers\r\n- Returns structured building plan response data\r\n- Logs the action as building plans view",
"parameters": [
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/{levelidentifier}/plans": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List level plans",
"description": "Returns the list of CAD plans associated with the specified level within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the level belongs to the account\r\n- Retrieves CAD plan records for the given level identifier\r\n- Returns structured level plan response data\r\n- Logs the action as a level plan's view",
"parameters": [
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/plans": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List location plans",
"description": "Returns the list of CAD plans associated with the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates manage or view privilege for portfolio\r\n- Verifies the location belongs to the account\r\n- Retrieves CAD plan records for the given location identifier\r\n- Returns structured location plan response data\r\n- Logs the action as site plans view",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}": {
"get": {
"tags": [
"Portfolio"
],
"summary": "Get location details",
"description": "Returns detailed information for the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the location belongs to the account\r\n- Retrieves detailed location information\r\n- Returns structured location details response data\r\n- Logs the action as a location details view",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Update location",
"description": "Updates the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for portfolio\r\n- Verifies the location belongs to the account\r\n- Updates location details using request data\r\n- Returns the updated location details\r\n- Logs the action as the site updated",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}": {
"get": {
"tags": [
"Portfolio"
],
"summary": "Get building details",
"description": "Returns detailed information for the specified building within the given location and current account context.\r\n \r\n**Behavior:**\r\n- Validates that the building and location belong to the account\r\n- Retrieves detailed building information\r\n- Returns structured building details response data\r\n- Logs the action as building details view",
"parameters": [
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/{levelidentifier}": {
"get": {
"tags": [
"Portfolio"
],
"summary": "Get level details",
"description": "Returns detailed information for the specified level within the given building, location, and current account context.\r\n \r\n**Behavior:**\r\n- Validates the level, building, and location belong to the account\r\n- Retrieves detailed level information\r\n- Returns structured level details response data\r\n- Logs the action as level details view",
"parameters": [
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingIdentifier}": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Update building details",
"description": "Updates the specified building within the given location and current account context.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for portfolio/buildings\r\n- Verifies the building and location belong to the account\r\n- Updates building details using request data\r\n- Returns the updated building details\r\n- Logs the action as building updated",
"parameters": [
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Update level details",
"description": "Updates the specified level within the given building, location, and current account context.\r\n \r\n**Behavior:**\r\n- Validates manage privilege for portfolio/buildings\r\n- Verifies the level, building, and location belong to the account\r\n- Updates level details using request data\r\n- Returns the updated level details\r\n- Logs the action as level updated",
"parameters": [
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/{levelidentifier}/spaces": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List spaces by level",
"description": "Returns the list of spaces associated with the specified level within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the level belongs to the account\r\n- Retrieves space details for the given level identifier\r\n- Returns structured space list response data\r\n- Logs the action as space details view",
"parameters": [
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/{levelidentifier}/spaces/{spaceIdentifier}": {
"get": {
"tags": [
"Portfolio"
],
"summary": "Get space details",
"description": "Returns detailed information for the specified space within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the space belongs to the account\r\n- Retrieves detailed space information by identifier\r\n- Returns structured space detail response data\r\n- Logs the action as space viewed",
"parameters": [
{
"name": "spaceIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "levelidentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/employees": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List employees by level",
"description": "Returns employees associated with the specified location, building, and level within the current account context.\r\n \r\n**Behavior:**\r\n- Supports optional detailed view when `details=yes`\r\n- Supports keyword-based filtering\r\n- Validates hierarchy belongs to the account\r\n- Returns structured employee details list\r\n- Logs the action as employees viewed",
"parameters": [
{
"name": "details",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "keyword",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/employees/others": {
"post": {
"tags": [
"Portfolio"
],
"summary": "List other employees by level",
"description": "Returns additional employees for the specified location, building, and level within the current account context.\r\n \r\n**Behavior:**\r\n- Supports pagination using `start` query parameter\r\n- Accepts filter criteria in request body\r\n- Validates hierarchy belongs to the account\r\n- Returns structured employee response data\r\n- Logs the action as other employees viewed",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/remove": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Remove location",
"description": "Deletes the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Requires portfolio management privileges\r\n- Validates the location belongs to the account\r\n- Removes the location and related associations\r\n- Returns the deletion response model\r\n- Logs the action as site deleted",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/remove": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Remove building",
"description": "Deletes the specified building within the current account context.\r\n \r\n**Behavior:**\r\n- Requires portfolio management privileges\r\n- Validates the building belongs to the account\r\n- Removes the building and related data\r\n- Returns the deletion response model\r\n- Logs the action as building deleted",
"parameters": [
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/remove": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Remove level",
"description": "Deletes the specified level within the current account context.\r\n \r\n**Behavior:**\r\n- Requires portfolio management privileges\r\n- Validates the level belongs to the account\r\n- Removes the level and related associations\r\n- Returns the deletion response model\r\n- Logs the action as level deleted",
"parameters": [
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/location": {
"get": {
"tags": [
"Portfolio"
],
"summary": "Get location geometry",
"description": "Returns the geometry details of the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the location belongs to the account\r\n- Retrieves geometry and spatial data for the location\r\n- Returns structured location geometry response data\r\n- Logs the action as a location geometry view",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Portfolio"
],
"summary": "Update location geometry",
"description": "Updates the geometry data of the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the location belongs to the account\r\n- Updates spatial/geometry data using the provided feature collection\r\n- Persists updated geometry information\r\n- Returns the updated location geometry response\r\n- Logs the action as location geometry updated",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/employees": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Get all employees",
"description": "Returns a filtered and paginated list of employees within the current account context.\r\n \r\n**Behavior:**\r\n- Supports pagination using the `start` query parameter\r\n- Applies filtering criteria from the request body\r\n- Retrieves employees accessible to the current user\r\n- Returns structured employee response data\r\n- Logs the action as employee list view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List rooms by level",
"description": "Returns the list of rooms associated with the specified level within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the level belongs to the account\r\n- Retrieves room details for the given level identifier\r\n- Returns structured room response data\r\n- Logs the action as rooms viewed",
"parameters": [
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms/{roomIdentifier}/workspaces": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List workspaces by room",
"description": "Returns the list of workspaces associated with the specified room within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the room belongs to the account\r\n- Retrieves workspace details for the given room identifier\r\n- Returns structured workspace response data\r\n- Logs the action as workspaces viewed",
"parameters": [
{
"name": "roomIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/activate": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Activate location",
"description": "Activates the specified location within the current account context, optionally including its buildings and levels.\r\n \r\n**Behavior:**\r\n- Requires portfolio management privileges\r\n- Validates the location belongs to the account\r\n- Activates the location and optionally related buildings and floors\r\n- Returns updated location details\r\n- Logs the action as location activated",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationActivateRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationActivateRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationActivateRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationActivateRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/inactivate": {
"post": {
"tags": [
"Portfolio"
],
"summary": "Inactivate location",
"description": "Deactivates the specified location within the current account context.\r\n \r\n**Behavior:**\r\n- Requires portfolio management privileges\r\n- Validates the location belongs to the account\r\n- Performs in-use validation before inactivation\r\n- Deactivates the location upon confirmation\r\n- Returns in-use check response details\r\n- Logs the action as location deactivated",
"parameters": [
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationInactivateRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationInactivateRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationInactivateRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationInactivateRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.InUseCheckResponseModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.InUseCheckResponseModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.InUseCheckResponseModel"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/list": {
"post": {
"tags": [
"Portfolio"
],
"summary": "List location",
"description": "Returns a filtered and paginated list of locations within the current account context.\r\n \r\n**Behavior:**\r\n- Requires portfolio or space view/manage privileges\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the `start` query parameter\r\n- Retrieves locations accessible to the current user\r\n- Returns structured location list response data\r\n- Logs the action as site list view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/buildings/list": {
"post": {
"tags": [
"Portfolio"
],
"summary": "List buildings",
"description": "Returns a filtered and paginated list of buildings within the current account context.\r\n \r\n**Behavior:**\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the `start` query parameter\r\n- Retrieves buildings accessible to the current user\r\n- Returns structured building list response data\r\n- Logs the action as building grid view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/buildings/levels/list": {
"post": {
"tags": [
"Portfolio"
],
"summary": "List levels",
"description": "Returns a filtered and paginated list of levels within the current account context.\r\n \r\n**Behavior:**\r\n- Applies filtering criteria from the request body\r\n- Supports pagination using the `start` query parameter\r\n- Retrieves levels accessible to the current user\r\n- Returns structured level list response data\r\n- Logs the action as a level list view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms/workspaces": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List rooms and workspaces by level",
"description": "Returns rooms and their associated workspaces for the specified level within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the level belongs to the account\r\n- Retrieves rooms along with related workspace details\r\n- Returns structured room and workspace response data\r\n- Logs the action as spaces viewed",
"parameters": [
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms/{roomIdentifier}/workspaces/reserved": {
"get": {
"tags": [
"Portfolio"
],
"summary": "List reserved workspaces by room",
"description": "Returns the list of reserved workspaces associated with the specified room.\r\n \r\n**Behavior:**\r\n- Validates the room identifier\r\n- Retrieves reserved workspace records for the room\r\n- Returns structured workspace response data\r\n- Logs the action as workspaces viewed",
"parameters": [
{
"name": "roomIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "locationIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "buildingIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "levelIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/portfolio/all": {
"get": {
"tags": [
"Portfolio"
],
"summary": "Get all portfolio details",
"description": "Returns the complete portfolio hierarchy for the current account and user.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Retrieves all accessible portfolio locations\r\n- Returns structured portfolio response data\r\n- Logs the action as portfolio details view",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/timezones": {
"get": {
"tags": [
"Reference Data"
],
"summary": "Get supported time zones",
"description": "This endpoint returns all time zones supported by the platform,\r\nincluding UTC offsets, display names, and daylight saving information.\r\nThe data is served from the platform cache and does not require\r\nany user or account context.\r\n \r\n**Use cases:**\r\n\r\n- Populate timezone dropdowns in user or account settings\r\n- Display localized time information\r\n- Validate timezone selections during profile updates",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.TimeZoneResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.TimeZoneResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.TimeZoneResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/filetypes": {
"get": {
"tags": [
"Reference Data"
],
"summary": "Get supported file types",
"description": "This endpoint returns all file types supported by the platform,\r\nincluding file extensions and icon metadata used for display purposes.\r\nThe data is served from the platform cache and is sorted alphabetically\r\nby file type name.\r\n \r\n**Use cases:**\r\n\r\n- Validate file uploads against supported file types\r\n- Display allowed file formats in upload components\r\n- Render file-type icons in the user interface",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.FileTypeResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.FileTypeResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.FileTypeResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v2/myrequests/users/me/returnedrequests/basic": {
"get": {
"tags": [
"Service Requests"
],
"summary": "Get returned requests for the current user",
"description": "Returns the list of requests that were returned to the current user within the account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Retrieves returned service requests assigned to the user\r\n- Returns a structured list of request data\r\n- Logs the action as returned requests view",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ReturnedRequestListResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ReturnedRequestListResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ReturnedRequestListResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v2/myrequests/requests/{requestId}/history": {
"get": {
"tags": [
"Service Requests"
],
"summary": "Get request history",
"description": "Returns the history of actions performed on the specified request within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Retrieves history records for the specified request\r\n- Returns structured request history response data",
"parameters": [
{
"name": "requestId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v2/maintenance/servicerequest/createrequest": {
"post": {
"tags": [
"Service Requests"
],
"summary": "Create a service request",
"description": "Creates a new service request within the current account context for the logged-in user.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Creates a new service request using request data\r\n- Generates a request number\r\n- Returns the created service request details\r\n- Logs the action as a service request created",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/WorkHubCreateServiceRequestRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkHubCreateServiceRequestRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WorkHubCreateServiceRequestRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/WorkHubCreateServiceRequestRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.WorkHubCreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.WorkHubCreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.WorkHubCreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/maintenance/servicerequests/create": {
"post": {
"tags": [
"Service Requests"
],
"summary": "Create a service request",
"description": "Creates a new service request within the current account context using the provided request details.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Processes the service request creation data\r\n- Generates a new service request record\r\n- Returns the created service request response\r\n- Logs the action as a service request created",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.CreateServiceRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.CreateServiceRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.CreateServiceRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.CreateServiceRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/maintenance/servicerequests/{serviceRequestId}": {
"get": {
"tags": [
"Service Requests"
],
"summary": "Get service request details",
"description": "Returns detailed information for the specified service request within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the service request belongs to the account\r\n- Retrieves detailed service request information\r\n- Returns structured service request detail response data\r\n- Logs the action as service request detail view",
"parameters": [
{
"name": "serviceRequestId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ServiceRequestDetailResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ServiceRequestDetailResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ServiceRequestDetailResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Service Requests"
],
"summary": "Update service request details",
"description": "Updates the specified service request within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the service request belongs to the account\r\n- Updates service request details using request data\r\n- Returns the updated service request response",
"parameters": [
{
"name": "serviceRequestId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.UpdateServiceRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.UpdateServiceRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.UpdateServiceRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.UpdateServiceRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/maintenance/servicerequests/{serviceRequestId}/accept": {
"post": {
"tags": [
"Service Requests"
],
"summary": "Accept a service request",
"description": "/// Sets the service request status to accepted for the current account.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the service request belongs to the account\r\n- Updates the service request status to accepted\r\n- Returns the updated service request response\r\n- Logs the action as service request status update",
"parameters": [
{
"name": "serviceRequestId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.StatusRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.StatusRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.StatusRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.StatusRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v2/maintenance/reactiveworkorders/basic": {
"post": {
"tags": [
"Tasks"
],
"summary": "Get reactive work order tiles",
"description": "Returns a paginated list of reactive work order tiles for the current user within the account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Supports pagination using the `start` query parameter\r\n- Retrieves reactive work order tile data\r\n- Returns structured reactive work order tile response data\r\n- Logs the action as a reactive work orders tile view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ReactiveWorkorderTileResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ReactiveWorkorderTileResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ReactiveWorkorderTileResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v2/maintenance/mywork/pendingtasks/list": {
"post": {
"tags": [
"Tasks"
],
"summary": "Get pending tasks for My Work",
"description": "Returns a filtered and paginated list of pending tasks assigned to the current user.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Supports pagination using the `start` query parameter\r\n- Applies grouping filter using `GroupCode` from request body\r\n- Retrieves pending tasks assigned to the user\r\n- Returns structured pending task list response data\r\n- Logs the action as a pending tasks grid view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.MyWorkPendingTaskRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.MyWorkPendingTaskRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.MyWorkPendingTaskRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.MyWorkPendingTaskRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.MyWorkPendingTaskListResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.MyWorkPendingTaskListResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.MyWorkPendingTaskListResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/users/me/tasks": {
"post": {
"tags": [
"Tasks"
],
"summary": "Get user tasks",
"description": "Returns tasks assigned to the current user within the account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Applies filtering using request parameters\r\n- Retrieves tasks assigned to the user\r\n- Returns structured task response data\r\n- Logs the action as my tasks view",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/{taskid}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get task details",
"description": "Returns detailed information for the specified task within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the task belongs to the account\r\n- Retrieves detailed task information\r\n- Returns structured task detail response data\r\n- Logs the action as task details view",
"parameters": [
{
"name": "taskid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/{taskid}/history": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get task history",
"description": "Returns the history of actions performed on the specified task within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the task belongs to the account\r\n- Retrieves task history records\r\n- Returns structured task history response data\r\n- Logs the action as task history view",
"parameters": [
{
"name": "taskid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.TaskHistoryResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.TaskHistoryResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.TaskHistoryResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/tm/users/me/requests/{requestId}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get request details",
"description": "Returns detailed information for the specified user request within the current account context.\r\n \r\n**Behavior:**\r\n- Validates the request belongs to the account\r\n- Retrieves detailed request information\r\n- Returns structured request detail response data\r\n- Logs the action as a request details view",
"parameters": [
{
"name": "requestId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/{taskid}/complete": {
"post": {
"tags": [
"Tasks"
],
"summary": "Complete a task",
"description": "Marks the specified task as completed within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the task belongs to the account\r\n- Processes task completion using provided action details\r\n- Updates the task status to completed\r\n- Returns the updated task response data\r\n- Logs the action as task completed",
"parameters": [
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/{taskid}/close": {
"post": {
"tags": [
"Tasks"
],
"summary": "Close a task",
"description": "Closes the specified task within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the task belongs to the account\r\n- Processes task closure using provided action details\r\n- Updates the task status to closed\r\n- Returns the updated task response data\r\n- Logs the action as the task closed",
"parameters": [
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/{taskid}/completeandclose": {
"post": {
"tags": [
"Tasks"
],
"summary": "Complete and close a task",
"description": "Marks the specified task as completed and closed within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the task belongs to the account\r\n- Processes completion and closure using provided action details\r\n- Updates the task status to completed and closed\r\n- Returns the updated task response data\r\n- Logs the action as task completed and closed",
"parameters": [
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/summary": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get task summary counts",
"description": "Returns aggregated task counts for the current user within the account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Retrieves task count metrics for the user\r\n- Returns structured task dashboard summary data\r\n- Logs the action as task count view",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDashboardResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDashboardResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDashboardResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/{taskid}/reopen": {
"post": {
"tags": [
"Tasks"
],
"summary": "Reopen a task",
"description": "Reopens the specified task within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the task belongs to the account\r\n- Reassigns and reopens the task using provided details\r\n- Updates the task status to reopened\r\n- Returns the updated task response data\r\n- Logs the action as the task reopened",
"parameters": [
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskReAssignRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskReAssignRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskReAssignRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskReAssignRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/{taskId}/activelabors": {
"post": {
"tags": [
"Tasks"
],
"summary": "Get active task labors",
"description": "Returns the list of active labor entries associated with the specified task within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the task belongs to the account\r\n- Retrieves active labor records using provided request details\r\n- Returns structured task labor response data\r\n- Logs the action as an active task labor view",
"parameters": [
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.ActiveTaskLaborRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.ActiveTaskLaborRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.ActiveTaskLaborRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.ActiveTaskLaborRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskLabourDetail, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskLabourDetail, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskLabourDetail, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/tm/tasks/{taskId}/stoplabors": {
"post": {
"tags": [
"Tasks"
],
"summary": "Stop task labors",
"description": "Stops active labor entries associated with the specified task within the current account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Verifies the task belongs to the account\r\n- Stops active labor records using the provided labor details\r\n- Updates task labor status accordingly\r\n- Returns the updated task response data\r\n- Logs the action as task laborers stopped",
"parameters": [
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskLaborRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskLaborRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskLaborRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.TaskLaborRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/tm/users/me/requests/list": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get user request list",
"description": "Returns a paginated list of service requests created by the current user within the account context.\r\n \r\n**Behavior:**\r\n- Validates account and user context\r\n- Supports pagination using the `start` query parameter\r\n- Retrieves service requests associated with the user\r\n- Returns structured service request list response data\r\n- Logs the action as request list view",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.ServiceRequestListResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.ServiceRequestListResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.ServiceRequestListResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users": {
"post": {
"tags": [
"User Management"
],
"summary": "Get account users",
"description": "This endpoint returns users belonging to the currently active account,\r\nwith support for keyword search, sorting, pagination, and view-specific\r\nformatting.\r\n \r\n**Notes:**\r\n\r\n- Only users belonging to the current account are returned\r\n- User data is resolved from cached account user information",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserListResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserListResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserListResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users/{useridentifier}": {
"get": {
"tags": [
"User Management"
],
"summary": "Get user details",
"description": "This endpoint returns profile and role-related information for a user\r\nidentified by the provided user identifier, scoped to the current account.\r\n\r\n**Use cases:**\r\n\r\n- View user profile details in administration screens\r\n- Review assigned roles and permissions\r\n- Prepare user data for edit or role management workflows",
"parameters": [
{
"name": "userIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"User Management"
],
"summary": "Update account user",
"description": "This endpoint updates profile information and role assignments for\r\na specified user within the current account.\r\n\r\nThe user’s email domain is validated against the list of mail domains\r\nconfigured for the account before the update is processed.\r\n\r\n**Process overview:**\r\n\r\n- Validate the user’s email domain\r\n- Update user details through the Identity Provider\r\n- Refresh cached account user data\r\n- Invalidate licensing and permission-related caches",
"parameters": [
{
"name": "userIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users/add": {
"post": {
"tags": [
"User Management"
],
"summary": "Add account user",
"description": "This endpoint creates a new user within the currently active account\r\nand assigns the specified roles and permissions.\r\n\r\nBefore user creation, the user’s email domain is validated against\r\nthe list of mail domains configured for the account. If the domain\r\nis not allowed, the request is rejected.\r\n \r\n**Process overview:**\r\n\r\n- Validate the user’s email domain against configured account domains\r\n- Create the user through the Identity Provider\r\n- Update account user caches and licensing state\r\n- Return the newly created user details and role information",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users/{useridentifier}/remove": {
"post": {
"tags": [
"User Management"
],
"summary": "Remove account user",
"description": "This endpoint deletes a specified user from the currently\r\nactive account. The operation is processed through the Identity Provider\r\nand reflected in the account’s user and licensing state.\r\n\r\n**Process overview:**\r\n\r\n- Delete the user through the Identity Provider\r\n- Update account user and licensed user caches\r\n- Preserve employee-related metadata where applicable",
"parameters": [
{
"name": "userIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users/{useridentifier}/activate": {
"post": {
"tags": [
"User Management"
],
"summary": "Restore account user",
"description": "This endpoint reactivates a previously removed user and restores\r\ntheir access to the current account. The operation is processed\r\nthrough the Identity Provider and reflected in the account’s user\r\nand licensing state.\r\n\r\n**Process overview:**\r\n\r\n- Restore the user through the Identity Provider\r\n- Update cached account user information\r\n- Reapply licensing based on assigned roles",
"parameters": [
{
"name": "userIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users/{useridentifier}/reset": {
"post": {
"tags": [
"User Management"
],
"summary": "Reset user password",
"description": "This endpoint triggers a password reset for the specified user\r\nwithin the current account. The reset operation is handled by the\r\nIdentity Provider and applies immediately.\r\n\r\n**Use cases:**\r\n\r\n- Recover access for users who have forgotten their password\r\n- Enforce password reset for security or compliance reasons",
"parameters": [
{
"name": "userIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users/me/accountdetails": {
"get": {
"tags": [
"User Management"
],
"summary": "Get current user account details",
"description": "This endpoint returns account-related information for the logged-in user,\r\nincluding details of the account the user belongs to and their association\r\nwith it.\r\n\r\nThe data is resolved automatically based on the authenticated user context\r\nand does not require any account or user identifiers in the request.\r\n \r\n**Use cases:**\r\n\r\n- Display account information in user profile or dashboard screens\r\n- Determine the user’s current account context\r\n- Retrieve account metadata for self-service features",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserAccountDetails, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserAccountDetails, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserAccountDetails, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users/update": {
"post": {
"tags": [
"User Management"
],
"summary": "Update multiple users",
"description": "This endpoint allows administrators to perform bulk updates on users\r\nbelonging to the current account. It supports updating role assignments\r\nand related account access properties for multiple users in a single request.\r\n\r\nRequest details:\r\n\r\nAccepts a list of user identifiers to be updated\r\nApplies role and access changes uniformly to all specified users\r\n\r\n \r\n**Behavior:**\r\n\r\n- Each user update is processed via the identity management provider\r\n- Updated user data is synchronized with the account cache\r\n- The response includes the updated state for each processed user",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRoleRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/account/users/active": {
"post": {
"tags": [
"User Management"
],
"summary": "Get active account users",
"description": "This endpoint returns active users associated with the current account,\r\nsupporting keyword-based filtering, sorting, and pagination.\r\n\r\n**Behavior:**\r\n\r\n- Only users in active status are included\r\n- User data is retrieved from the account cache\r\n- The response contains a paginated and sorted user list",
"parameters": [
{
"name": "start",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserListResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserListResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserListResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/users/{userId}/organization/structure/units": {
"get": {
"tags": [
"User Management"
],
"summary": "Get user organizational units",
"description": "This endpoint returns the list of organizational units (structure levels)\r\nthat the specified user has access to within the organization.\r\n\r\n**Behavior:**\r\n\r\n- Fetches organizational access data from the identity management service\r\n- Returns only the organizational units the user is permitted to access\r\n- Results are returned as a flat list of organizational units",
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.OrgUnit, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.OrgUnit, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.OrgUnit, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
},
"post": {
"tags": [
"User Management"
],
"summary": "Assign user organizational units",
"description": "This endpoint adds or updates the organizational units (structure levels)\r\nthat a user is allowed to access within the organization.\r\n\r\n**Behavior:**\r\n\r\n- Accepts a list of organizational unit identifiers in the request body\r\n- Persists user-to-organization access via the identity management service\r\n- Returns the updated list of organizational units assigned to the user",
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserOrgUnitAccessRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserOrgUnitAccessRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Models.UserOrgUnitAccessRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Models.UserOrgUnitAccessRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.OrgUnit, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.OrgUnit, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.OrgUnit, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
},
"/api/v1/account/users/{useridentifier}/unlock": {
"post": {
"tags": [
"User Management"
],
"summary": "Unlock user account",
"description": "This endpoint unlocks a user account that has been locked due to\r\nsecurity policies such as failed login attempts.\r\n\r\n**Behavior:**\r\n\r\n- Invokes the identity management service to unlock the user\r\n- Updates cached user, active user, and basic user details\r\n- Preserves employee-related attributes after unlock",
"parameters": [
{
"name": "userIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/account/users/me/preferences": {
"get": {
"tags": [
"User Preferences"
],
"summary": "Get application preferences",
"description": "This endpoint returns the list of application-level preferences\r\nconfigured for the current user within the active account.\r\n\r\n**Behavior:**\r\n \r\n- Preferences are returned for the authenticated user.\r\n- Results are scoped to the currently active account.\r\n- Only preferences configured for the user are included.\r\n- If no preferences are configured, an empty collection is returned.\r\n- This endpoint does not modify any data.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.ApplicationUserPreferenceResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.ApplicationUserPreferenceResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.ApplicationUserPreferenceResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Models.AccessGroupPrivilegeResponseModel": {
"type": "object",
"properties": {
"privilegeName": {
"type": "string",
"nullable": true
},
"privilegeId": {
"type": "string",
"format": "uuid"
},
"privilegeCode": {
"type": "string",
"nullable": true
},
"accessType": {
"$ref": "#/components/schemas/Models.AccessTypeResponse"
},
"accessLevel": {
"$ref": "#/components/schemas/Models.AccessLevelResponse"
},
"accessMode": {
"$ref": "#/components/schemas/Models.AccessModeResponse"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.AccessLevelResponse": {
"type": "object",
"properties": {
"accessLevelName": {
"type": "string",
"nullable": true
},
"accessLevelId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"Models.AccessModeResponse": {
"type": "object",
"properties": {
"accessModeName": {
"type": "string",
"nullable": true
},
"accessModeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"Models.AccessTypeResponse": {
"type": "object",
"properties": {
"accessTypeName": {
"type": "string",
"nullable": true
},
"accessTypeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"Models.AccountAccesDetails": {
"type": "object",
"properties": {
"loginName": {
"type": "string",
"nullable": true
},
"resetPasswordState": {
"type": "boolean"
},
"activationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expiryDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Models.AccountDetailsResponseModel": {
"type": "object",
"properties": {
"accountName": {
"type": "string",
"nullable": true
},
"accountId": {
"type": "string",
"format": "uuid"
},
"timeZone": {
"$ref": "#/components/schemas/Models.TimeZone"
},
"contactDetails": {
"$ref": "#/components/schemas/Models.ContactDetails"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.AccountInfo": {
"type": "object",
"properties": {
"accountStatus": {
"$ref": "#/components/schemas/Models.StatusInfo"
},
"accountActivationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"accountExpiryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"resetPasswordState": {
"type": "boolean"
},
"isSSOAccount": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Models.ContactDetails": {
"type": "object",
"properties": {
"addressL1": {
"type": "string",
"nullable": true
},
"addressL2": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"country": {
"$ref": "#/components/schemas/Models.Country"
},
"zip": {
"type": "string",
"nullable": true
},
"phone1": {
"type": "string",
"nullable": true
},
"phone2": {
"type": "string",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"contactPerson": {
"type": "string",
"nullable": true
},
"countryId": {
"type": "integer",
"format": "int32"
},
"timezoneId": {
"type": "integer",
"format": "int32"
},
"accountLogo": {
"type": "string",
"nullable": true
},
"currency": {
"$ref": "#/components/schemas/Models.Currency"
},
"currencyId": {
"type": "integer",
"format": "int32"
},
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
},
"zoomLevel": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Models.Country": {
"type": "object",
"properties": {
"countryId": {
"type": "integer",
"format": "int32"
},
"countryName": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.Currency": {
"type": "object",
"properties": {
"currencyId": {
"type": "integer",
"format": "int32"
},
"currencyName": {
"type": "string",
"nullable": true
},
"currencySymbol": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"uniqueId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"Models.FileTypeResponseModel": {
"type": "object",
"properties": {
"fileTypeId": {
"type": "string",
"format": "uuid"
},
"fileTypeName": {
"type": "string",
"nullable": true
},
"fileTypeIconUrl": {
"type": "string",
"nullable": true
},
"fileExtentions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"Models.ListProperty": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"format": "int32"
},
"currentStart": {
"type": "integer",
"format": "int32"
},
"currentLength": {
"type": "integer",
"format": "int32"
},
"pageCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Models.LogDetailResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.LogResponseModel"
},
"nullable": true
},
"endDate": {
"type": "string",
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/Models.ListProperty"
}
},
"additionalProperties": false
},
"Models.LogResponseModel": {
"type": "object",
"properties": {
"action": {
"type": "string",
"nullable": true
},
"module": {
"type": "string",
"nullable": true
},
"feature": {
"type": "string",
"nullable": true
},
"item": {
"type": "string",
"nullable": true
},
"eventStartTime": {
"type": "string",
"nullable": true
},
"additionalComments": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/Models.UsersResponseModel"
},
"account": {
"$ref": "#/components/schemas/Models.AccountDetailsResponseModel"
}
},
"additionalProperties": false
},
"Models.OrgUnit": {
"type": "object",
"properties": {
"accountOrgUnitId": {
"type": "string",
"format": "uuid"
},
"levelOrdinal": {
"type": "integer",
"format": "int32"
},
"accountOrgUnitName": {
"type": "string",
"nullable": true
},
"accountOrgUnitCode": {
"type": "string",
"nullable": true
},
"parentAccountOrgUnitId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"subLevelUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.OrgUnit"
},
"nullable": true
}
},
"additionalProperties": false
},
"Models.PasswordRequestModel": {
"type": "object",
"properties": {
"password": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"format": "uuid"
},
"newPassword": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.StatusDetails": {
"type": "object",
"properties": {
"statusId": {
"type": "integer",
"format": "int32"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"statusName": {
"type": "string",
"nullable": true
},
"statusCode": {
"type": "string",
"nullable": true
},
"statusColor": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.StatusInfo": {
"type": "object",
"properties": {
"statusId": {
"type": "integer",
"format": "int32"
},
"statusName": {
"type": "string",
"nullable": true
},
"statusCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.StatusResponseInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.TimeZone": {
"type": "object",
"properties": {
"timeZoneId": {
"type": "integer",
"format": "int32"
},
"timeZoneName": {
"type": "string",
"nullable": true
},
"utcOffset": {
"type": "integer",
"format": "int32"
},
"dayLightSavingsOffset": {
"type": "integer",
"format": "int32"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"code": {
"type": "string",
"nullable": true
},
"supportsDaylightSavingTime": {
"type": "boolean"
},
"daylightName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.TimeZoneDetails": {
"type": "object",
"properties": {
"timezoneId": {
"type": "string",
"format": "uuid"
},
"timezoneName": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"supportsDaylightSavingTime": {
"type": "boolean"
},
"daylightName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.TimeZoneResponseModel": {
"type": "object",
"properties": {
"timeZoneName": {
"type": "string",
"nullable": true
},
"utcOffset": {
"type": "integer",
"format": "int32"
},
"timeZoneId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"supportsDaylightSavingTime": {
"type": "boolean"
},
"daylightName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.UserAccountDetails": {
"type": "object",
"properties": {
"accountId": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true,
"deprecated": true
},
"accountIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"platformUserId": {
"type": "integer",
"format": "int32"
},
"customProfileInfo": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true,
"deprecated": true
},
"platformUserRoleId": {
"type": "integer",
"format": "int32"
},
"accountInfo": {
"$ref": "#/components/schemas/Models.AccountInfo"
},
"memberOf": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"privileges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.UserPrivilegeResponse"
},
"nullable": true
},
"timeZoneId": {
"type": "integer",
"format": "int32"
},
"userInfo": {
"$ref": "#/components/schemas/Models.UserInfo"
}
},
"additionalProperties": false
},
"Models.UserInfo": {
"type": "object",
"properties": {
"userIdentifier": {
"type": "string",
"format": "uuid"
},
"fullName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"phoneNumber1": {
"type": "string",
"nullable": true
},
"phoneNumber2": {
"type": "string",
"nullable": true
},
"loginName": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
},
"nameDisplayFormat": {
"type": "string",
"nullable": true
},
"rowsPerPage": {
"type": "integer",
"format": "int32"
},
"isSSOUser": {
"type": "boolean"
},
"userRoles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"hasPlatformControlAccess": {
"type": "boolean"
},
"userRoleModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.UserRoleModel"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Models.StatusInfo"
},
"team": {
"$ref": "#/components/schemas/Models.OrgUnit"
},
"statusDetails": {
"$ref": "#/components/schemas/Models.StatusDetails"
},
"isEmployee": {
"type": "boolean"
},
"employeeCode": {
"type": "string",
"nullable": true
},
"isTwoFactorEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Models.UserListResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/Models.ListProperty"
}
},
"additionalProperties": false
},
"Models.UserOrgUnitAccessRequestModel": {
"type": "object",
"properties": {
"orgUnitIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"Models.UserPrivilegeResponse": {
"type": "object",
"properties": {
"privilegeName": {
"type": "string",
"nullable": true
},
"privilegeId": {
"type": "string",
"format": "uuid"
},
"privilegeCode": {
"type": "string",
"nullable": true
},
"accessType": {
"$ref": "#/components/schemas/Models.AccessTypeResponse"
},
"accessLevel": {
"$ref": "#/components/schemas/Models.AccessLevelResponse"
}
},
"additionalProperties": false
},
"Models.UserRequestModel": {
"type": "object",
"properties": {
"keyword": {
"type": "string",
"nullable": true
},
"sortColumn": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
},
"isTileView": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Models.UserRoleModel": {
"type": "object",
"properties": {
"userRoleId": {
"type": "string",
"format": "uuid"
},
"userRoleName": {
"type": "string",
"nullable": true
},
"noofUsers": {
"type": "integer",
"format": "int32"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.UsersDetails"
},
"nullable": true
},
"privileges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.AccessGroupPrivilegeResponseModel"
},
"nullable": true
},
"isLicensed": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.UserRoleRequestModel": {
"type": "object",
"properties": {
"keyword": {
"type": "string",
"nullable": true
},
"userRoleIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"teamId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"userId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"phoneNumber1": {
"type": "string",
"nullable": true
},
"phoneNumber2": {
"type": "string",
"nullable": true
},
"accountAccess": {
"$ref": "#/components/schemas/Models.AccountAccesDetails"
},
"status": {
"$ref": "#/components/schemas/Models.StatusResponseInfo"
},
"email": {
"type": "string",
"nullable": true
},
"timezone": {
"$ref": "#/components/schemas/Models.TimeZoneDetails"
},
"profilePic": {
"type": "string",
"nullable": true
},
"userIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"isSSOUser": {
"type": "boolean"
},
"userRoles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"statusCode": {
"type": "string",
"nullable": true
},
"team": {
"$ref": "#/components/schemas/Models.OrgUnit"
},
"loginName": {
"type": "string",
"nullable": true
},
"statusDetails": {
"$ref": "#/components/schemas/Models.StatusDetails"
},
"isEmployee": {
"type": "boolean"
},
"employeeCode": {
"type": "string",
"nullable": true
},
"isTwoFactorEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Models.UsersDetails": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"userId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Models.UsersResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"userId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Models.StatusResponseInfo"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"WorkHubCreateServiceRequestRequestModel": {
"type": "object",
"properties": {
"requesterUserId": {
"type": "string",
"nullable": true
},
"fileFieldValuesToRemove": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"locationInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkHubCreateServiceRequestRequestModel+SRLocationInfo"
},
"nullable": true
},
"relatedTaskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"relationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ruleId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"serviceRequestDescription": {
"type": "string",
"nullable": true
},
"workTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workTypeCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"assets": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"fileFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"additionalFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"actionPointUsers": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"endParentItemOnCancelling": {
"type": "boolean"
},
"completeBeforeParentActionPointIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"geoJsonData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
},
"additionalProperties": false
},
"WorkHubCreateServiceRequestRequestModel+SRLocationInfo": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"buildingId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"levelId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"roomId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"assetId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"planFileInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"geoJsonData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"markupDataInfo": {
"$ref": "#/components/schemas/WorkHubCreateServiceRequestRequestModel+SRMarkupData"
},
"assetSvgFileId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"WorkHubCreateServiceRequestRequestModel+SRMarkupData": {
"type": "object",
"properties": {
"cadPlanId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"markupData": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.AdditionalInfo": {
"type": "object",
"properties": {
"dataField": {
"type": "string",
"nullable": true
},
"dataFieldId": {
"type": "string",
"format": "uuid"
},
"dataIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"dataFieldValue": {
"nullable": true
},
"dataFieldName": {
"type": "string",
"nullable": true
},
"dataValueFormated": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.AssetEntityDataFieldValue": {
"type": "object",
"properties": {
"dataFieldId": {
"type": "string",
"format": "uuid"
},
"dataFieldValue": {
"nullable": true
},
"dataFieldLabel": {
"type": "string",
"nullable": true
},
"dataFieldValueIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"fromDate": {
"type": "string",
"nullable": true
},
"toDate": {
"type": "string",
"nullable": true
},
"dataFieldValueRangeType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.ChangesetInfo": {
"type": "object",
"properties": {
"dataFieldName": {
"type": "string",
"nullable": true
},
"dataFieldLabel": {
"type": "string",
"nullable": true
},
"oldValue": {
"nullable": true
},
"newValue": {
"nullable": true
},
"changesetInfoType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.EntityDataFieldValue": {
"type": "object",
"properties": {
"dataFieldId": {
"type": "string",
"format": "uuid"
},
"dataFieldValue": {
"type": "string",
"nullable": true
},
"dataFieldlabel": {
"type": "string",
"nullable": true
},
"dataFieldValueIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"fromDate": {
"type": "string",
"nullable": true
},
"toDate": {
"type": "string",
"nullable": true
},
"dataFieldValueRangeType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.Feature": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int64"
},
"properties": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
},
"geometry": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.FeatureCollection": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"features": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.Feature"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.FileDetail": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"nullable": true
},
"fileId": {
"type": "string",
"format": "uuid"
},
"fileSize": {
"type": "string",
"nullable": true
},
"dateAddedOn": {
"type": "string",
"nullable": true
},
"isLinkedDocument": {
"type": "boolean"
},
"preview": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FilePreview"
},
"fileType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileType"
},
"isImage": {
"type": "boolean"
},
"isCadFile": {
"type": "boolean"
},
"customProperties": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
},
"isEditable": {
"type": "boolean"
},
"addedBy": {
"type": "string",
"nullable": true
},
"fileSizeInBytes": {
"type": "integer",
"format": "int64"
},
"fileStatus": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"revisionNumber": {
"type": "integer",
"format": "int32"
},
"addedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isFavorite": {
"type": "boolean"
},
"folderPath": {
"type": "string",
"nullable": true
},
"categoryUniqueId": {
"type": "string",
"format": "uuid"
},
"categoryLevelOrdinal": {
"type": "integer",
"format": "int32"
},
"documentNumber": {
"type": "string",
"nullable": true
},
"fileGroupId": {
"type": "string",
"format": "uuid"
},
"hasPermissionToUpdate": {
"type": "boolean"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.FilePreview": {
"type": "object",
"properties": {
"hasFilePreview": {
"type": "boolean"
},
"hasFileThumbnail": {
"type": "boolean"
},
"previewURL": {
"type": "string",
"nullable": true
},
"thumbnailUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.FileProperty": {
"type": "object",
"properties": {
"totalSize": {
"type": "string",
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.FileType": {
"type": "object",
"properties": {
"fileTypeId": {
"type": "string",
"format": "uuid"
},
"fileTypeName": {
"type": "string",
"nullable": true
},
"fileTypeIconURL": {
"type": "string",
"nullable": true
},
"fileExtentions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.GeneralProperty": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"alias": {
"type": "string",
"nullable": true
},
"dataType": {
"type": "string",
"nullable": true
},
"propertyType": {
"type": "string",
"nullable": true
},
"isKeyData": {
"type": "boolean"
},
"visibility": {
"type": "boolean"
},
"dataFieldId": {
"type": "string",
"format": "uuid"
},
"uiProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.UIProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.ListProperty": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"format": "int32"
},
"currentStart": {
"type": "integer",
"format": "int32"
},
"currentLength": {
"type": "integer",
"format": "int32"
},
"pageCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.Location": {
"type": "object",
"properties": {
"latlong": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"address": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.LocationDetailInfo": {
"type": "object",
"properties": {
"floorLevel": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.BuildingAssetLevel"
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Location"
},
"building": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"organizationUnit": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrganizationUnit"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.LocationInfo": {
"type": "object",
"properties": {
"locationName": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.OrgUnit": {
"type": "object",
"properties": {
"levelName": {
"type": "string",
"nullable": true
},
"unitIdentifier": {
"type": "string",
"format": "uuid"
},
"unitName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.OrgUnitNames": {
"type": "object",
"properties": {
"primaryUnits": {
"type": "string",
"nullable": true
},
"secondaryUnits": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.OrganizationUnit": {
"type": "object",
"properties": {
"orgUnitLevel1": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrgUnit"
},
"orgUnitLevel2": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrgUnit"
},
"orgUnitLevel3": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrgUnit"
},
"orgUnitLevel4": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrgUnit"
},
"orgUnitLevel5": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrgUnit"
},
"orgUnits": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrgUnitNames"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.RollBackInfo": {
"type": "object",
"properties": {
"isRollBack": {
"type": "boolean"
},
"rollBackType": {
"type": "string",
"nullable": true
},
"employeeLocationId": {
"type": "string",
"format": "uuid"
},
"comments": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.StatusInfo": {
"type": "object",
"properties": {
"statusId": {
"type": "string",
"format": "uuid"
},
"statusCode": {
"type": "string",
"nullable": true
},
"statusName": {
"type": "string",
"nullable": true
},
"statusColor": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.Symbol": {
"type": "object",
"properties": {
"symbolId": {
"type": "string",
"format": "uuid"
},
"symbolName": {
"type": "string",
"nullable": true
},
"gisSymbolIcon": {
"type": "string",
"nullable": true
},
"symbolColorCode": {
"type": "string",
"nullable": true
},
"dwgSymbolMode": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.TimeZone": {
"type": "object",
"properties": {
"timeZoneId": {
"type": "integer",
"format": "int32"
},
"timeZoneName": {
"type": "string",
"nullable": true
},
"utcOffSet": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.UserRoleDetails": {
"type": "object",
"properties": {
"accountAccessGroupId": {
"type": "string",
"format": "uuid"
},
"accountAccessGroupName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.Common.WorktypeModel": {
"type": "object",
"properties": {
"worktypeId": {
"type": "string",
"format": "uuid"
},
"worktypeName": {
"type": "string",
"nullable": true
},
"worktypeCode": {
"type": "string",
"nullable": true
},
"worktypeDescription": {
"type": "string",
"nullable": true
},
"autoApproveNewRequest": {
"type": "boolean"
},
"canUpdateRequestDescription": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.Asset": {
"required": [
"ownershipTypeId"
],
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"format": "int32"
},
"assetTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"equipmentCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.EquipmentCategory"
},
"assetMetadata": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetMetadata"
},
"assetGeometry": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetGeometry"
},
"assetSummary": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetSummary"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"assetIdentifier": {
"maxLength": 250,
"minLength": 0,
"type": "string",
"nullable": true
},
"assetDescription": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"nullable": true
},
"accountId": {
"type": "string",
"format": "uuid"
},
"ytdCost": {
"type": "number",
"format": "double"
},
"dateOfExpiry": {
"type": "string",
"format": "date-time",
"nullable": true
},
"assetCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assetCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetCategory"
},
"statusId": {
"type": "integer",
"format": "int32"
},
"isUtilityAsset": {
"type": "boolean"
},
"assetClassId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"equipmentType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.EquipmentType"
},
"currentAssetLocationId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assetLocation": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetLocation"
},
"assetLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetLocation"
},
"nullable": true
},
"isGrouped": {
"type": "boolean"
},
"lotNumber": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"buildingAssetLevels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.BuildingAssetLevel"
},
"nullable": true
},
"assetExtendedField": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetExtendedField"
},
"assetFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetFile"
},
"nullable": true
},
"parentAsset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"ownershipTypeId": {
"type": "integer",
"format": "int32"
},
"replacementCost": {
"type": "number",
"format": "double",
"nullable": true
},
"repairCost": {
"type": "number",
"format": "double",
"nullable": true
},
"remainingUsefulLife": {
"type": "number",
"format": "double",
"nullable": true
},
"estimatedUsefulLife": {
"type": "number",
"format": "double",
"nullable": true
},
"facilityConditionIndex": {
"type": "number",
"format": "double",
"nullable": true
},
"buildingAssetArea": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.AssetCategory": {
"type": "object",
"properties": {
"assetCategoryId": {
"type": "integer",
"format": "int32"
},
"assetCategoryName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"uniqueAssetCategoryCode": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.AssetExtendedField": {
"type": "object",
"properties": {
"assetExtendedFieldId": {
"type": "integer",
"format": "int32"
},
"assetId": {
"type": "integer",
"format": "int32"
},
"asset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"dateOfManufacture": {
"type": "string",
"format": "date-time",
"nullable": true
},
"currentLocationId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"currentLocation": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetLocation"
},
"isAssigned": {
"type": "boolean"
},
"yearofInstallation": {
"type": "integer",
"format": "int32",
"nullable": true
},
"replacementYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseCost": {
"type": "number",
"format": "double"
},
"barcode": {
"maxLength": 100,
"type": "string",
"nullable": true
},
"manufacturerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"model": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"installationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"svgFileId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.AssetFile": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"format": "int32"
},
"asset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"fileId": {
"type": "integer",
"format": "int32"
},
"file": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.File"
},
"defaultImage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.AssetGeometry": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"format": "int32"
},
"asset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"geoJSONString": {
"type": "string",
"nullable": true
},
"geoReferenceData": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.AssetLocation": {
"type": "object",
"properties": {
"assetLocationId": {
"type": "integer",
"format": "int32"
},
"assetId": {
"type": "integer",
"format": "int32"
},
"asset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"geoLocation": {
"maxLength": 75,
"minLength": 0,
"type": "string",
"nullable": true
},
"locationId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Location"
},
"buildingAssetId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"buildingAsset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"buildingAssetLevelId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"buildingAssetLevel": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.BuildingAssetLevel"
},
"roomId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assignedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"previousLocationId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"previousLocation": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetLocation"
},
"workSpaceId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cadPlanCoordinates": {
"maxLength": 100,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.AssetMetadata": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"format": "int32"
},
"asset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"assetMetaData": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.AssetSummary": {
"type": "object",
"properties": {
"assetId": {
"type": "integer",
"format": "int32"
},
"asset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"workSummary": {
"type": "string",
"nullable": true
},
"operationSummary": {
"type": "string",
"nullable": true
},
"performanceSummary": {
"type": "string",
"nullable": true
},
"subItemsSummary": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.BuildingAssetLevel": {
"type": "object",
"properties": {
"buildingAssetLevelId": {
"type": "integer",
"format": "int32"
},
"buildingAssetLevelName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"buildingAssetLevelOrdinal": {
"type": "integer",
"format": "int32"
},
"description": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"nullable": true
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"buildingAssetId": {
"type": "integer",
"format": "int32"
},
"buildingAsset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Asset"
},
"buildingAssetLevelMetadata": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.BuildingAssetLevelMetadata"
},
"statusId": {
"type": "integer",
"format": "int32"
},
"levelArea": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.BuildingAssetLevelMetadata": {
"type": "object",
"properties": {
"buildingAssetLevelId": {
"type": "integer",
"format": "int32"
},
"buildingAssetLevelMetaData": {
"type": "string",
"nullable": true
},
"buildingAssetLevel": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.BuildingAssetLevel"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.EquipmentCategory": {
"type": "object",
"properties": {
"assetTypeId": {
"type": "integer",
"format": "int32"
},
"assetTypeName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"assetCategoryId": {
"type": "integer",
"format": "int32"
},
"assetCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.AssetCategory"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"statusId": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"symbolId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assetSymbol": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Symbol"
},
"structureTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"structureType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.StructureType"
},
"description": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"nullable": true
},
"symbolColorCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"nullable": true
},
"assetTypeCode": {
"maxLength": 15,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.EquipmentType": {
"required": [
"assetClassName"
],
"type": "object",
"properties": {
"assetClassId": {
"type": "integer",
"format": "int32"
},
"assetClassName": {
"maxLength": 250,
"minLength": 0,
"type": "string"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"statusId": {
"type": "integer",
"format": "int32"
},
"assetTypeId": {
"type": "integer",
"format": "int32"
},
"assetType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.EquipmentCategory"
},
"symbolId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assetSymbol": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Symbol"
},
"symbolColorCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.File": {
"type": "object",
"properties": {
"fileId": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"fileCategoryId": {
"type": "integer",
"format": "int32"
},
"fileCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.FileCategory"
},
"fileName": {
"maxLength": 500,
"minLength": 0,
"type": "string",
"nullable": true
},
"isURL": {
"type": "boolean"
},
"fileSize": {
"type": "number",
"format": "double"
},
"fileTypeId": {
"type": "integer",
"format": "int32"
},
"fileType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.FileType"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"repository": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"nullable": true
},
"revisionNumber": {
"type": "integer",
"format": "int32"
},
"isLatest": {
"type": "boolean"
},
"parentRevisionFileId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"parentRevisionFile": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.File"
},
"storageType": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"nullable": true
},
"fullFilePath": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"nullable": true
},
"isLinkedDocument": {
"type": "boolean"
},
"hasFilePreview": {
"type": "boolean"
},
"hasFileThumbnail": {
"type": "boolean"
},
"createdOn": {
"type": "string",
"format": "date-time"
},
"fileMetadata": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.FileMetadata"
},
"description": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"nullable": true
},
"createdBy": {
"type": "string",
"format": "uuid"
},
"fileStatusId": {
"type": "integer",
"format": "int32"
},
"fileCheckStatus": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.FileCheckStatus"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.FileCategory": {
"required": [
"fileCategoryName"
],
"type": "object",
"properties": {
"fileCategoryId": {
"type": "integer",
"format": "int32"
},
"fileCategoryName": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"cloudId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"accountId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"statusId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.FileCheckStatus": {
"type": "object",
"properties": {
"fileCheckStatusId": {
"type": "integer",
"format": "int32"
},
"fileId": {
"type": "integer",
"format": "int32"
},
"file": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.File"
},
"userId": {
"type": "string",
"format": "uuid"
},
"checkInTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"checkOutTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.FileMetadata": {
"type": "object",
"properties": {
"fileId": {
"type": "integer",
"format": "int32"
},
"file": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.File"
},
"fileMetaData": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.FileType": {
"required": [
"fileTypeIconUrl",
"fileTypeName"
],
"type": "object",
"properties": {
"fileTypeId": {
"type": "integer",
"format": "int32"
},
"fileTypeName": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"fileTypeIconUrl": {
"maxLength": 250,
"minLength": 0,
"type": "string"
},
"fileExtentions": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"uniqueId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.Location": {
"type": "object",
"properties": {
"locationId": {
"type": "integer",
"format": "int32"
},
"locationName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"statusId": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"geoLocation": {
"type": "string",
"nullable": true
},
"regionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"region": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Region"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"address": {
"maxLength": 250,
"minLength": 0,
"type": "string",
"nullable": true
},
"description": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"nullable": true
},
"locationMetadata": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.LocationMetadata"
},
"timeZoneId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"noOfBuildings": {
"type": "integer",
"format": "int32"
},
"noOfActiveBuildings": {
"type": "integer",
"format": "int32"
},
"isCadPlanExist": {
"type": "boolean"
},
"locationGeometry": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.LocationGeometry"
},
"locationArea": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.LocationGeometry": {
"type": "object",
"properties": {
"locationId": {
"type": "integer",
"format": "int32"
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Location"
},
"geoJSONString": {
"type": "string",
"nullable": true
},
"geoReferenceData": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.LocationMetadata": {
"type": "object",
"properties": {
"locationId": {
"type": "integer",
"format": "int32"
},
"locationMetaData": {
"type": "string",
"nullable": true
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.Location"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.OwnershipType": {
"type": "object",
"properties": {
"ownershipTypeId": {
"type": "integer",
"format": "int32"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"ownershipTypeName": {
"type": "string",
"nullable": true
},
"ownershipTypeCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.Region": {
"type": "object",
"properties": {
"regionId": {
"type": "integer",
"format": "int32"
},
"regionName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"statusId": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "string",
"format": "uuid"
},
"geoLocation": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"nullable": true
},
"uniqueId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.StructureType": {
"type": "object",
"properties": {
"structureTypeId": {
"type": "integer",
"format": "int32"
},
"structureTypeName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"uniqueId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.DataContext.DataModels.Symbol": {
"type": "object",
"properties": {
"symbolId": {
"type": "integer",
"format": "int32"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"symbolName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"gisSymbolIcon": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"nullable": true
},
"symbolGeometry": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"nullable": true
},
"symbolIcon": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"statusId": {
"type": "integer",
"format": "int32"
},
"symbolColorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.RequestModels.AssetsDetailRequestModel": {
"type": "object",
"properties": {
"categoryType": {
"type": "string",
"nullable": true
},
"keyword": {
"type": "string",
"nullable": true
},
"status": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.RequestModels.ChangesetRequestModel": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.RequestModels.CommonRequestModel": {
"type": "object",
"properties": {
"keyword": {
"type": "string",
"nullable": true
},
"sortColumn": {
"type": "string",
"nullable": true
},
"sortColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
},
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"selectedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"datafieldIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"filter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.RequestModels.GeneralPortfolioRequestModel": {
"type": "object",
"properties": {
"siteIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"buildingIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"levelIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"roomId": {
"type": "string",
"nullable": true
},
"assetClassId": {
"type": "string",
"nullable": true
},
"assetTypeId": {
"type": "string",
"nullable": true
},
"assigned": {
"type": "boolean"
},
"unassigned": {
"type": "boolean"
},
"datafieldIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"selectedIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"status": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"isEquipmentWithSpaceHandle": {
"type": "boolean"
},
"includeFurniture": {
"type": "boolean",
"nullable": true
},
"levelName": {
"type": "string",
"nullable": true
},
"levelPosition": {
"type": "integer",
"format": "int32"
},
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"isAdvancedSearch": {
"type": "boolean",
"nullable": true
},
"isLinkAsset": {
"type": "boolean"
},
"assetClassIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"assetTypeIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"keyword": {
"type": "string",
"nullable": true
},
"sortColumn": {
"type": "string",
"nullable": true
},
"sortColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
},
"filter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.RequestModels.LogInfo": {
"type": "object",
"properties": {
"moduleName": {
"type": "string",
"nullable": true
},
"featureName": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.RequestModels.OperationalDocumentListRequestModel": {
"type": "object",
"properties": {
"dataFieldIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"selectedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"assetId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"keyword": {
"type": "string",
"nullable": true
},
"sortColumn": {
"type": "string",
"nullable": true
},
"sortColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
},
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"datafieldIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"filter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.RequestModels.OrganizationalContactsRequestModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"profilePicFileId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"phone1": {
"type": "string",
"nullable": true
},
"phone2": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"secondaryName": {
"type": "string",
"nullable": true
},
"secondaryEmail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.RequestModels.PriorityRequestModel": {
"type": "object",
"properties": {
"priorityName": {
"type": "string",
"nullable": true
},
"priorityRank": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"priorityColorCode": {
"type": "string",
"nullable": true
},
"priorityId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.ActionPointUserResponseModel": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.ApplicationUserPreferenceResponseModel": {
"type": "object",
"properties": {
"preferenceCode": {
"type": "string",
"nullable": true
},
"preferenceValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.AssetsDetailResponseModel": {
"type": "object",
"properties": {
"assetCategory": {
"type": "string",
"nullable": true
},
"assetCatagoryName": {
"type": "string",
"nullable": true
},
"assetIdentifier": {
"type": "string",
"nullable": true
},
"assetId": {
"type": "string",
"format": "uuid"
},
"assetType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.ChangeSetResponseModel": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.UserResponseModel"
},
"date": {
"type": "string",
"nullable": true
},
"entityId": {
"type": "string",
"format": "uuid"
},
"changesetInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ChangesetInfo"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel": {
"type": "object",
"properties": {
"properties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileProperty"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.FileGroupResponseModel": {
"type": "object",
"properties": {
"fileGroupId": {
"type": "string",
"format": "uuid"
},
"fileGroupName": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.InUseCheckResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isInUse": {
"type": "boolean"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel": {
"type": "object",
"properties": {
"asset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.AssetsDetailResponseModel"
},
"featureCollection": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.ChangeSetResponseModel"
},
"nullable": true
},
"endDate": {
"type": "string",
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.OperationalDocumentCategoryResponseModel": {
"type": "object",
"properties": {
"operationalDocumentCategoryId": {
"type": "string",
"format": "uuid"
},
"operationalDocumentCategoryName": {
"type": "string",
"nullable": true
},
"operationalDocumentCategoryCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.OperationalDocumentListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.OperationalDocumentResponseModel"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.OperationalDocumentResponseModel": {
"type": "object",
"properties": {
"operationalDocumentName": {
"type": "string",
"nullable": true
},
"operationalDocumentId": {
"type": "string",
"format": "uuid"
},
"operationalDocumentNumber": {
"type": "string",
"nullable": true
},
"documentNumber": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"date": {
"type": "string",
"nullable": true
},
"validity": {
"type": "string",
"nullable": true
},
"expiryDate": {
"type": "string",
"nullable": true
},
"followupDate": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"operationalDocumentType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.OperationalDocumentTypeResponseModel"
},
"operationalDocumentCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.OperationalDocumentCategoryResponseModel"
},
"operationalDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.OperationalDocumentResponseModel"
},
"nullable": true
},
"validityInDays": {
"type": "number",
"format": "double"
},
"file": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"validFor": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.ValidFor"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.OperationalDocumentTypeResponseModel": {
"type": "object",
"properties": {
"operationalDocumentTypeName": {
"type": "string",
"nullable": true
},
"operationalDocumentTypeId": {
"type": "string",
"format": "uuid"
},
"canRenew": {
"type": "boolean"
},
"canEditDocumentTypeNumber": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
},
"phone1": {
"type": "string",
"nullable": true
},
"phone2": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"secondaryName": {
"type": "string",
"nullable": true
},
"secondaryEmail": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.PriorityResponseModel": {
"type": "object",
"properties": {
"priorityName": {
"type": "string",
"nullable": true
},
"priorityRank": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"priorityColorCode": {
"type": "string",
"nullable": true
},
"priorityId": {
"type": "string",
"format": "uuid"
},
"statusId": {
"type": "integer",
"format": "int32"
},
"taskCount": {
"type": "integer",
"format": "int32"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.TaskHistoryResponseModel": {
"type": "object",
"properties": {
"taskHistoryId": {
"type": "string",
"format": "uuid"
},
"profilePic": {
"type": "string",
"nullable": true
},
"actionDoneByName": {
"type": "string",
"nullable": true
},
"actionDoneOn": {
"type": "string",
"nullable": true
},
"actionDescription": {
"type": "string",
"nullable": true
},
"actionName": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
},
"taskHistoryType": {
"type": "string",
"nullable": true
},
"updatedFieldName": {
"type": "string",
"nullable": true
},
"updatedFieldValue": {
"type": "string",
"nullable": true
},
"hasFile": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.TradeDetails": {
"type": "object",
"properties": {
"tradeId": {
"type": "string",
"format": "uuid"
},
"tradeName": {
"type": "string",
"nullable": true
},
"hourlyRate": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.UIProperty": {
"type": "object",
"properties": {
"fullWidth": {
"type": "boolean"
},
"columnWidth": {
"type": "string",
"nullable": true
},
"columnSpan": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.UserResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.ValidFor": {
"type": "object",
"properties": {
"period": {
"type": "integer",
"format": "int32"
},
"interval": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.WorkFlowModel": {
"type": "object",
"properties": {
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.WorktypeModel"
},
"workflowId": {
"type": "string",
"format": "uuid"
},
"workflowName": {
"type": "string",
"nullable": true
},
"workflowCode": {
"type": "string",
"nullable": true
},
"workflowRevisions": {
"type": "integer",
"format": "int32"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.WorkTypeResponseModel": {
"type": "object",
"properties": {
"workFlow": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorkflowResponseModel"
},
"worktypeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"nullable": true
},
"worktypeId": {
"type": "string",
"format": "uuid"
},
"worktypeName": {
"type": "string",
"nullable": true
},
"worktypeCode": {
"type": "string",
"nullable": true
},
"worktypeDescription": {
"type": "string",
"nullable": true
},
"autoApproveNewRequest": {
"type": "boolean"
},
"canUpdateRequestDescription": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.WorkflowResponseModel": {
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"format": "uuid"
},
"workflowName": {
"type": "string",
"nullable": true
},
"workflowCode": {
"type": "string",
"nullable": true
},
"workflowRevisions": {
"type": "integer",
"format": "int32"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel": {
"type": "object",
"properties": {
"worktypeCategoryId": {
"type": "string",
"format": "uuid"
},
"worktypeCategoryName": {
"type": "string",
"nullable": true
},
"worktypeCategoryCode": {
"type": "string",
"nullable": true
},
"worktypeCategoryDescription": {
"type": "string",
"nullable": true
},
"autoApproveNewRequest": {
"type": "boolean"
},
"parentWorkTypeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"levelOrdinal": {
"type": "integer",
"format": "int32"
},
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.WorktypeModel"
},
"workFlow": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorkFlowModel"
},
"worktypeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"nullable": true
},
"canUpdateRequestDescription": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.Common.EntityActionDetails": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"format": "uuid"
},
"actionForId": {
"type": "string",
"nullable": true
},
"actionForName": {
"type": "string",
"nullable": true
},
"action": {
"type": "string",
"nullable": true
},
"entityActionDoneOn": {
"type": "string",
"nullable": true
},
"hoursSpent": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.RequestModel.CreateServiceRequestModel": {
"type": "object",
"properties": {
"relatedTaskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"relationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ruleId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"serviceRequestDescription": {
"type": "string",
"nullable": true
},
"workTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workTypeCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"assets": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"fileFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"additionalFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"actionPointUsers": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"endParentItemOnCancelling": {
"type": "boolean"
},
"completeBeforeParentActionPointIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"geoJsonData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.RequestModel.MyWorkPendingTaskRequestModel": {
"type": "object",
"properties": {
"groupCode": {
"type": "string",
"nullable": true
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.RequestModel.ReactiveWorkOrderTileFilterModel"
},
"nullable": true
},
"datafieldIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"selectedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"groupBy": {
"type": "string",
"nullable": true
},
"keyword": {
"type": "string",
"nullable": true
},
"sortColumn": {
"type": "string",
"nullable": true
},
"sortColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
},
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"filter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.RequestModel.ReactiveWorkOrderTileFilterModel": {
"type": "object",
"properties": {
"dataFieldId": {
"type": "string",
"format": "uuid"
},
"dataFieldValues": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.RequestModel.StatusRequestModel": {
"type": "object",
"properties": {
"statusCode": {
"type": "string",
"nullable": true
},
"workTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"worktypeCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"additionalFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"serviceRequestDescription": {
"type": "string",
"nullable": true
},
"taskComments": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.RequestModel.UpdateServiceRequestModel": {
"type": "object",
"properties": {
"serviceRequestDescription": {
"type": "string",
"nullable": true
},
"additionalFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.ActionByUserResponseModel": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"format": "uuid"
},
"userName": {
"type": "string",
"nullable": true
},
"userProfile": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"requestNumber": {
"type": "string",
"nullable": true
},
"requestType": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"requestDescription": {
"type": "string",
"nullable": true
},
"requestSource": {
"type": "string",
"nullable": true
},
"requestedOn": {
"type": "string",
"nullable": true
},
"requesterDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.RequesterInfo"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.PriorityRequestModel"
},
"workOrderNumber": {
"type": "string",
"nullable": true
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"nullable": true
},
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.WorktypeModel"
},
"workTypeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"requestedFor": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.RequesterInfo"
},
"expectedDateOfCompletion": {
"type": "string",
"nullable": true
},
"currentActionPoint": {
"type": "string",
"nullable": true
},
"actionBy": {
"type": "string",
"nullable": true
},
"siteName": {
"type": "string",
"nullable": true
},
"buildingName": {
"type": "string",
"nullable": true
},
"geoJsonData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"loggedInUserExistInForActionby": {
"type": "boolean"
},
"serviceRequestInitialInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"hasAnyOnGoingLabours": {
"type": "boolean",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.MyWorkPendingTaskListResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.MyWorkPendingTaskResponseModel"
},
"nullable": true
},
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.MyWorkPendingTaskResponseModel": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"format": "uuid"
},
"taskNumber": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"taskType": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"workType": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.PriorityDataResponseModel"
},
"actionBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.ActionByUserResponseModel"
},
"nullable": true
},
"addedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"actionByString": {
"type": "string",
"nullable": true
},
"completedOn": {
"type": "string",
"nullable": true
},
"taskItemType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.PMWorkOrderResponseModel": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"format": "uuid"
},
"workOrderNumber": {
"type": "string",
"nullable": true
},
"expectedDateOfCompletion": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.PriorityDataResponseModel"
},
"workType": {
"type": "string",
"nullable": true
},
"actionBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.ActionByUserResponseModel"
},
"nullable": true
},
"planName": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"generatedDate": {
"type": "string",
"nullable": true
},
"completedOn": {
"type": "string",
"nullable": true
},
"closedOn": {
"type": "string",
"nullable": true
},
"discardedOn": {
"type": "string",
"nullable": true
},
"scheduledDate": {
"type": "string",
"nullable": true
},
"planSchedule": {
"type": "string",
"nullable": true
},
"taskItemType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.PmWorkOrdersTileResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.PMWorkOrderResponseModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.PriorityDataResponseModel": {
"type": "object",
"properties": {
"priorityId": {
"type": "string",
"format": "uuid"
},
"priorityName": {
"type": "string",
"nullable": true
},
"priorityColorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.PriorityResponseModel": {
"type": "object",
"properties": {
"priorityId": {
"type": "string",
"format": "uuid"
},
"priorityName": {
"type": "string",
"nullable": true
},
"priorityColorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.ReactiveWorkOrderResponseModel": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"format": "uuid"
},
"taskNumber": {
"type": "string",
"nullable": true
},
"expectedDateOfCompletion": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.PriorityResponseModel"
},
"workType": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"actionBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.ActionByUserResponseModel"
},
"nullable": true
},
"completedOn": {
"type": "string",
"nullable": true
},
"requestedBy": {
"type": "string",
"nullable": true
},
"requestedOn": {
"type": "string",
"nullable": true
},
"currentActionPoint": {
"type": "string",
"nullable": true
},
"site": {
"type": "string",
"nullable": true
},
"building": {
"type": "string",
"nullable": true
},
"scheduledDate": {
"type": "string",
"nullable": true
},
"addedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"closedOn": {
"type": "string",
"nullable": true
},
"discardedOn": {
"type": "string",
"nullable": true
},
"taskItemType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.ReactiveWorkorderTileResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.ReactiveWorkOrderResponseModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.RequesterInfo": {
"type": "object",
"properties": {
"requesterName": {
"type": "string",
"nullable": true
},
"requesterEmail": {
"type": "string",
"nullable": true
},
"requesterContactNumber": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.ReturnedRequestListResponseModel": {
"type": "object",
"properties": {
"returnedRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.ReturnedRequestResponseModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.ReturnedRequestResponseModel": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"requestNumber": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"requestDescription": {
"type": "string",
"nullable": true
},
"expectedDateOfCompletion": {
"type": "string",
"nullable": true
},
"workType": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.PriorityDataResponseModel"
},
"dueDate": {
"type": "string",
"nullable": true
},
"addedOn": {
"type": "string",
"nullable": true
},
"taskItemType": {
"type": "string",
"nullable": true
},
"completedOn": {
"type": "string",
"nullable": true
},
"closedOn": {
"type": "string",
"nullable": true
},
"workTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workTypeCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"canUpdateRequestDescription": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.ServiceRequestDetailResponseModel": {
"type": "object",
"properties": {
"workOrder": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.WorkOrder"
},
"task": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskInfo"
},
"requestId": {
"type": "string",
"format": "uuid"
},
"requestNumber": {
"type": "string",
"nullable": true
},
"requestType": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"requestDescription": {
"type": "string",
"nullable": true
},
"requestSource": {
"type": "string",
"nullable": true
},
"requestedOn": {
"type": "string",
"nullable": true
},
"requesterDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.RequesterInfo"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.PriorityRequestModel"
},
"workOrderNumber": {
"type": "string",
"nullable": true
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"nullable": true
},
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.WorktypeModel"
},
"workTypeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"requestedFor": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.RequesterInfo"
},
"expectedDateOfCompletion": {
"type": "string",
"nullable": true
},
"currentActionPoint": {
"type": "string",
"nullable": true
},
"actionBy": {
"type": "string",
"nullable": true
},
"siteName": {
"type": "string",
"nullable": true
},
"buildingName": {
"type": "string",
"nullable": true
},
"geoJsonData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"loggedInUserExistInForActionby": {
"type": "boolean"
},
"serviceRequestInitialInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"hasAnyOnGoingLabours": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.TaskDetails": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"format": "uuid"
},
"taskNumber": {
"type": "string",
"nullable": true
},
"statusId": {
"type": "integer",
"format": "int32"
},
"taskItemType": {
"type": "string",
"nullable": true
},
"addedOn": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.WorkHubCreateServiceRequestResponseModel": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"requestNumber": {
"type": "string",
"nullable": true
},
"requestType": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"requestDescription": {
"type": "string",
"nullable": true
},
"requestedOn": {
"type": "string",
"nullable": true
},
"requesterDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.RequesterInfo"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.PriorityRequestModel"
},
"workOrderNumber": {
"type": "string",
"nullable": true
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"nullable": true
},
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.WorktypeModel"
},
"workTypeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"requestedFor": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.RequesterInfo"
},
"currentActionPoint": {
"type": "string",
"nullable": true
},
"actionBy": {
"type": "string",
"nullable": true
},
"siteName": {
"type": "string",
"nullable": true
},
"buildingName": {
"type": "string",
"nullable": true
},
"geoJsonData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"serviceRequestInitialInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"hasAnyOnGoingLabours": {
"type": "boolean",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"organizationalUnitLevel1": {
"type": "string",
"nullable": true
},
"filefieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"assets": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"locationDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.LocationDetailInfo"
},
"nullable": true
},
"taskDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.TaskDetails"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryDetails": {
"type": "object",
"properties": {
"taskHistoryId": {
"type": "string",
"format": "uuid"
},
"profilePic": {
"type": "string",
"nullable": true
},
"actionDoneByName": {
"type": "string",
"nullable": true
},
"actionDoneOn": {
"type": "string",
"nullable": true
},
"actionDescription": {
"type": "string",
"nullable": true
},
"actionName": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
},
"taskHistoryType": {
"type": "string",
"nullable": true
},
"updatedFieldName": {
"type": "string",
"nullable": true
},
"updatedFieldValue": {
"type": "string",
"nullable": true
},
"hasFile": {
"type": "boolean"
},
"actionDoneByUserId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"entityActionDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.Common.EntityActionDetails"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryResponseModel": {
"type": "object",
"properties": {
"all": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryDetails"
},
"nullable": true
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryDetails"
},
"nullable": true
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryDetails"
},
"nullable": true
},
"updates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryDetails"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.EmployeeDesignationModel": {
"type": "object",
"properties": {
"employeeDesignationId": {
"type": "string",
"format": "uuid"
},
"employeeDesignationName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.EmployeeGradeModel": {
"type": "object",
"properties": {
"employeeGradeId": {
"type": "string",
"format": "uuid"
},
"employeeGradeName": {
"type": "string",
"nullable": true
},
"rank": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.EmployeeInfo": {
"type": "object",
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"employmentType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmploymentTypeResponseModel"
},
"employeeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeCategoryResponseModel"
},
"supervisor": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeInfo"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"employeeWorkMode": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeWorkModeResponseModel"
},
"serviceEndDate": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeServiceEndDate"
},
"employeeId": {
"type": "string",
"format": "uuid"
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeMiddleName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"employeeCode": {
"type": "string",
"nullable": true
},
"employeeRole": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
},
"dateOfTermination": {
"type": "string",
"nullable": true
},
"dateOfJoining": {
"type": "string",
"nullable": true
},
"employeeUserId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isTechnician": {
"type": "boolean"
},
"isCreateUserAccount": {
"type": "boolean"
},
"userRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.UserRoleDetails"
},
"nullable": true
},
"isSupervisor": {
"type": "boolean"
},
"isRollBackAllowed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.EmployeeServiceEndDate": {
"type": "object",
"properties": {
"serviceEndDate": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.EmployeeWorkModeResponseModel": {
"type": "object",
"properties": {
"employeeWorkModeId": {
"type": "string",
"format": "uuid"
},
"employeeWorkModeName": {
"type": "string",
"nullable": true
},
"employeeWorkModeCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.EmploymentTypeResponseModel": {
"type": "object",
"properties": {
"employmentTypeId": {
"type": "string",
"format": "uuid"
},
"employmentTypeName": {
"type": "string",
"nullable": true
},
"employmentTypeCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.LevelInfo": {
"type": "object",
"properties": {
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"levelIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.LocationData": {
"type": "object",
"properties": {
"location": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"building": {
"type": "string",
"nullable": true
},
"buildingId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"level": {
"type": "string",
"nullable": true
},
"levelId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"assetLevelId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"featureCollection": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.LocationDetail": {
"type": "object",
"properties": {
"location": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"building": {
"type": "string",
"nullable": true
},
"buildingId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"level": {
"type": "string",
"nullable": true
},
"levelId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"room": {
"type": "string",
"nullable": true
},
"roomId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workspace": {
"type": "string",
"nullable": true
},
"workspaceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"spaceKey": {
"type": "string",
"nullable": true
},
"spaceAssignedOn": {
"type": "string",
"nullable": true
},
"spaceCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.SpaceCategory"
},
"roomFunction": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.RoomFunction"
},
"spaceArea": {
"type": "number",
"format": "double",
"nullable": true
},
"levelPlanHandle": {
"type": "string",
"nullable": true
},
"employeeLocationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rollBackInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.RollBackInfo"
},
"levelPlanId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"planFile": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.PlanFile"
},
"cadPlanCoordinates": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"spaceAssignedOnDateTimeFormat": {
"type": "string",
"nullable": true
},
"svgPlanAdded": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.PlanType": {
"type": "object",
"properties": {
"planTypeId": {
"type": "string",
"format": "uuid"
},
"planTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.QualificationModel": {
"type": "object",
"properties": {
"employeeQualificationTitle": {
"type": "string",
"nullable": true
},
"employeeQualificationFileId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"employeeQualificationId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.RoomDetail": {
"type": "object",
"properties": {
"spaceKey": {
"type": "string",
"nullable": true
},
"spaceName": {
"type": "string",
"nullable": true
},
"roomNumber": {
"type": "string",
"nullable": true
},
"spaceId": {
"type": "string",
"format": "uuid"
},
"roomId": {
"type": "integer",
"format": "int32"
},
"spaceArea": {
"type": "number",
"format": "double"
},
"levelPlanHandle": {
"type": "string",
"nullable": true
},
"carpetArea": {
"type": "number",
"format": "double",
"nullable": true
},
"carpetHandle": {
"type": "string",
"nullable": true
},
"levelPlanId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"spaceCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.SpaceCategory"
},
"roomFunction": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.RoomFunction"
},
"organizationUnit": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrganizationUnit"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"cadPlanTextPosition": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"totalWorkspaces": {
"type": "integer",
"format": "int32"
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationData"
},
"roomAssignmentType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RoomAssignmentTypeResponseModel"
},
"roomStandard": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RoomStandardResponseModel"
},
"roomLayoutTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.RoomLayout"
},
"nullable": true
},
"seatingCapacity": {
"type": "integer",
"format": "int32"
},
"isSuccess": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"isRoomLayoutSupported": {
"type": "string",
"nullable": true
},
"cadPlanTextLeadLinePosition": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"spaceAreaText": {
"type": "string",
"nullable": true
},
"planDescription": {
"type": "string",
"nullable": true
},
"planId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"planModel": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.PlanModel"
},
"planFile": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.PlanFile"
},
"planType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.PlanType"
},
"spaceHandleMidPoint": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"isShared": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
},
"carpetAreaText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.RoomFunction": {
"type": "object",
"properties": {
"roomFunctionId": {
"type": "string",
"format": "uuid"
},
"roomFunctionName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.RoomLayout": {
"type": "object",
"properties": {
"roomLayoutId": {
"type": "string",
"format": "uuid"
},
"roomLayoutName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.Common.SpaceCategory": {
"type": "object",
"properties": {
"spaceCategoryId": {
"type": "string",
"format": "uuid"
},
"spaceCategoryName": {
"type": "string",
"nullable": true
},
"spaceCategoryCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.AssignSupervisorRequestModel": {
"type": "object",
"properties": {
"supervisorId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.BuildingInfo": {
"type": "object",
"properties": {
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"buildingIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.BuildingRequestModel": {
"type": "object",
"properties": {
"buildingInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.BuildingInfo"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.CreateUserRequestModel": {
"type": "object",
"properties": {
"isCreateUser": {
"type": "boolean"
},
"userRoles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.EmployeeAssignRequestModel": {
"type": "object",
"properties": {
"buildingId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"levelId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"roomId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workspaceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"coordinates": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"orgUnitId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetail": {
"type": "object",
"properties": {
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"spaceDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.SpaceDetail"
},
"employeeIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"isCreateUser": {
"type": "boolean"
},
"userRoles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetailsRequestModel": {
"type": "object",
"properties": {
"employeeInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.EmployeeDetail"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.EmployeeProfileImageRequestModel": {
"type": "object",
"properties": {
"fileId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.EmployeeRequestModel": {
"type": "object",
"properties": {
"assigned": {
"type": "boolean"
},
"unassigned": {
"type": "boolean"
},
"levelId": {
"type": "string",
"nullable": true
},
"buildingId": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "string",
"nullable": true
},
"roomId": {
"type": "string",
"nullable": true
},
"datafieldIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"selectedIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"siteIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"buildingIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"levelIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"isEmployeeWithSpaceHandle": {
"type": "boolean"
},
"status": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"isAdvancedSearch": {
"type": "boolean",
"nullable": true
},
"keyword": {
"type": "string",
"nullable": true
},
"sortColumn": {
"type": "string",
"nullable": true
},
"sortColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
},
"filter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.EmployeeRollBackRequestModel": {
"type": "object",
"properties": {
"toMoveHistoryId": {
"type": "string",
"format": "uuid"
},
"comments": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.EmployeeTerminateDateResponseModel": {
"type": "object",
"properties": {
"dateOfTermination": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.GeneralAssetRequestModel": {
"type": "object",
"properties": {
"isAssigned": {
"type": "boolean"
},
"assetClassId": {
"type": "string",
"format": "uuid"
},
"assetTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AssetEntityDataFieldValue"
},
"nullable": true
},
"spaceDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.SpaceDetail"
},
"generalAssetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.GroupedAssetLocationRequestModel": {
"type": "object",
"properties": {
"siteId": {
"type": "string",
"format": "uuid"
},
"buildingId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"floorId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.LevelRequestModel": {
"type": "object",
"properties": {
"levelInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LevelInfo"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.LocationActivateRequestModel": {
"type": "object",
"properties": {
"includeBuildingAndFloor": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.LocationInactivateRequestModel": {
"type": "object",
"properties": {
"confirmInactivate": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.LocationInfo": {
"type": "object",
"properties": {
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"locationIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.LocationRequestModel": {
"type": "object",
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.LocationInfo"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.RelatedAssetRequestModel": {
"type": "object",
"properties": {
"relation": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.RemoveGeneralAssetRequestModel": {
"type": "object",
"properties": {
"confirmDelete": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.SpaceDetail": {
"type": "object",
"properties": {
"buildingId": {
"type": "string",
"nullable": true
},
"levelId": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"nullable": true
},
"roomId": {
"type": "string",
"nullable": true
},
"workSpaceId": {
"type": "string",
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"coordinates": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.SpaceSummaryRequestModel": {
"type": "object",
"properties": {
"spaceIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"numericfieldId": {
"type": "string",
"format": "uuid"
},
"validatedfieldId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.StatusRequestModel": {
"type": "object",
"properties": {
"statusCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.UpdateLocationModel": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"format": "uuid"
},
"coordinates": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.RequestModels.UpdateLocationRequestModel": {
"type": "object",
"properties": {
"updateLocationModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.RequestModels.UpdateLocationModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AmenityInfo": {
"type": "object",
"properties": {
"amenityType": {
"type": "string",
"nullable": true
},
"availableCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetClassDataResponseModel": {
"type": "object",
"properties": {
"assetClassId": {
"type": "string",
"format": "uuid"
},
"assetClassName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetClassDetailResponseModel": {
"type": "object",
"properties": {
"assetClassName": {
"type": "string",
"nullable": true
},
"assetClassId": {
"type": "string",
"format": "uuid"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetNode"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel"
},
"nullable": true
},
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel": {
"type": "object",
"properties": {
"assetClassId": {
"type": "string",
"format": "uuid"
},
"assetClassName": {
"type": "string",
"nullable": true
},
"assetType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel"
},
"assetClassSymbol": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.Symbol"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetNode": {
"type": "object",
"properties": {
"assetIdentifier": {
"type": "string",
"nullable": true
},
"assetId": {
"type": "string",
"format": "uuid"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetNode"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetNodesResponseModel": {
"type": "object",
"properties": {
"assetType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeDetailsResponseModel"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetResponseModel": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"assetIdentifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetSummaryDetailsResponseModel": {
"type": "object",
"properties": {
"completedPlannedWork": {
"type": "integer",
"format": "int32"
},
"completedUnPlannedWork": {
"type": "integer",
"format": "int32"
},
"planned": {
"type": "integer",
"format": "int32"
},
"unplanned": {
"type": "integer",
"format": "int32"
},
"downTime": {
"type": "string",
"nullable": true
},
"meanTimeBetweenFailure": {
"type": "string",
"nullable": true
},
"meanTimeRepair": {
"type": "string",
"nullable": true
},
"foreCastedRepairDate": {
"type": "string",
"nullable": true
},
"plannedCost": {
"type": "string",
"nullable": true
},
"unPlannedCost": {
"type": "string",
"nullable": true
},
"replacementCost": {
"type": "string",
"nullable": true
},
"maintenanceCost": {
"type": "string",
"nullable": true
},
"linearAsset": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LinearAssetDetails"
},
"linearSystemName": {
"type": "string",
"nullable": true
},
"linearSystemTypeName": {
"type": "string",
"nullable": true
},
"activeWork": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeDetailsResponseModel": {
"type": "object",
"properties": {
"assetTypeName": {
"type": "string",
"nullable": true
},
"assetTypeId": {
"type": "string",
"format": "uuid"
},
"assetClasses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassDetailResponseModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel": {
"type": "object",
"properties": {
"assetTypeId": {
"type": "string",
"format": "uuid"
},
"assetTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel": {
"type": "object",
"properties": {
"buildingId": {
"type": "string",
"format": "uuid"
},
"buildingName": {
"type": "string",
"nullable": true
},
"levels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingLevelResponseModel"
},
"nullable": true
},
"buildingPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"buildingType": {
"type": "string",
"nullable": true
},
"cadPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"spaceDetail": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailInfo"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"latLong": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.BuildingData": {
"type": "object",
"properties": {
"buildingName": {
"type": "string",
"nullable": true
},
"buildingId": {
"type": "string",
"format": "uuid"
},
"buildingDescription": {
"type": "string",
"nullable": true
},
"buildingType": {
"type": "string",
"nullable": true
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.LocationInfo"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"cadPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"noOfFloors": {
"type": "integer",
"format": "int32"
},
"noOfActiveFloors": {
"type": "integer",
"format": "int32"
},
"ownershipType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.OwnershipType"
},
"buildingArea": {
"type": "number",
"format": "double",
"nullable": true
},
"buildingAreaText": {
"type": "string",
"nullable": true
},
"isCadPlanExist": {
"type": "boolean"
},
"latLong": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"format": "uuid"
},
"locationName": {
"type": "string",
"nullable": true
},
"buildingName": {
"type": "string",
"nullable": true
},
"buildingId": {
"type": "string",
"format": "uuid"
},
"noOfPlansAvailable": {
"type": "integer",
"format": "int32"
},
"cadPlansCount": {
"type": "integer",
"format": "int32"
},
"noOfFloors": {
"type": "integer",
"format": "int32"
},
"floorsCount": {
"type": "integer",
"format": "int32"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"buildingDescription": {
"type": "string",
"nullable": true
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"files": {
"type": "integer",
"format": "int32"
},
"isUtilityAsset": {
"type": "boolean"
},
"buildingType": {
"type": "string",
"nullable": true
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.LocationInfo"
},
"leaseCount": {
"type": "integer",
"format": "int32"
},
"projectCount": {
"type": "integer",
"format": "int32"
},
"furnitureCount": {
"type": "integer",
"format": "int32"
},
"equipmentCount": {
"type": "integer",
"format": "int32"
},
"pmWorkOrderCount": {
"type": "integer",
"format": "int32"
},
"reactiveWorkOrderCount": {
"type": "integer",
"format": "int32"
},
"orderCount": {
"type": "integer",
"format": "int32"
},
"stockCount": {
"type": "integer",
"format": "int32"
},
"ownershipType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.DataContext.DataModels.OwnershipType"
},
"buildingArea": {
"type": "number",
"format": "double",
"nullable": true
},
"buildingAreaText": {
"type": "string",
"nullable": true
},
"employeesCount": {
"type": "integer",
"format": "int32"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"isCadPlanExist": {
"type": "boolean"
},
"latLong": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
},
"locationData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.BuildingLevelResponseModel": {
"type": "object",
"properties": {
"levelId": {
"type": "string",
"format": "uuid"
},
"levelName": {
"type": "string",
"nullable": true
},
"cadPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"spaceDetail": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailInfo"
},
"orgUnitInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.OrgUnitInfo"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.BuildingListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingData"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel": {
"type": "object",
"properties": {
"planId": {
"type": "string",
"format": "uuid"
},
"planType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.PlanType"
},
"planDescription": {
"type": "string",
"nullable": true
},
"planModel": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.PlanModel"
},
"planFile": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.PlanFile"
},
"revisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.PlanFile"
},
"nullable": true
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"assetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"svgPlanAdded": {
"type": "boolean"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"hasAnyRevisions": {
"type": "boolean"
},
"isPlanRemoved": {
"type": "boolean"
},
"responseMessage": {
"type": "string",
"nullable": true
},
"isCadPlanExist": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.CommonProperty": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"values": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeBasicDetailListResponseModel": {
"type": "object",
"properties": {
"employees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeBasicDetailsResponseModel"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeBasicDetailsResponseModel": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"format": "uuid"
},
"employeeName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"employeeCode": {
"type": "string",
"nullable": true
},
"employeeRole": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
},
"isTechnician": {
"type": "boolean"
},
"isCreateUserAccount": {
"type": "boolean"
},
"isSupervisor": {
"type": "boolean"
},
"employeeUserId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeCategoryResponseModel": {
"type": "object",
"properties": {
"employeeCategoryId": {
"type": "string",
"format": "uuid"
},
"employeeCategoryName": {
"type": "string",
"nullable": true
},
"employeeCategoryDescription": {
"type": "string",
"nullable": true
},
"isLaborCategory": {
"type": "boolean"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel": {
"type": "object",
"properties": {
"employeeDesignation": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeDesignationModel"
},
"organizationUnit": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrganizationUnit"
},
"phoneNumber1": {
"type": "string",
"nullable": true
},
"phoneNumber2": {
"type": "string",
"nullable": true
},
"gender": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.Gender"
},
"dateOfBirth": {
"type": "string",
"nullable": true
},
"supervisor": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeInfo"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"employeeGrade": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeGradeModel"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"employmentType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmploymentTypeResponseModel"
},
"employeeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeCategoryResponseModel"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"employeeWorkMode": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeWorkModeResponseModel"
},
"serviceEndDate": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeServiceEndDate"
},
"employeeId": {
"type": "string",
"format": "uuid"
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeMiddleName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"employeeCode": {
"type": "string",
"nullable": true
},
"employeeRole": {
"type": "string",
"nullable": true
},
"profilePic": {
"type": "string",
"nullable": true
},
"dateOfTermination": {
"type": "string",
"nullable": true
},
"dateOfJoining": {
"type": "string",
"nullable": true
},
"employeeUserId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isTechnician": {
"type": "boolean"
},
"isCreateUserAccount": {
"type": "boolean"
},
"userRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.UserRoleDetails"
},
"nullable": true
},
"isSupervisor": {
"type": "boolean"
},
"isRollBackAllowed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel": {
"type": "object",
"properties": {
"employeeQualificationId": {
"type": "string",
"format": "uuid"
},
"employeeQualificationFileName": {
"type": "string",
"nullable": true
},
"preview": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FilePreview"
},
"qualification": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel+QualificationResponseModel"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"employeeQualificationTitle": {
"type": "string",
"nullable": true
},
"employeeQualificationFileId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel+QualificationResponseModel": {
"type": "object",
"properties": {
"qualificationId": {
"type": "string",
"format": "uuid"
},
"qualificationName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel": {
"type": "object",
"properties": {
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
},
"employees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.EmployeeInfo"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel": {
"type": "object",
"properties": {
"employeeIdentifier": {
"type": "string",
"format": "uuid"
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeSummaryResponseModel": {
"type": "object",
"properties": {
"totals": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.Total"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskDetail": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"format": "uuid"
},
"taskNumber": {
"type": "string",
"nullable": true
},
"taskDescription": {
"type": "string",
"nullable": true
},
"expectedDateOfCompletion": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"taskItemType": {
"type": "string",
"nullable": true
},
"taskItemTypeName": {
"type": "string",
"nullable": true
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.PriorityRequestModel"
},
"lastAction": {
"type": "string",
"nullable": true
},
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorkTypeResponseModel"
},
"workTypeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"title": {
"type": "string",
"nullable": true
},
"currentActionPoint": {
"type": "string",
"nullable": true
},
"actionBy": {
"type": "string",
"nullable": true
},
"lastActionBy": {
"type": "string",
"nullable": true
},
"requestedBy": {
"type": "string",
"nullable": true
},
"requestedOn": {
"type": "string",
"nullable": true
},
"estimatedHours": {
"type": "number",
"format": "double"
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"nullable": true
},
"hasAnyOnGoingLabours": {
"type": "boolean",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"buildingName": {
"type": "string",
"nullable": true
},
"planProcedure": {
"type": "string",
"nullable": true
},
"planName": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"actionById": {
"type": "array",
"items": {},
"nullable": true
},
"totalLabourHours": {
"type": "string",
"nullable": true
},
"totalCost": {
"type": "string",
"nullable": true
},
"loggedInUserExistInForActionby": {
"type": "boolean"
},
"serviceRequestInitialInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskDetail"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.Gender": {
"type": "object",
"properties": {
"genderId": {
"type": "string",
"format": "uuid"
},
"genderName": {
"type": "string",
"nullable": true
},
"genderCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.GenderDetail": {
"type": "object",
"properties": {
"genderId": {
"type": "string",
"format": "uuid"
},
"genderName": {
"type": "string",
"nullable": true
},
"employees": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicResponseModel"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicResponseModel": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"assetIdentifier": {
"type": "string",
"nullable": true
},
"assetType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel"
},
"assetClass": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassDataResponseModel"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"isAssigned": {
"type": "boolean"
},
"assetImage": {
"type": "string",
"nullable": true
},
"isGrouped": {
"type": "boolean"
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"barcode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"assetIdentifier": {
"type": "string",
"nullable": true
},
"assetDescription": {
"type": "string",
"nullable": true
},
"assetType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel"
},
"assetClass": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"expiryDate": {
"type": "string",
"nullable": true
},
"manufactureDate": {
"type": "string",
"nullable": true
},
"assetImage": {
"type": "string",
"nullable": true
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"yearofInstallation": {
"type": "integer",
"format": "int32",
"nullable": true
},
"replacementYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseCost": {
"type": "number",
"format": "double"
},
"assetSymbol": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.Symbol"
},
"locationDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel"
},
"barcode": {
"type": "string",
"nullable": true
},
"purchaseCostString": {
"type": "string",
"nullable": true
},
"parentAssetType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel"
},
"parentAssetClass": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel"
},
"parentAssetIdentifier": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetResponseModel"
},
"isGrouped": {
"type": "boolean"
},
"lotNumber": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"manufacturer": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.ManufacturerDetail"
},
"model": {
"type": "string",
"nullable": true
},
"installationDate": {
"type": "string",
"nullable": true
},
"expiryDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"replacementCost": {
"type": "number",
"format": "double",
"nullable": true
},
"repairCost": {
"type": "number",
"format": "double",
"nullable": true
},
"remainingUsefulLife": {
"type": "number",
"format": "double",
"nullable": true
},
"estimatedUsefulLife": {
"type": "number",
"format": "double",
"nullable": true
},
"facilityConditionIndex": {
"type": "number",
"format": "double",
"nullable": true
},
"assetWarrantyMinDate": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel": {
"type": "object",
"properties": {
"groupedAssetLocationId": {
"type": "string",
"format": "uuid"
},
"assetId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"asset": {
"type": "string",
"nullable": true
},
"assignedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32"
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LevelDetail": {
"type": "object",
"properties": {
"building": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingData"
},
"cadPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"levelId": {
"type": "string",
"format": "uuid"
},
"levelName": {
"type": "string",
"nullable": true
},
"levelDescription": {
"type": "string",
"nullable": true
},
"levelNumber": {
"type": "integer",
"format": "int32"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"levelArea": {
"type": "number",
"format": "double",
"nullable": true
},
"levelAreaText": {
"type": "string",
"nullable": true
},
"isCadPlanExist": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel": {
"type": "object",
"properties": {
"locationName": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid"
},
"buildingName": {
"type": "string",
"nullable": true
},
"buildingId": {
"type": "string",
"format": "uuid"
},
"noOfPlansAvailable": {
"type": "integer",
"format": "int32"
},
"files": {
"type": "integer",
"format": "int32"
},
"building": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingData"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"levelId": {
"type": "string",
"format": "uuid"
},
"levelName": {
"type": "string",
"nullable": true
},
"levelDescription": {
"type": "string",
"nullable": true
},
"levelNumber": {
"type": "integer",
"format": "int32"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"levelArea": {
"type": "number",
"format": "double",
"nullable": true
},
"levelAreaText": {
"type": "string",
"nullable": true
},
"isCadPlanExist": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LevelListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LevelDetail"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel": {
"type": "object",
"properties": {
"levelId": {
"type": "string",
"format": "uuid"
},
"levelName": {
"type": "string",
"nullable": true
},
"levelDescription": {
"type": "string",
"nullable": true
},
"levelNumber": {
"type": "integer",
"format": "int32"
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.LocationInfo"
},
"building": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingData"
},
"levelArea": {
"type": "number",
"format": "double",
"nullable": true
},
"levelAreaText": {
"type": "string",
"nullable": true
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LinearAssetDetails": {
"type": "object",
"properties": {
"assetName": {
"type": "string",
"nullable": true
},
"assetId": {
"type": "string",
"format": "uuid"
},
"assetType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"file": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel": {
"type": "object",
"properties": {
"locationName": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid"
},
"address": {
"type": "string",
"nullable": true
},
"noOfBuildings": {
"type": "integer",
"format": "int32"
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.Location"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"locationDescription": {
"type": "string",
"nullable": true
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"files": {
"type": "integer",
"format": "int32"
},
"timeZone": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.TimeZone"
},
"leaseCount": {
"type": "integer",
"format": "int32"
},
"projectCount": {
"type": "integer",
"format": "int32"
},
"furnitureCount": {
"type": "integer",
"format": "int32"
},
"equipmentCount": {
"type": "integer",
"format": "int32"
},
"pmWorkOrderCount": {
"type": "integer",
"format": "int32"
},
"reactiveWorkOrderCount": {
"type": "integer",
"format": "int32"
},
"orderCount": {
"type": "integer",
"format": "int32"
},
"stockCount": {
"type": "integer",
"format": "int32"
},
"cadPlansCount": {
"type": "integer",
"format": "int32"
},
"floorsCount": {
"type": "integer",
"format": "int32"
},
"employeesCount": {
"type": "integer",
"format": "int32"
},
"locationArea": {
"type": "number",
"format": "double",
"nullable": true
},
"locationAreaText": {
"type": "string",
"nullable": true
},
"isCadPlanExist": {
"type": "boolean"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
},
"locationData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LocationListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LocationProperty"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LocationProperty": {
"type": "object",
"properties": {
"locationName": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid"
},
"locationDescription": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"cadPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"timeZone": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.TimeZone"
},
"noOfBuildings": {
"type": "integer",
"format": "int32"
},
"noOfActiveBuildings": {
"type": "integer",
"format": "int32"
},
"isCadPlanExist": {
"type": "boolean"
},
"locationArea": {
"type": "number",
"format": "double",
"nullable": true
},
"locationAreaText": {
"type": "string",
"nullable": true
},
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"format": "uuid"
},
"locationName": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"buildings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel"
},
"nullable": true
},
"buildingPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"location": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"cadPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"spaceDetail": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailInfo"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.ManufacturerDetail": {
"type": "object",
"properties": {
"manufcturerId": {
"type": "string",
"format": "uuid"
},
"manufacturerName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.OrgUnitEmployees": {
"type": "object",
"properties": {
"levelName": {
"type": "string",
"nullable": true
},
"unitIdentifier": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"employees": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.OrgUnitInfo": {
"type": "object",
"properties": {
"orgUnitId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"orgUnitName": {
"type": "string",
"nullable": true
},
"employeeCount": {
"type": "integer",
"format": "int32"
},
"levelId": {
"type": "integer",
"format": "int32"
},
"orgUnitCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.PlanFile": {
"type": "object",
"properties": {
"fileId": {
"type": "string",
"format": "uuid"
},
"fileName": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "string",
"nullable": true
},
"currentRevisionNumber": {
"type": "integer",
"format": "int32"
},
"createdOn": {
"type": "string",
"nullable": true
},
"fileSizeInBytes": {
"type": "integer",
"format": "int64"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
},
"isLatest": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.PlanModel": {
"type": "object",
"properties": {
"planModelId": {
"type": "string",
"format": "uuid"
},
"planModelName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetResponseModel"
},
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetResponseModel": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"assetIdentifier": {
"type": "string",
"nullable": true
},
"assetType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel"
},
"assetClass": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel": {
"type": "object",
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"assetIdentifier": {
"type": "string",
"nullable": true
},
"apiResponse": {
"$ref": "#/components/schemas/zlink.libraries.utilities.ResponseModels.APIResponse"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.RoomAssignmentTypeResponseModel": {
"type": "object",
"properties": {
"roomAssignmentTypeId": {
"type": "string",
"format": "uuid"
},
"roomAssignmentTypeName": {
"type": "string",
"nullable": true
},
"roomAssignmentTypeCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.RoomLayoutResponseModel": {
"type": "object",
"properties": {
"roomLayoutId": {
"type": "string",
"format": "uuid"
},
"roomLayoutName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.RoomStandardResponseModel": {
"type": "object",
"properties": {
"roomStandardId": {
"type": "string",
"format": "uuid"
},
"roomStandardName": {
"type": "string",
"nullable": true
},
"roomStandardDescription": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.RoomWorkSpacesResponseModel": {
"type": "object",
"properties": {
"workSpaceId": {
"type": "string",
"format": "uuid"
},
"identifier": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"seatAssignmentType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SeatingTypeResponseModel"
},
"room": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.RoomDetail"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SeatingTypeResponseModel": {
"type": "object",
"properties": {
"seatAssignmentTypeId": {
"type": "string",
"format": "uuid"
},
"seatAssignmentTypeName": {
"type": "string",
"nullable": true
},
"seatAssignmentTypeCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomResponseModel"
},
"nullable": true
},
"hasEmployee": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomResponseModel": {
"type": "object",
"properties": {
"roomId": {
"type": "string",
"format": "uuid"
},
"organizationUnit1Id": {
"type": "string",
"format": "uuid"
},
"organizationUnit2Id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"organizationUnit3Id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"organizationUnit4Id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"organizationUnit5Id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"organizationUnit1Value": {
"type": "string",
"nullable": true
},
"organizationUnit2Value": {
"type": "string",
"nullable": true
},
"organizationUnit3Value": {
"type": "string",
"nullable": true
},
"organizationUnit4Value": {
"type": "string",
"nullable": true
},
"organizationUnit5Value": {
"type": "string",
"nullable": true
},
"percentage": {
"type": "number",
"format": "double"
},
"percentageText": {
"type": "string",
"nullable": true
},
"area": {
"type": "number",
"format": "double"
},
"areaText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"responseDescription": {
"type": "string",
"nullable": true
},
"amenityId": {
"type": "string",
"format": "uuid"
},
"amenityName": {
"type": "string",
"nullable": true
},
"amenityDescription": {
"type": "string",
"nullable": true
},
"hourlyRate": {
"type": "number",
"format": "double",
"nullable": true
},
"keyword": {
"type": "string",
"nullable": true
},
"sortColumn": {
"type": "string",
"nullable": true
},
"sortColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
},
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"selectedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"datafieldIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"filter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SpaceAssignmentInfoResponseModel": {
"type": "object",
"properties": {
"roomId": {
"type": "string",
"format": "uuid"
},
"roomAssignmentType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RoomAssignmentTypeResponseModel"
},
"roomStandard": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RoomStandardResponseModel"
},
"seatingCapacity": {
"type": "integer",
"format": "int32"
},
"approvalRequiredforReservation": {
"type": "boolean"
},
"isRoomLayoutSupported": {
"type": "boolean"
},
"roomLayoutTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.RoomLayout"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailInfo": {
"type": "object",
"properties": {
"numberOfDepartments": {
"type": "integer",
"format": "int32"
},
"totalArea": {
"type": "number",
"format": "double"
},
"usableArea": {
"type": "number",
"format": "double"
},
"occupied": {
"type": "integer",
"format": "int32"
},
"vacant": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.RoomDetail"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailsFilterResponseModel": {
"type": "object",
"properties": {
"spaceName": {
"type": "string",
"nullable": true
},
"spaceId": {
"type": "string",
"format": "uuid"
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"seatingCapacity": {
"type": "integer",
"format": "int32"
},
"roomLayoutTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RoomLayoutResponseModel"
},
"nullable": true
},
"amenities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AmenityInfo"
},
"nullable": true
},
"spaceType": {
"type": "string",
"nullable": true
},
"spaceImages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"spaceImageURL": {
"type": "string",
"nullable": true
},
"seatNumber": {
"type": "string",
"nullable": true
},
"roomWorkSpaceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"organizationUnit": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.OrganizationUnit"
},
"isFavorite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.SpaceSummaryResponseModel": {
"type": "object",
"properties": {
"barData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"pieData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"employeeOccupied": {
"type": "integer",
"format": "int32"
},
"spacesSelected": {
"type": "integer",
"format": "int32"
},
"totalArea": {
"type": "number",
"format": "double"
},
"commonProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CommonProperty"
},
"nullable": true
},
"assetCount": {
"type": "integer",
"format": "int32"
},
"furnitureCount": {
"type": "integer",
"format": "int32"
},
"grossArea": {
"type": "string",
"nullable": true
},
"totalCarpetArea": {
"type": "number",
"format": "double",
"nullable": true
},
"carpetArea": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.Total": {
"type": "object",
"properties": {
"all": {
"type": "integer",
"format": "int32"
},
"assigned": {
"type": "integer",
"format": "int32"
},
"unAssigned": {
"type": "integer",
"format": "int32"
},
"byGender": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GenderDetail"
},
"nullable": true
},
"byOrganizationalUnit": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.OrgUnitEmployees"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel": {
"type": "object",
"properties": {
"workSpaceId": {
"type": "string",
"format": "uuid"
},
"identifier": {
"type": "string",
"nullable": true
},
"cadPlanLocation": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"seatAssignmentType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SeatingTypeResponseModel"
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.Common.CostModel": {
"type": "object",
"properties": {
"costString": {
"type": "string",
"nullable": true
},
"cost": {
"type": "number",
"format": "double"
},
"currency": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.RequestModel.ActiveTaskLaborRequestModel": {
"type": "object",
"properties": {
"nextActionPointId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"nextActionPointUserIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.RequestModel.LabourHourDetail": {
"type": "object",
"properties": {
"technicianId": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string",
"nullable": true
},
"action": {
"type": "string",
"nullable": true
},
"endTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"hoursWorked": {
"type": "number",
"format": "double",
"nullable": true
},
"cost": {
"type": "number",
"format": "double",
"nullable": true
},
"taskLaborId": {
"type": "string",
"format": "uuid"
},
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.RequestModel.TaskCompleteCloseActionRequestModel": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"format": "uuid"
},
"labourHourDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.LabourHourDetail"
},
"nullable": true
},
"closeRelatedProject": {
"type": "boolean"
},
"actionPointUserIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.RequestModel.TaskLaborRequestModel": {
"type": "object",
"properties": {
"laborHourDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.LabourHourDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.RequestModel.TaskReAssignRequestModel": {
"type": "object",
"properties": {
"workflowActionPointId": {
"type": "string",
"format": "uuid"
},
"actionPointUserIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"labourHourDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.RequestModel.LabourHourDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.RequestModel.TaskRequestModel": {
"type": "object",
"properties": {
"groupBy": {
"type": "string",
"nullable": true
},
"assetCategory": {
"type": "string",
"nullable": true
},
"groupItemId": {
"type": "string",
"nullable": true
},
"groupItemCode": {
"type": "string",
"nullable": true
},
"includeImages": {
"type": "boolean"
},
"isClosedOrDiscardTasks": {
"type": "boolean",
"nullable": true
},
"projectId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"projectTaskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"taskItemType": {
"type": "string",
"nullable": true
},
"selectedCalendarDate": {
"type": "string",
"nullable": true
},
"planId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isMaintenancePlan": {
"type": "boolean"
},
"buildingId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"assetId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isCompletedPlannedWork": {
"type": "boolean",
"nullable": true
},
"isCompletedUnPlannedWork": {
"type": "boolean",
"nullable": true
},
"fieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.EntityDataFieldValue"
},
"nullable": true
},
"isAdvancedSearch": {
"type": "boolean",
"nullable": true
},
"selectedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"taskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"datafieldIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"keyword": {
"type": "string",
"nullable": true
},
"sortColumn": {
"type": "string",
"nullable": true
},
"sortColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
},
"filter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.HoldReasonResponseModel": {
"type": "object",
"properties": {
"holdReasonId": {
"type": "string",
"format": "uuid"
},
"holdReason": {
"type": "string",
"nullable": true
},
"holdTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"holdReasonName": {
"type": "string",
"nullable": true
},
"holdEndTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.PayCodeDetails": {
"type": "object",
"properties": {
"payCodeId": {
"type": "string",
"format": "uuid"
},
"payCodeName": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.RequesterInfo": {
"type": "object",
"properties": {
"requesterName": {
"type": "string",
"nullable": true
},
"requesterEmail": {
"type": "string",
"nullable": true
},
"requesterContactNumber": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.ServiceRequestInfo": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"requestNumber": {
"type": "string",
"nullable": true
},
"requestType": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"requestDescription": {
"type": "string",
"nullable": true
},
"requestSource": {
"type": "string",
"nullable": true
},
"requestedOn": {
"type": "string",
"nullable": true
},
"requesterDetails": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.RequesterInfo"
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"task": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskInfo"
},
"workOrder": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.WorkOrder"
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.PriorityRequestModel"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"nullable": true
},
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorkTypeResponseModel"
},
"workTypeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.ServiceRequestListResponseModel": {
"type": "object",
"properties": {
"generalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.GeneralProperty"
},
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.ServiceRequestInfo"
},
"nullable": true
},
"listProperties": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.ListProperty"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.TaskCount": {
"type": "object",
"properties": {
"serviceRequestsCount": {
"type": "integer",
"format": "int32"
},
"pmCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.TaskDashboardResponseModel": {
"type": "object",
"properties": {
"priority": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.PriorityResponseModel"
},
"nullable": true
},
"count": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskCount"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel": {
"type": "object",
"properties": {
"scheduledDate": {
"type": "string",
"nullable": true
},
"generatedOn": {
"type": "string",
"nullable": true
},
"dateOfRequest": {
"type": "string",
"nullable": true
},
"requestedBy": {
"type": "string",
"nullable": true
},
"holdReason": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.HoldReasonResponseModel"
},
"serviceRequestNumber": {
"type": "string",
"nullable": true
},
"serviceRequestDescription": {
"type": "string",
"nullable": true
},
"taskData": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskInfo"
},
"title": {
"type": "string",
"nullable": true
},
"hasAnyLabours": {
"type": "boolean"
},
"hasAnyCosts": {
"type": "boolean"
},
"hasAnyProjects": {
"type": "boolean"
},
"hasAnyAttachmnets": {
"type": "boolean"
},
"hasAnyAssets": {
"type": "boolean"
},
"hasAnyRelatedTasks": {
"type": "boolean"
},
"geoJsonData": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"previousSelectedActionPointUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.ActionPointUserResponseModel"
},
"nullable": true
},
"hasParts": {
"type": "boolean"
},
"taskUpdatedStatus": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
},
"hasGeoJSONData": {
"type": "boolean"
},
"uniqueId": {
"type": "string",
"format": "uuid"
},
"taskNumber": {
"type": "string",
"nullable": true
},
"taskDescription": {
"type": "string",
"nullable": true
},
"expectedDateOfCompletion": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"taskItemType": {
"type": "string",
"nullable": true
},
"taskItemTypeName": {
"type": "string",
"nullable": true
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.PriorityRequestModel"
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"locationDetail": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"lastAction": {
"type": "string",
"nullable": true
},
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorkTypeResponseModel"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"workTypeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"nullable": true
},
"hasAnyOnGoingLabours": {
"type": "boolean",
"nullable": true
},
"currentActionPoint": {
"type": "string",
"nullable": true
},
"actionBy": {
"type": "string",
"nullable": true
},
"lastActionBy": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"buildingName": {
"type": "string",
"nullable": true
},
"requestedOn": {
"type": "string",
"nullable": true
},
"planProcedure": {
"type": "string",
"nullable": true
},
"planName": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"actionById": {
"type": "array",
"items": {},
"nullable": true
},
"totalLabourHours": {
"type": "string",
"nullable": true
},
"totalCost": {
"type": "string",
"nullable": true
},
"labourHours": {
"type": "number",
"format": "double"
},
"cost": {
"type": "number",
"format": "double"
},
"loggedInUserExistInForActionby": {
"type": "boolean"
},
"serviceRequestInitialInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"taskId": {
"type": "integer",
"format": "int32"
},
"buildingInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"expectedCompletionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"workOrderDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedHours": {
"type": "number",
"format": "double"
},
"linearAssetIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"buildingId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"levelId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"projectId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"projectTaskId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taskWorkType": {
"type": "string",
"nullable": true
},
"currentActionPointId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"actionPointPermissionData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.WorkflowPermissionResponseModel"
},
"nullable": true
},
"taskDueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.TaskDetailResponseModel": {
"type": "object",
"properties": {
"groupName": {
"type": "string",
"nullable": true
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskInfo"
},
"nullable": true
},
"groupType": {
"type": "string",
"nullable": true
},
"groupObject": {
"nullable": true
},
"groupCode": {
"type": "string",
"nullable": true
},
"taskCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.TaskInfo": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"format": "uuid"
},
"taskNumber": {
"type": "string",
"nullable": true
},
"taskDescription": {
"type": "string",
"nullable": true
},
"expectedDateOfCompletion": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"taskItemType": {
"type": "string",
"nullable": true
},
"taskItemTypeName": {
"type": "string",
"nullable": true
},
"priority": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.RequestModels.PriorityRequestModel"
},
"locationInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"locationDetail": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.LocationDetail"
},
"lastAction": {
"type": "string",
"nullable": true
},
"workType": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorkTypeResponseModel"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"workTypeCategory": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.WorktypeCategoryResponseModel"
},
"title": {
"type": "string",
"nullable": true
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"nullable": true
},
"hasAnyOnGoingLabours": {
"type": "boolean",
"nullable": true
},
"currentActionPoint": {
"type": "string",
"nullable": true
},
"actionBy": {
"type": "string",
"nullable": true
},
"lastActionBy": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"buildingName": {
"type": "string",
"nullable": true
},
"requestedBy": {
"type": "string",
"nullable": true
},
"requestedOn": {
"type": "string",
"nullable": true
},
"planProcedure": {
"type": "string",
"nullable": true
},
"planName": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"actionById": {
"type": "array",
"items": {},
"nullable": true
},
"totalLabourHours": {
"type": "string",
"nullable": true
},
"totalCost": {
"type": "string",
"nullable": true
},
"labourHours": {
"type": "number",
"format": "double"
},
"cost": {
"type": "number",
"format": "double"
},
"loggedInUserExistInForActionby": {
"type": "boolean"
},
"serviceRequestInitialInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.AdditionalInfo"
},
"nullable": true
},
"taskId": {
"type": "integer",
"format": "int32"
},
"buildingInfo": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FeatureCollection"
},
"expectedCompletionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"workOrderDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedHours": {
"type": "number",
"format": "double"
},
"linearAssetIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"locationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"buildingId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"levelId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"projectId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"projectTaskId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taskWorkType": {
"type": "string",
"nullable": true
},
"currentActionPointId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"actionPointPermissionData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.WorkflowPermissionResponseModel"
},
"nullable": true
},
"taskDueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.TaskLabourDetail": {
"type": "object",
"properties": {
"hoursWorked": {
"type": "number",
"format": "double",
"nullable": true
},
"labourName": {
"type": "string",
"nullable": true
},
"taskLaborId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workingType": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"nullable": true
},
"endTime": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"nullable": true
},
"timeSpent": {
"type": "string",
"nullable": true
},
"technician": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TechnicianDetails"
},
"trade": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.TradeDetails"
},
"payCode": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.PayCodeDetails"
},
"cost": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.Common.CostModel"
},
"file": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.FileDetail"
},
"timeTaken": {
"type": "string",
"format": "date-span",
"nullable": true
},
"isActionPointUserInNextAction": {
"type": "boolean",
"nullable": true
},
"addedBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.TaskResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskDetailResponseModel"
},
"nullable": true
},
"tasksCount": {
"type": "integer",
"format": "int32"
},
"recentTasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskInfo"
},
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.TechnicianDetails": {
"type": "object",
"properties": {
"technicianName": {
"type": "string",
"nullable": true
},
"technicianId": {
"type": "string",
"format": "uuid"
},
"technicianEmailId": {
"type": "string",
"nullable": true
},
"trades": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.TradeDetails"
},
"nullable": true
},
"technicianProfilePic": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.WorkOrder": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"format": "uuid"
},
"workOrderName": {
"type": "string",
"nullable": true
},
"workOrderNumber": {
"type": "string",
"nullable": true
},
"workOrderDate": {
"type": "string",
"format": "date-time"
},
"addedOn": {
"type": "string",
"format": "date-time"
},
"addedByUser": {
"type": "string",
"format": "uuid",
"nullable": true
},
"statusId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"zLink.Business.zOne.TasksManagement.ResponseModel.WorkflowPermissionResponseModel": {
"type": "object",
"properties": {
"permissionId": {
"type": "string",
"format": "uuid"
},
"permissionName": {
"type": "string",
"nullable": true
},
"permissionCode": {
"type": "string",
"nullable": true
},
"accessControl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.business.platformbuilder.zOne.Models.ActivityLogRequestModel": {
"type": "object",
"properties": {
"clouds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"features": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"userIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"menus": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"zlink.business.platformbuilder.zOne.Models.ContactResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.business.platformbuilder.zOne.Models.MyDetailsResponseModel": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"nameDisplayFormat": {
"type": "string",
"nullable": true
},
"timeZone": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.TimeZones"
},
"profilePic": {
"type": "string",
"nullable": true
},
"rowsPerPage": {
"type": "integer",
"format": "int32"
},
"phoneNumber2": {
"type": "string",
"nullable": true
},
"hasPlatformControlAccess": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zlink.business.platformbuilder.zOne.Models.TimeZones": {
"type": "object",
"properties": {
"timeZoneId": {
"type": "integer",
"format": "int32"
},
"timeZoneName": {
"type": "string",
"nullable": true
},
"utcOffSet": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"supportsDaylightSavingTime": {
"type": "boolean"
},
"daylightName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel": {
"type": "object",
"properties": {
"userRoleModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.UserRoleModel"
},
"nullable": true
},
"activationDateString": {
"type": "string",
"nullable": true
},
"expiryDateString": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"phoneNumber1": {
"type": "string",
"nullable": true
},
"phoneNumber2": {
"type": "string",
"nullable": true
},
"accountAccess": {
"$ref": "#/components/schemas/Models.AccountAccesDetails"
},
"status": {
"$ref": "#/components/schemas/Models.StatusResponseInfo"
},
"email": {
"type": "string",
"nullable": true
},
"timezone": {
"$ref": "#/components/schemas/Models.TimeZoneDetails"
},
"profilePic": {
"type": "string",
"nullable": true
},
"userIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"isSSOUser": {
"type": "boolean"
},
"userRoles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"statusCode": {
"type": "string",
"nullable": true
},
"team": {
"$ref": "#/components/schemas/Models.OrgUnit"
},
"loginName": {
"type": "string",
"nullable": true
},
"statusDetails": {
"$ref": "#/components/schemas/Models.StatusDetails"
},
"isEmployee": {
"type": "boolean"
},
"employeeCode": {
"type": "string",
"nullable": true
},
"isTwoFactorEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.AccountDetailsResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Models.AccountDetailsResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.LogDetailResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Models.LogDetailResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserAccountDetails, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Models.UserAccountDetails"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[Models.UserListResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Models.UserListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.IEnumerable`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.FileTypeResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.FileTypeResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.OrgUnit, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.OrgUnit"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[Models.TimeZoneResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Models.TimeZoneResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.ApplicationUserPreferenceResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.ApplicationUserPreferenceResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.FileGroupResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.FileGroupResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Base.ResponseModels.TaskHistoryResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.TaskHistoryResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.RoomDetail"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetNodesResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetNodesResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetTypeResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingLevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingLevelResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.CadPlanResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.RoomWorkSpacesResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RoomWorkSpacesResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskLabourDetail, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskLabourDetail"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zlink.business.platformbuilder.zOne.Models.ContactResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.ContactResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[System.Collections.Generic.List`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.Common.StatusInfo, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.Common.StatusInfo"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.AssetsDetailResponseModel[], zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.AssetsDetailResponseModel"
},
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.FileDetailResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.LocationCollectionResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.LogChangeSetResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OperationalDocumentListResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.OperationalDocumentListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel, zLink.Business.zOne.Base, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.CreateServiceRequestResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.MyWorkPendingTaskListResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.MyWorkPendingTaskListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.PmWorkOrdersTileResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.PmWorkOrdersTileResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ReactiveWorkorderTileResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.ReactiveWorkorderTileResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ReturnedRequestListResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.ReturnedRequestListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.ServiceRequestDetailResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.ServiceRequestDetailResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.WorkHubCreateServiceRequestResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.WorkHubCreateServiceRequestResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryResponseModel, zLink.Business.zOne.Maintenance, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Maintenance.ResponseModels.WorkHubTaskHistoryResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.Common.RoomDetail, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.Common.RoomDetail"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetClassResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.AssetSummaryDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.AssetSummaryDetailsResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingAssetResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingDetailsResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.BuildingListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.BuildingListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeBasicDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeBasicDetailListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeDetailsResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeQualificationResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeRollBackResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeSummaryResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeSummaryResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EmployeeViewResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.EquipmentTaskListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetBasicListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GeneralAssetResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.GroupedAssetLocationResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LevelDetailsResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LevelListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LevelResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LocationDetailsResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LocationListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RelatedAssetDetailResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.RemoveGeneralAssetResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SharedRoomListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceAmenityResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceAssignmentInfoResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceAssignmentInfoResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailsFilterResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailsFilterResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.SpaceSummaryResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.SpaceSummaryResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel, zLink.Business.zOne.Portfolio, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.Portfolio.ResponseModels.WorkSpaceResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.ServiceRequestListResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.ServiceRequestListResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDashboardResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskDashboardResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskDataResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zLink.Business.zOne.TasksManagement.ResponseModel.TaskResponseModel, zLink.Business.zOne.TasksManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zLink.Business.zOne.TasksManagement.ResponseModel.TaskResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.MyDetailsResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.MyDetailsResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"zlink.libraries.utilities.ResponseModels.APIResult`1[[zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel, zlink.business.platformbuilder.zOne, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/zlink.business.platformbuilder.zOne.Models.UserRolesResponseModel"
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"messageCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"errorType": {
"type": "string",
"nullable": true
},
"traceid": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"x-tagGroups": [
{
"name": "Account",
"tags": [
"Account Management",
"User Management",
"User Preferences"
]
},
{
"name": "Configuration",
"tags": [
"Reference Data",
"Organizational Contacts"
]
},
{
"name": "Logs",
"tags": [
"Audit Trails"
]
},
{
"name": "Portfolio",
"tags": [
"Equipment",
"Employees",
"Facility",
"Furniture",
"Portfolio"
]
},
{
"name": "Files",
"tags": [
"File Management",
"Filegroups"
]
},
{
"name": "Work Order",
"tags": [
"Tasks",
"Service Requests",
"PM Work Orders"
]
}
]
}