API 文档

获取角色列表信息 (POST)

更新时间:

请求接口 ​

POST /api/role/_query/

TIP

访问权限：需要登录超级设备管理平台获取token，并校验token。

请求参数 ​

名称位置类型必选说明
X-Access-Tokenheaderstring是平台 token
bodybodyobject否-
» currentbodyinteger否当前页面
» pageSizebodyinteger否每页数量
» pageIndexbodyinteger否页码，从 0 开始
» termsbody[object]否查询条件
»» termsbody[object]否查询条件
»»» termTypebodystring否查询条件：like（模糊查询）、eq（等于）
»»» columnbodystring否条件属性名称
»»» valuebodystring否条件属性值，将要搜索的内容放入%%之间
» sortsbody[object]否排序，可以根据多个字段排序
»» namebodystring否排序字段名称，可选值：id（标识）、name（名称）、description（说明）、createTime（创建时间）
»» orderbodystring否排序方式：asc（升序）、desc（降序）

响应参数 ​

以200 Response为例，响应参数如下：

名称类型必选约束说明
» messagestringtruenone返回信息
» resultobjecttruenone返回结果
»» pageIndexintegertruenone页码，从0开始
»» pageSizeintegertruenone每页最多显示的个数
»» totalintegertruenone总数
»» data[object]truenone数据内容
»»» idstringtruenoneID
»»» namestringtruenone名称
»»» descriptionstringfalsenone说明
»»» stateobjectfalsenone状态
»»»» textstringtruenone状态名称
»»»» valuestringtruenone状态标识
»»» creatorIdstringfalsenone创建者ID
»»» createTimeintegerfalsenone创建时间
» statusintegertruenone响应状态码
» timestampintegertruenone时间戳

响应状态码 ​

状态码状态码含义说明
200OK成功
401Unauthorized登录状态已过期，token不能为空
500Internal Server Error服务器内部异常

Body示例 ​

json
{
  "current":1,
  "pageSize":10,
  "pageIndex":0,
  "terms":[
    {
      "terms":[
        {
          "termType":"like",
          "column":"id",
          "value":"%00%"
        }
      ]
    }
  ],
  "sorts":[
    {
      "name":"createTime",
      "order":"desc"
    },
    {
      "name":"id",
      "order":"desc"
    }
  ]
}
{
  "current":1,
  "pageSize":10,
  "pageIndex":0,
  "terms":[
    {
      "terms":[
        {
          "termType":"like",
          "column":"id",
          "value":"%00%"
        }
      ]
    }
  ],
  "sorts":[
    {
      "name":"createTime",
      "order":"desc"
    },
    {
      "name":"id",
      "order":"desc"
    }
  ]
}

返回示例 ​

以200 Response为例：

json
{
  "message": "success",
  "result": {
    "pageIndex": 0,
    "pageSize": 10,
    "total": 60,
    "data": [
      {
        "id": "1697129821737353216",
        "name": "角色列表查看",
        "description": "",
        "state": {
          "text": "正常",
          "value": "enabled"
        },
        "creatorId": "1199596756811550720",
        "createTime": 1693462255297
      }
    ]
  },
  "status": 200,
  "timestamp": 1693453829820
}
{
  "message": "success",
  "result": {
    "pageIndex": 0,
    "pageSize": 10,
    "total": 60,
    "data": [
      {
        "id": "1697129821737353216",
        "name": "角色列表查看",
        "description": "",
        "state": {
          "text": "正常",
          "value": "enabled"
        },
        "creatorId": "1199596756811550720",
        "createTime": 1693462255297
      }
    ]
  },
  "status": 200,
  "timestamp": 1693453829820
}