获取项目区域详情

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

areaID

string

项目区域id

必需

tenantCode

string

可选

projectID

string

可选

项目id 不填选默认项目

withChildren

boolean

可选

示例

{
  "areaID": "string",
  "tenantCode": "string",
  "projectID": "string",
  "withChildren": true
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/system/area/info/read' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (AreaInfo)

可选

createdTime

string

创建时间（只读）

可选

projectID

string

项目id（只读）

可选

areaID

string

可选

项目区域id（只读）

parentAreaID

string

可选

上级项目区域id（只读）

areaName

string

可选

项目区域名称（读写）

position

object (Point)

可选

desc

string

可选

项目区域备注（读写）

tags

object

自定义标签

可选

lowerLevelCount

integer <int64>

可选

下级的数量统计（只读）

deviceCount

integer <int64>

可选

设备数量统计(只读)

groupCount

integer <int64>

可选

分组数量统计(只读)

useBy

string

可选

用途: commonSpace default

isLeaf

integer <int64>

可选

是否是子节点（只读）

isSysCreated

integer <int64>

可选

是否是系统创建的,系统创建的只有管理员可以删除

areaIDPath

string

可选

项目区域ids（只读）

areaNamePath

string

（只读）

可选

areaImg

string

可选

isUpdateAreaImg

boolean

可选

configFile

string

区域配置文件

可选

isUpdateConfigFile

boolean

可选

children

array[object (AreaInfo) {21}]

可选

下级项目区域列表（只读）

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "createdTime": "string",
    "projectID": "string",
    "areaID": "string",
    "parentAreaID": "string",
    "areaName": "string",
    "position": {
      "longitude": 180,
      "latitude": 90
    },
    "desc": "string",
    "tags": {},
    "lowerLevelCount": 0,
    "deviceCount": 0,
    "groupCount": 0,
    "useBy": "string",
    "isLeaf": 0,
    "isSysCreated": 0,
    "areaIDPath": "string",
    "areaNamePath": "string",
    "areaImg": "string",
    "isUpdateAreaImg": true,
    "configFile": "string",
    "isUpdateConfigFile": true,
    "children": [
      {}
    ]
  }
}