PBDB Data Service：Special parameters（特殊参数）

描述

本文将介绍一组特殊参数，它们几乎可以在此数据服务的任何请求中使用。

参数

1：下列参数在大部分请求中可用

• limit：限制返回的记录数量。该参数的值可以是任一正整数，0，或all。

• offset：从offset处开始返回结果。该值可以是任一正整数或0。您可以同时设置limit和offset来将一个很大的结果分成多个小的数据块返回。

• rowcount：如果此参数为TRUE，返回结果中将包含一个展示符合查询条件的记录个数以及实际返回的记录个数的表头。要了解它的编码格式，请参阅输出格式与术语表。

• datainfo：如果此参数为TRUE，响应将包括包含各种信息的标题行：
  · 数据提供商的名称
  · 数据来源的名称
  · 许可证
  · 接收数据的日期时间
  · 用于生成此结果集的URL和参数
  对于将保存到磁盘以供以后分析和使用的响应特别有用。这些额外的信息将用于记录在结果集中包含数据的标准以及生成结果的时间，并且将包含一个URL，稍后可以使用该URL重新运行查询。要了解它的编码格式，请参阅输出格式与术语表。

• private：如果该参数包含在请求中，并且如果您使用发出请求的相同浏览器登录到PBDB，那么结果将包括与请求参数匹配的任何私人(禁止)数据，并且您有权限访问。这不仅包括您自己的数据，还包括授权您编辑其集合的数据。

• strict：如果指定了此参数，则任何警告都将导致错误响应。您可以使用这个参数来确保所有参数都有合适的值。否则，默认情况下，结果将使用好的值生成而忽略坏的值。

• textresult：如果指定了，那么结果将被赋予’text/plain’的内容类型。在大多数浏览器中，这将导致结果直接显示，而不是保存到磁盘。该参数不需要任何值。

• markrefs：如果指定了，那么格式化的引用将被标记为<b>和<i>标记。该参数不需要值。

• extids：如果指定了，那么记录ID将以记录类型前缀而不是数字的形式输出。默认情况下，这是针对JSON格式的。

• vocab：选择用于命名响应中的字段的术语表。只有在希望覆盖所选格式的默认术语表时，才需要使用它。可能的值取决于特定的URL路径，包括：
  pbdb：PBDB术语表来自数据库中的基础字段名和值，并增加了一些新字段。在大多数情况下，使用此术语表的响应将直接与从PBDB Classic接口下载的响应相对应。此术语表是Text格式响应的默认术语。
  com：Compact词汇表是一组3个字符的字段名，旨在将响应消息的大小最小化。这是JSON格式响应的默认值。一些字段值被类似地简化，而其他字段值则被完整地传递。有关详细信息，请参见各个响应字段的文档。
  bibjson：BibJSON术语表使用为BibTeX定义的字段名和值格式，这是BibJSON使用的术语表。

• save：指定将此请求的输出保存到的本地文件的名称。这种情况是否发生以及如何发生取决于你使用的是哪种网络浏览器。如果你想在浏览器中显示结果，你可以指定save=no。如果你不带任何值地包含这个参数，将会提供一个默认的文件名。

2：以下参数只与文本格式(.csv， .tsv， .txt)相关

• noheader：如果指定了，则给出字段名称的标题行将被省略。该参数不需要任何值。它等价于"header=no"。
• lb：指定用于终止每行的字符序列。该值可以是’cr’或’crlf’，默认为后者。
• header：此参数仅与文本格式响应相关。如果它有一个真值，那么数据记录前面有一个标题行，给出字段名。如果它有一个假值，这一行将被省略。如果省略此参数，有关默认行为的各种输出格式请参阅。