Skip to content

Get space summary

Request

Returns aggregated summary details for spaces within the current account context based on the provided request criteria.

Behavior:

  • Applies summary filters from the request body
  • Aggregates space-related metrics and statistics
  • Retrieves summary data scoped to the account
  • Returns structured space summary response
  • Logs the action as a space summary view event
Body
spaceIdsArray of strings or null, (uuid)
numericfieldIdstring, (uuid)
validatedfieldIdstring, (uuid)
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/facility/spaces/summary \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "spaceIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "numericfieldId": "481f8f36-4926-45b5-b9e6-349c158e2751",
    "validatedfieldId": "c56fbf35-6663-4a60-9d71-c383232c1d19"
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.SpaceSummaryResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger, (int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
{
  "data": {
    "barData": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "pieData": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "employeeOccupied": 0,
    "spacesSelected": 0,
    "totalArea": 0.1,
    "commonProperties": [
      {
        "fieldName": "string",
        "values": "string"
      }
    ],
    "assetCount": 0,
    "furnitureCount": 0,
    "grossArea": "string",
    "totalCarpetArea": 0.1,
    "carpetArea": "string"
  },
  "message": "string",
  "isError": true,
  "messageCode": 0,
  "status": "string",
  "errorType": "string",
  "traceid": "string",
  "responseDescription": "string"
}