请求参数

在线编辑

该文档概述了在调用 API 请求时，针对 API 端点或目标资源需要定义的各种请求参数。

根据 API 端点或目标资源，可能需要在 API 请求调用中定义以下参数：
表单数据
使用以下参数请求 API 客户机在执行后续 API 请求调用时所需的访问令牌：
表 1. 表单数据参数
参数 描述
client_id 分配给 API 客户机的客户机标识。
client_secret 分配给 API 客户机的客户机密钥。
grant_type 设置为 client_credentials。
scope 与此令牌关联的作用域的空格分隔列表。 API 客户机的有效作用域为 openid。
头
Verify 需要在 HTTP 标头中包含以下信息：
表 2. 标头参数
参数 描述
Content Type

在请求头中，此参数指示客户机发送给服务器的数据的类型。 在响应头中，此参数指示返回给客户机的数据的类型。

例如，
-H "Content-type: application/json"
Accept

此参数指示响应中客户机可理解和接受的内容的类型。

例如，
-H "Accept: application/json"
-H "Accept: image/png"
Location POST HTTP 方法头中新创建的对象的 URL。 例如，/<resource-noun>/<resource-id>。
Accept-Language 客户机理解或首选的语言。
查询参数
以下参数是可选的，具体取决于返回的 API 请求结果以及返回方式。
表 3. 查询参数
参数 描述
pagination
如果未传入 pagination 参数，那么会返回所有结果。 限制或计数的最大允许值为 1000。
  • count 是要从数据存储器返回的结果总数。
  • page 是所请求的页面。
  • limit 是要在一个页面中返回的结果总数。
sort

每个属性都必须带 + 或 -（+ 表示递增，- 表示递减）前缀。

必须使用逗号 (,) 分隔多个属性。
search
以下项的有效运算符：
  • 字符串是 = , != 和 contains
  • 布尔值是 = 和 !=
  • 这些数字是 >=、 >、 <=、 <、 =、以及 !=
filter 有效格式为仅包含或仅排除。 必须使用逗号 (,) 分隔多个 filter 参数。
主体

将此参数用于 POST、PUT 和 PATCH 请求。 在此处定义要创建或更新的属性和值。 单击数据类型模型或示例值以查看必须在主体中定义的属性，包括格式和样本值。

参数内容类型为 application/json。 内容以 JSON 文件格式存储。