API 文档

获取应用列表 (POST)

更新时间:

该接口用于获取已建立的应用列表，支持查询全部列表、按条件查询。

请求接口 ​

POST /api/application/_query/

TIP

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

请求参数 ​

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

响应参数 ​

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

名称类型必选约束说明
» messagestringtruenone返回信息
» resultobjecttruenone返回结果
»» idst ringtruenoneID
»» namestringtruenone用户名
»» providerstringtruenone应用类型
»» descriptionstringtruenone说明
»» integrationModes[object]truenone接入方式
»»» textstringtruenone接入方式名称
»»» valuestringtruenone接入方式标识
»» apiServerobjecttruenone-
»»» secureKeystringtruenone密钥Key
»»» signaturestringtruenone签名
»»» roleIdListarraytruenone角色
»»» orgIdListarraytruenone组织
»» stateobjecttruenone状态
»»» textstringtruenone状态名称
»»» valuestringtruenone状态标识
»» creatorIdstringtruenone创建者ID
»» createTimeintegertruenone创建时间
» statusintegertruenone响应状态码
» timestampintegertruenone时间戳

响应状态码 ​

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

Body示例 ​

  • 查询全部：
json
{
  "current":1,
  "pageSize":19,
  "pageIndex":0,
  "sorts":[
    {
      "name":"createTime",
      "order":"desc"
    }
  ]
}
{
  "current":1,
  "pageSize":19,
  "pageIndex":0,
  "sorts":[
    {
      "name":"createTime",
      "order":"desc"
    }
  ]
}
  • 按条件description查询：
json
{
  "current":1,
  "pageSize":19,
  "pageIndex":0,
  "terms":[
    {
      "terms":[
        {
          "termType":"like",
          "column":"description",
          "value":"%ds%"
        }
      ]
    }
  ],
  "sorts":[
    {
      "name":"createTime",
      "order":"desc"
    }
  ]
}
{
  "current":1,
  "pageSize":19,
  "pageIndex":0,
  "terms":[
    {
      "terms":[
        {
          "termType":"like",
          "column":"description",
          "value":"%ds%"
        }
      ]
    }
  ],
  "sorts":[
    {
      "name":"createTime",
      "order":"desc"
    }
  ]
}

返回示例 ​

json
{
  "message": "success",
  "result": {
    "pageIndex": 0,
    "pageSize": 19,
    "total": 1,
    "data": [
      {
        "id": "ykjCyWAG5MDnTmFY",
        "provider": "internal-standalone",
        "name": "API服务-测试",
        "description": "1",
        "integrationModes": [
          {
            "text": "API服务",
            "value": "apiServer"
          }
        ],
        "apiServer": {
          "secureKey": "BkPZhjK36Zb8M2KRpKdAM2krCDCNNdYZ",
          "signature": "MD5",
          "roleIdList": [
            "01"
          ],
          "orgIdList": [
            "01"
          ]
        },
        "state": {
          "text": "启用",
          "value": "enabled"
        },
        "creatorId": "1199596756811550720",
        "createTime": 1693451400166
      }
    ]
  },
  "status": 200,
  "timestamp": 1693533250622
}
{
  "message": "success",
  "result": {
    "pageIndex": 0,
    "pageSize": 19,
    "total": 1,
    "data": [
      {
        "id": "ykjCyWAG5MDnTmFY",
        "provider": "internal-standalone",
        "name": "API服务-测试",
        "description": "1",
        "integrationModes": [
          {
            "text": "API服务",
            "value": "apiServer"
          }
        ],
        "apiServer": {
          "secureKey": "BkPZhjK36Zb8M2KRpKdAM2krCDCNNdYZ",
          "signature": "MD5",
          "roleIdList": [
            "01"
          ],
          "orgIdList": [
            "01"
          ]
        },
        "state": {
          "text": "启用",
          "value": "enabled"
        },
        "creatorId": "1199596756811550720",
        "createTime": 1693451400166
      }
    ]
  },
  "status": 200,
  "timestamp": 1693533250622
}