获取项目区域列表

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

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

Body 参数application/json

page

object (PageInfo)

可选

page

integer <int64>

页码

可选

size

integer <int64>

每页大小

可选

orders

array[object (OrderBy) {2}]

排序

可选

projectID

string

项目id

可选

areaIDs

array[string]

项目区域ids

可选

parentAreaID

string

可选

isRetTopLevel

boolean

可选

如果该参数为true则返回除了root节点的有权限的最高层的区域列表

tenantCode

string

可选

deviceCount

object (CompareInt64)

可选

cmpTYpe

string

必需

"=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询

value

string

必需

groupCount

object (CompareInt64)

可选

示例

{
  "page": {
    "page": 0,
    "size": 0,
    "orders": [
      {
        "field": "string",
        "sort": 0
      }
    ]
  },
  "projectID": "string",
  "areaIDs": [
    "string"
  ],
  "parentAreaID": "string",
  "isRetTopLevel": true,
  "tenantCode": "string",
  "deviceCount": {
    "cmpTYpe": "string",
    "value": "string"
  },
  "groupCount": {
    "cmpTYpe": "string",
    "value": "string"
  }
}

示例代码

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/index' \
--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 (AreaInfoIndexResp)

可选

total

integer <int64>

拥有的总数

可选

list

array[object (AreaInfo) {21}]

项目区域列表

必需

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "total": 0,
    "list": [
      {
        "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": [
          {}
        ]
      }
    ]
  }
}