GET /api/v202405/hierarchy/space/{placeId}

Returns the space descendant information, useful for expanding a space node

HierarchicalSpaceV202405 Permissions: BuildingsAndOrganizations (View)

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
placeId Place Id integer (int32) Required

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

HierarchicalSpaces
Property Description Type
dataPointChildren List of data point children HierarchicalDataPoint[]
HierarchicalDataPoint properties
Property Description Type
active Indicates whether the data point is Active boolean
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
dataPointCode The data point code string
dataPointId The data point identifier integer (int32)
dataPointInfo The data point info string
isCalculatedDataPoint Indicates whether the data point is a calculated data point boolean
isDataRolledUp Indicates if the primary value channel on the datapoint has a summarization method of SUM boolean
serialNumber The data point’s current serial number string
hasActiveChildren If this place has any active space children or active data point children boolean
hasActiveDataPointChildren If this place has any active data point children boolean
hasChildren If this place has any children, either datapoins or places boolean
hasDataPointChildren If this place has any data point children boolean
hasSpaceChildren If this place has any space children boolean
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
parentId The place’s parent integer (int32)
placeCode The place’s Code string
placeId The place’s primary ID integer (int32)
placeInfo The place’s Info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
spaceChildren List of place children HierarchicalSpaces2[]
HierarchicalSpaces2 properties
Property Description Type
dataPointChildren HierarchicalDataPoint[]
HierarchicalDataPoint properties
Property Description Type
active Indicates whether the data point is Active boolean
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
dataPointCode The data point code string
dataPointId The data point identifier integer (int32)
dataPointInfo The data point info string
isCalculatedDataPoint Indicates whether the data point is a calculated data point boolean
isDataRolledUp Indicates if the primary value channel on the datapoint has a summarization method of SUM boolean
serialNumber The data point’s current serial number string
hasActiveChildren boolean
hasActiveDataPointChildren boolean
hasChildren boolean
hasDataPointChildren boolean
hasSpaceChildren boolean
isDataRolledUp boolean
parentId integer (int32)
placeCode string
placeId integer (int32)
placeInfo string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
spaceChildren HierarchicalSpaces[]
HierarchicalSpaces properties
Property Description Type
dataPointChildren List of data point children HierarchicalDataPoint[]
HierarchicalDataPoint properties
Property Description Type
active Indicates whether the data point is Active boolean
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
dataPointCode The data point code string
dataPointId The data point identifier integer (int32)
dataPointInfo The data point info string
isCalculatedDataPoint Indicates whether the data point is a calculated data point boolean
isDataRolledUp Indicates if the primary value channel on the datapoint has a summarization method of SUM boolean
serialNumber The data point’s current serial number string
hasActiveChildren If this place has any active space children or active data point children boolean
hasActiveDataPointChildren If this place has any active data point children boolean
hasChildren If this place has any children, either datapoins or places boolean
hasDataPointChildren If this place has any data point children boolean
hasSpaceChildren If this place has any space children boolean
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
parentId The place’s parent integer (int32)
placeCode The place’s Code string
placeId The place’s primary ID integer (int32)
placeInfo The place’s Info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
spaceChildren List of place children HierarchicalSpaces2[]
HierarchicalSpaces2 properties
Property Description Type
dataPointChildren HierarchicalDataPoint[]
HierarchicalDataPoint properties
Property Description Type
active Indicates whether the data point is Active boolean
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
dataPointCode The data point code string
dataPointId The data point identifier integer (int32)
dataPointInfo The data point info string
isCalculatedDataPoint Indicates whether the data point is a calculated data point boolean
isDataRolledUp Indicates if the primary value channel on the datapoint has a summarization method of SUM boolean
serialNumber The data point’s current serial number string
hasActiveChildren boolean
hasActiveDataPointChildren boolean
hasChildren boolean
hasDataPointChildren boolean
hasSpaceChildren boolean
isDataRolledUp boolean
parentId integer (int32)
placeCode string
placeId integer (int32)
placeInfo string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
spaceChildren HierarchicalSpaces[]
HierarchicalSpaces properties
Property Description Type
dataPointChildren List of data point children HierarchicalDataPoint[]
HierarchicalDataPoint properties
Property Description Type
active Indicates whether the data point is Active boolean
commodity CommodityChild
dataPointCode The data point code string
dataPointId The data point identifier integer (int32)
dataPointInfo The data point info string
isCalculatedDataPoint Indicates whether the data point is a calculated data point boolean
isDataRolledUp Indicates if the primary value channel on the datapoint has a summarization method of SUM boolean
serialNumber The data point’s current serial number string
hasActiveChildren If this place has any active space children or active data point children boolean
hasActiveDataPointChildren If this place has any active data point children boolean
hasChildren If this place has any children, either datapoins or places boolean
hasDataPointChildren If this place has any data point children boolean
hasSpaceChildren If this place has any space children boolean
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
parentId The place’s parent integer (int32)
placeCode The place’s Code string
placeId The place’s primary ID integer (int32)
placeInfo The place’s Info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
spaceChildren List of place children HierarchicalSpaces2[]
HierarchicalSpaces2 properties
Property Description Type
dataPointChildren HierarchicalDataPoint[]
hasActiveChildren boolean
hasActiveDataPointChildren boolean
hasChildren boolean
hasDataPointChildren boolean
hasSpaceChildren boolean
isDataRolledUp boolean
parentId integer (int32)
placeCode string
placeId integer (int32)
placeInfo string
placeType PlaceTypeResponse
spaceChildren HierarchicalSpaces[]
Example Response application/json 
{  "dataPointChildren": [
    {    "active": false,    "commodity": {      "commodityCode": "string",      "commodityIcon": {},      "commodityId": 1,      "commodityInfo": "string"
    },    "dataPointCode": "string",    "dataPointId": 1,    "dataPointInfo": "string",    "isCalculatedDataPoint": false,    "isDataRolledUp": false,    "serialNumber": "string"
  }
  ],  "hasActiveChildren": false,  "hasActiveDataPointChildren": false,  "hasChildren": false,  "hasDataPointChildren": false,  "hasSpaceChildren": false,  "isDataRolledUp": false,  "parentId": 1,  "placeCode": "string",  "placeId": 1,  "placeInfo": "string",  "placeType": {    "icon": {      "code": "string",      "color": "string"
    },    "isSystemPlaceType": false,    "placeEntityType": {      "placeEntityTypeId": 1,      "placeEntityTypeInfo": "string"
    },    "placeTypeCode": "string",    "placeTypeId": 1,    "placeTypeInfo": "string",    "structure": false
  },  "spaceChildren": [
    {    "dataPointChildren": [
      {      "active": false,      "commodity": {},      "dataPointCode": "string",      "dataPointId": 1,      "dataPointInfo": "string",      "isCalculatedDataPoint": false,      "isDataRolledUp": false,      "serialNumber": "string"
    }
    ],    "hasActiveChildren": false,    "hasActiveDataPointChildren": false,    "hasChildren": false,    "hasDataPointChildren": false,    "hasSpaceChildren": false,    "isDataRolledUp": false,    "parentId": 1,    "placeCode": "string",    "placeId": 1,    "placeInfo": "string",    "placeType": {      "icon": {},      "isSystemPlaceType": false,      "placeEntityType": {},      "placeTypeCode": "string",      "placeTypeId": 1,      "placeTypeInfo": "string",      "structure": false
    },    "spaceChildren": [
      {      "dataPointChildren": [],      "hasActiveChildren": false,      "hasActiveDataPointChildren": false,      "hasChildren": false,      "hasDataPointChildren": false,      "hasSpaceChildren": false,      "isDataRolledUp": false,      "parentId": 1,      "placeCode": "string",      "placeId": 1,      "placeInfo": "string",      "placeType": {},      "spaceChildren": []
    }
    ]
  }
  ]
}