获取项目列表 - 联犀-core

请求参数

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}]

排序

可选

projectName

string

过滤项目名称

可选

isGetAll

boolean

可选

是否获取所有(管理员获取所有)

projectIDs

array[integer <int64>]

过滤项目id列表

可选

withTopAreas

boolean

可选

同时返回顶层的区域列表

withAdminUser

boolean

可选

同时获取管理员核心信息

tenantCode

string

可选

指定租户(只有default租户下的管理员才有效)

示例

{
  "page": {
    "page": 0,
    "size": 0,
    "orders": [
      {
        "field": "string",
        "sort": 0
      }
    ]
  },
  "projectName": "string",
  "isGetAll": true,
  "projectIDs": [
    0
  ],
  "withTopAreas": true,
  "withAdminUser": true,
  "tenantCode": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/system/project/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 (ProjectInfoIndexResp)

可选

total

integer <int64>

拥有的总数

可选

list

array[object (ProjectInfo) {18}]

项目列表

必需

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "total": 0,
    "list": [
      {
        "createdTime": "string",
        "projectID": "string",
        "projectName": "string",
        "adminUserID": "string",
        "position": {
          "longitude": 180,
          "latitude": 90
        },
        "address": "string",
        "projectImg": "string",
        "isSysCreated": 0,
        "isUpdateProjectImg": true,
        "desc": "string",
        "tags": {},
        "areaCount": 0,
        "userCount": 0,
        "deviceCount": 0,
        "ppsm": 0,
        "area": 0,
        "adminUser": {
          "userID": "string",
          "userName": "string",
          "email": "string",
          "phone": "string",
          "lastIP": "string",
          "regIP": "string",
          "nickName": "string",
          "headImg": "string",
          "tags": {},
          "createdTime": "string"
        },
        "areas": [
          {
            "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": [
              {}
            ]
          }
        ]
      }
    ]
  }
}