查询实体记录

查询实体记录。

API 端点

POST BaseURL/EntityService/<Entity>/query

• 根据您使用的云平台，使用关联的基本 URL 。

请求标头

页眉	值
授权	承载 <access_token>
Content-Type	application/json

备注：

将尖括号 <...> 之间的所有值替换为其相应的用例值。

<access_token> 是您在授权外部应用程序时收到的。 它可用 1 小时，然后您需要生成新令牌，或请求刷新令牌。

查询参数

查询参数	数据类型	描述	默认值
ExpansionLevel （可选）	int32	指定要检索的相关记录的深度。 此参数的值可以是 1、2 或 3。	2

请求正文 (必填)

{
  "selectedFields": [
    "string"
  ],
  "filterGroup": {
    "logicalOperator": 0,
    "queryFilters": [
      {
        "fieldName": "string",
        "operator": "string",
        "value": "string"
      }
    ],
    "filterGroups": [
    ]
  },
  "start": 0,
  "limit": 0,
  "sortOptions": [
    {
      "fieldName": "string",
      "isDescending": true
    }
  ]
}

请求正文架构

query 端点请求正文包含以下组件：

selectedFields

这是一个可选组件，类型为 string。 它指定要为查询的每条记录返回的字段列表。 如果留空，或查询列表为空，则返回所有记录字段。 默认值为 null。

筛选器组

这是一个必需组件，可帮助您设置查询的筛选属性。 它结合了以下属性：

• 逻辑运算符- 这是可选的筛选器组属性，类型为int32 。它指定是否所有筛选器和筛选器组都适用于该查询。使用0应用所有筛选器和筛选器组。使用1应用任何筛选器和筛选器组。默认值为0 。

• 查询筛选器- 这是必需的筛选器组属性，可帮助您定义筛选表达式。它具有以下属性：

  查询筛选器属性	数据类型	描述
  fieldName	string	指定要筛选的字段的名称。
  operator	string	指定筛选器运算符。支持以下表达式： contains 、 not contains 、 startswith 、 endswith 、 = 、 != 、 > 、 < 、 >= 、 <= 、 in 、 not in对相应的字段类型使用适当的运算符。
  值	string	指定筛选值。

• 筛选器组- 这是一个可选的筛选器组属性，如果您需要为查询设置另一个筛选选项，则可使用该属性。它包含上面列出的所有filterGroup属性。

启动

这是一个可选组件，类型为int32 。指定在从查询中检索记录之前要跳过的记录数。可以与limit属性一起使用以实施分页。记录按其 ID 升序排列。要修改排序顺序，请使用sortOptions属性。默认值为0 。

limit

这是一个可选组件，类型为int32 。它指定要从实体读取的最大记录数。可以与开始属性一起使用以实施分页。默认值为100 ，最大值为1000 。

sortOptions

这是一个可选组件，可帮助您按字段列表对查询的记录进行排序。 如果留空，则记录按 ID 升序排序。 它结合了以下属性：

• 字段名称- 这是必填的sortOptions属性，类型为string 。它指定用于对记录进行排序的字段名称。名称必须与有效的字段对应，并且区分大小写。
• 是降序- 这是可选的sortOptions属性，类型为boolean 。如果要按降序对记录进行排序，请将其设置为true 。默认值为false 。

响应

200 OK

{
  "TotalRecordCount": 0,
  "Value": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:21:22.771Z",
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Logo": {
        "Name": "string",
        "Path": "string",
        "Size": 0,
        "Type": "string"
      },
      "Name": "string",
      "Nations": 0,
      "OlymipcsVersion": 0,
      "OpeningDate": "2021-03-04",
      "UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "UpdateTime": "2021-03-04T10:21:22.771Z"
    }
  ]
}

响应正文架构

query 端点响应正文包含以下组件：

• 总记录数- 与指定查询筛选器匹配的记录总数。
• “值” - 与指定查询筛选器匹配的实体记录数组，受“限制”属性限制。

401 未经授权

您未通过身份验证，无法访问 Data Fabric/Data Service。确保您的 Assistant 或 Robot 已连接到您帐户中的新式文件夹。

403 Forbidden

您无权访问实体、字段或记录，或者您使用的机器人类型不受支持。请联系管理员以获取必要权限。