Skip to content

List spaces

Request

Returns a filtered and/or paginated list of spaces within the current account context.

Behavior:

  • Applies filtering criteria from the request body
  • Supports pagination using the start query parameter
  • Retrieves spaces associated with the account
  • Returns summarized space detail results
  • Logs the action as a spaces list view event
Query
startstring
Body
siteIdsArray of strings or null, (uuid)
buildingIdsArray of strings or null, (uuid)
levelIdsArray of strings or null, (uuid)
roomIdstring or null
assetClassIdstring or null
assetTypeIdstring or null
assignedboolean
unassignedboolean
datafieldIdsArray of strings or null
selectedIdsArray of strings or null
statusArray of strings or null
isEquipmentWithSpaceHandleboolean
includeFurnitureboolean or null
levelNamestring or null
levelPositioninteger, (int32)
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
isAdvancedSearchboolean or null
isLinkAssetboolean
assetClassIdsArray of strings or null, (uuid)
assetTypeIdsArray of strings or null, (uuid)
keywordstring or null
sortColumnstring or null
sortColumnIdstring or null, (uuid)
sortOrderstring or null
filterstring or null
curl -i -X POST \
  'https://demozone.zlinkfm.com/RND/api/v1/facility/spaces?start=string' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "siteIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "buildingIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "levelIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "roomId": "string",
    "assetClassId": "string",
    "assetTypeId": "string",
    "assigned": true,
    "unassigned": true,
    "datafieldIds": [
      "string"
    ],
    "selectedIds": [
      "string"
    ],
    "status": [
      "string"
    ],
    "isEquipmentWithSpaceHandle": true,
    "includeFurniture": true,
    "levelName": "string",
    "levelPosition": 0,
    "fieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "isAdvancedSearch": true,
    "isLinkAsset": true,
    "assetClassIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "assetTypeIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "keyword": "string",
    "sortColumn": "string",
    "sortColumnId": "0f49f070-9ddb-4e23-bac3-3a9c7797ab4e",
    "sortOrder": "string",
    "filter": "string"
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.SpaceDetailListResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger, (int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
{
  "data": {
    "generalProperties": [
      {
        "name": "string",
        "alias": "string",
        "dataType": "string",
        "propertyType": "string",
        "isKeyData": true,
        "visibility": true,
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "uiProperties": {
          "fullWidth": true,
          "columnWidth": "string",
          "columnSpan": 0
        }
      }
    ],
    "data": [
      {
        "spaceKey": "string",
        "spaceName": "string",
        "roomNumber": "string",
        "spaceId": "a330a273-e64a-4183-aedb-f3152797a9a5",
        "roomId": 0,
        "spaceArea": 0.1,
        "levelPlanHandle": "string",
        "carpetArea": 0.1,
        "carpetHandle": "string",
        "levelPlanId": "0f5a21ff-233b-4dbc-8296-4521bcd60dc1",
        "spaceCategory": {
          "spaceCategoryId": "809d6029-69b4-43c2-a738-11abe5eaf804",
          "spaceCategoryName": "string",
          "spaceCategoryCode": "string"
        },
        "roomFunction": {
          "roomFunctionId": "21215e30-d522-4a6e-b350-1cf0e9b3df3c",
          "roomFunctionName": "string"
        },
        "organizationUnit": {
          "orgUnitLevel1": {
            "levelName": "string",
            "unitIdentifier": "fef1588a-8d1a-434b-be83-95ca43e0251a",
            "unitName": "string"
          },
          "orgUnitLevel2": {
            "levelName": "string",
            "unitIdentifier": "fef1588a-8d1a-434b-be83-95ca43e0251a",
            "unitName": "string"
          },
          "orgUnitLevel3": {
            "levelName": "string",
            "unitIdentifier": "fef1588a-8d1a-434b-be83-95ca43e0251a",
            "unitName": "string"
          },
          "orgUnitLevel4": {
            "levelName": "string",
            "unitIdentifier": "fef1588a-8d1a-434b-be83-95ca43e0251a",
            "unitName": "string"
          },
          "orgUnitLevel5": {
            "levelName": "string",
            "unitIdentifier": "fef1588a-8d1a-434b-be83-95ca43e0251a",
            "unitName": "string"
          },
          "orgUnits": {
            "primaryUnits": "string",
            "secondaryUnits": "string"
          }
        },
        "additionalInfo": [
          {
            "dataField": "string",
            "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
            "dataIds": [
              "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "dataFieldValue": null,
            "dataFieldName": "string",
            "dataValueFormated": "string"
          }
        ],
        "cadPlanTextPosition": [
          0.1
        ],
        "totalWorkspaces": 0,
        "locationInfo": {
          "location": "string",
          "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
          "building": "string",
          "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
          "level": "string",
          "levelId": "a70368c7-b12e-43a9-9830-ab2485710b95",
          "status": {
            "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
            "statusCode": "string",
            "statusName": "string",
            "statusColor": "string"
          },
          "assetLevelId": 0,
          "featureCollection": {
            "type": "string",
            "features": [
              {
                "properties": {},
                "geometry": {}
              }
            ]
          }
        },
        "roomAssignmentType": {
          "roomAssignmentTypeId": "ca8eee7b-83d7-4f35-aff7-8320590088ad",
          "roomAssignmentTypeName": "string",
          "roomAssignmentTypeCode": "string"
        },
        "roomStandard": {
          "roomStandardId": "c1b23e35-8eed-4e09-9536-56a8efc18925",
          "roomStandardName": "string",
          "roomStandardDescription": "string",
          "responseDescription": "string"
        },
        "roomLayoutTypes": [
          {
            "roomLayoutId": "7e4827a9-03fc-4f16-8d4a-db8174d48aca",
            "roomLayoutName": "string"
          }
        ],
        "seatingCapacity": 0,
        "isSuccess": true,
        "errorMessage": "string",
        "isRoomLayoutSupported": "string",
        "cadPlanTextLeadLinePosition": [
          0.1
        ],
        "spaceAreaText": "string",
        "planDescription": "string",
        "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
        "planModel": {
          "planModelId": "9eed1a98-11cb-4f43-8459-1812e5594dc9",
          "planModelName": "string"
        },
        "planFile": {
          "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
          "fileName": "string",
          "fileSize": "string",
          "currentRevisionNumber": 0,
          "createdOn": "string",
          "fileSizeInBytes": 0,
          "createdDate": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "isLatest": true
        },
        "planType": {
          "planTypeId": "0516887d-9268-43c8-b82e-1501d9714a9a",
          "planTypeName": "string"
        },
        "spaceHandleMidPoint": [
          0.1
        ],
        "isShared": "string",
        "responseDescription": "string",
        "carpetAreaText": "string"
      }
    ],
    "listProperties": {
      "totalCount": 0,
      "currentStart": 0,
      "currentLength": 0,
      "pageCount": 0
    }
  },
  "message": "string",
  "isError": true,
  "messageCode": 0,
  "status": "string",
  "errorType": "string",
  "traceid": "string",
  "responseDescription": "string"
}