获取项目区域详情 - iThings(归档)

请求参数

Header 参数

iThings-token

string

可选

默认值:

iThings-project-id

string

可选

默认值:

1786838173980422144

iThings-app-code

string

可选

默认值:

iThings-user-role

string

可选

默认值:

1

Accept-Language

string

可选

默认值:

en

iThings-tenant-code

string

可选

Body 参数application/json

areaID

string

区域id

必需

withChildren

boolean | null

是否返回子节点

可选

projectID

string

可选

示例

{
  "areaID": "1764800519347433472"
}

示例代码

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-token: {{iThings-token}}' \
--header 'iThings-project-id: 1786838173980422144' \
--header 'iThings-app-code: {{iThings-app-code}}' \
--header 'iThings-user-role: 1' \
--header 'Accept-Language: en' \
--header 'iThings-tenant-code;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "areaID": "1764800519347433472"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

areaID

string

必需

项目区域id(雪花id)

parentAreaID

string

必需

上级项目区域id(雪花id)

projectID

string

必需

所属项目id(雪花id)

areaName

string

项目区域名称

必需

<= 100 字符

position

object

可选

项目区域定位(默认百度坐标系BD09)

desc

string

项目区域备注

可选

<= 100 字符

areaIDPath

array[string] | null

区域id路径

可选

areaNamePath

array[string] | null

区域名字路径

可选

lowerLevelCount

integer

下级的数量统计

可选

useBy

string

用途

可选

commonSpace:公共区域 other: 非公共区域

childrenAreaIDs

array[integer] | null

所有子区域的id列表

可选

createdTime

string <date-time>

可选

默认值:

current_timestamp()

deviceCount

integer

区域及子区域的设备数量统计

可选

isLeaf

integer

是否是叶子节点

可选

areaImg

string

区域图片

可选

isUpdateAreaImg

boolean

是否更新区域图片

可选

children

array[object (项目区域信息) {17}] | null

可选

示例

{
  "code": 0,
  "msg": "string",
  "data": {
    "areaID": "string",
    "parentAreaID": "string",
    "projectID": "string",
    "areaName": "string",
    "position": {},
    "desc": "string",
    "areaIDPath": [
      "string"
    ],
    "areaNamePath": [
      "string"
    ],
    "lowerLevelCount": 0,
    "useBy": "string",
    "childrenAreaIDs": [
      0
    ],
    "createdTime": "current_timestamp()",
    "deviceCount": 0,
    "isLeaf": 0,
    "areaImg": "string",
    "isUpdateAreaImg": true,
    "children": [
      {
        "areaID": "string",
        "parentAreaID": "string",
        "projectID": "string",
        "areaName": "string",
        "position": {},
        "desc": "string",
        "areaIDPath": [
          "string"
        ],
        "areaNamePath": [
          "string"
        ],
        "lowerLevelCount": 0,
        "useBy": "string",
        "childrenAreaIDs": [
          0
        ],
        "createdTime": "current_timestamp()",
        "deviceCount": 0,
        "isLeaf": 0,
        "areaImg": "string",
        "isUpdateAreaImg": true,
        "children": [
          {}
        ]
      }
    ]
  }
}

🟠400请求有误