业务实体服务指南

上一个下一个

标准查询参数

业务实体服务 REST API 使用标准查询参数筛选、分页和展开结果。

使用问号 (?) 分隔查询参数和其他参数。查询参数是以等号分隔的键-值对。使用与号 (&) 分隔一系列查询参数。

以下 REST 请求 URL 显示了如何使用查询参数：

/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING

请使用以下标准查询参数：

参数	说明
recordsToReturn	指定返回的行数。默认值为 10。
firstRecord	指定结果中的第一行。默认值为 1。后续的调用使用此参数读取更多页。
searchToken	指定随上一个请求一起返回的搜索标志。您可以使用搜索标志提取后续的搜索结果页。例如，以下查询将列出第一页： /Person/123/Phone 以下查询将返回第二页： /Person/123/Phone?searchToken=SVR1.AZAM5&firstRecord=10
returnTotal	如果设置为 true，则返回结果中的记录数。默认值为 false。
depth	指定包含在结果中的子级数。

发送反馈