• 主页
• 一般用法
• 术语搜索
• 本体属性搜索
• 注解器
• 推荐人
• 批次
• 本体分析
• 资源
  • 媒体类型和超媒体链接
    • 类别
    • 等级
    • 集团
    • 实例
    • 映射
    • 公制
    • 注意
    • 答复
    • ObjectProperty（对象属性）
    • 本体论
    • Ontology提交
    • 项目
    • 临时类
    • 临时关系
    • 审查
    • 切片
    • 用户
• 内容类型

API文档

一般用法

此API由一组资源（本体、类等）和相关端点（搜索、注释器、推荐器）组成它们通过链接连接在一起，就像网页一样。我们建议您尝试使用web浏览器浏览API（Chrome和Firefox运行良好，而IE则不行）在开始编写代码之前。有关更多信息，请参阅媒体类型和超媒体链接或查看我们的示例代码，提供Java、Python、Ruby和其他语言版本（请发送电子邮件support@biontology.org如果您想要其他语言的示例）。

通用参数

参数	可能的值	描述
美洲豹	{您的api密钥}	访问任何API调用都需要API密钥。它可以通过三种方式提供： 使用美洲豹查询字符串参数 提供授权标题：授权：apikey token=your_apikey（将“your_apikey”替换为实际密钥） 使用web浏览器浏览API时，如果使用方法1提供API密钥一次，它将存储在cookie中以供后续请求使用。您可以通过在新调用中提供不同的API密钥来覆盖此项。
包括	全部的 {以逗号分隔的属性列表，EX:attr1，attr2}	默认情况下，API将显示给定媒体类型的可用属性子集。可以通过提供include=全部显示所有属性或include=属性1，属性2包含特定列表。API已优化返回默认值，因此重写它会影响请求的性能。 这个include=全部选项对于在浏览器中进行测试非常有用。使用它来识别所需的一组属性，并通过以逗号分隔的方式传递这些属性来仅使用这些属性列表，例如。include=prefLabel，cui. 这个包括Annotator和Recommender终结点当前不支持参数。
格式	杰森 跨域访问 xml格式	API返回JSON作为默认内容类型。可以使用格式查询字符串参数。API还尊重接受标题条目，具有给定的优先级到格式参数。
第页	{表示页码的整数}	对于分页呼叫，这将指示要检索的页码。您可以通过超媒体链接访问下一页和上一页也。
页大小	｛表示返回页面大小的整数｝	对于分页调用，这将指示要检索的页面的大小。
包含视图（_V）	{表示是否包含本体视图的布尔值（默认值为false）}	对于涉及本体的调用，include_views='true'将包含本体视图。
显示_上下文	{true|false}（默认为true）	关闭JSON-LD上下文序列化。这将大大减少一些调用的响应大小，从而加快传输和解析时间。
显示_链接	{true|false}（默认为true）	关闭超媒体链接序列化。这将大大减少一些调用的响应大小，从而加快传输和解析时间。
下载_格式	{csv|rdf}（默认为用户加载的文件格式）	允许您为本体和本体提交下载端点指定本体文件下载的替代格式。CSV仅适用于最近提交的文件。

搜索、注释器、推荐器和资源索引端点

有几个端点可用于查找类、注释和带注释的资源。这些端点严格来说不是RESTful的，但在相关的地方会返回带有链接的对象。

术语搜索

提供了用于搜索术语及其属性的端点

• 执行搜索
• GET（获取） 邮政 /搜索？q={搜索查询}
• 例子：/搜索？q=黑色素瘤
• 参数
  • 本体={本体论id1，本体论id2，本体论id 3}
  • require_exact_match={true|false}//default=false
  • suggest={true|false}//default=false。将执行专门针对类型标题建议的搜索。
  • also_search_views={true|false}//在搜索中包含本体视图。默认值=false
  • require_definitions={true|false}//default=false
  • also_search_properties={true|false}//默认值=false
  • also_search_obsolete={true|false}//default=false（排除过时术语）
  • cui={C0018787，C0225807，C0018787}//允许cui限制查询。默认值=null（无限制）
  • semantic_types={T023，T185，T061}//允许按语义类型（TUI）限制查询。默认值=null（无限制）
  • include={prefLabel，synonym，definition，notation，cui，semanticType}//default=（请参阅Common Parameters部分）
  • page=｛表示页码的整数｝//默认值=1
  • pagesize={表示返回页面大小的整数}//默认值=50

子树搜索

同一端点还允许将搜索限制到给定的子树/分支。子树的根是使用参数“ontology”和“subtree_root_id”的组合定义的。执行子树搜索时，两者都是必需的。

• 执行子树搜索
• 例子：/搜索？q=黑色素瘤&本体=NCIT&subtree_root_id=http%3a%2f%2fncib.nic.nih.gov%2fxml%2foll%2fEVS%2fThesaurus.owl%23C3224
• 参数
  • 本体={ontologyid}
  • subtree_root_id={子树根节点的URI编码类id}

仅限根目录搜索

同一端点允许仅对根类进行搜索。

• 执行仅限roots的搜索
• 例子：/搜索？q=黑色素瘤&本体=NCIT，GO&roots_only=true
• 参数
  • roots_only={true|false}

本体属性搜索

通过标签和ID（URI）搜索本体属性的端点

• 执行搜索
• GET（获取） 邮政 /属性搜索？q={搜索查询}
• 例子：/属性搜索？q=有尺寸
• 参数
  • 本体={ontology_id1，ontology_id2，ontology_id3}
  • require_exact_match={true|false}//将结果限制为属性id、标签或生成的标签（标签，从id自动生成）与查询完全匹配。默认值=false
  • also_search_views={true|false}//在搜索中包含本体视图。默认值=false
  • require_definitions={true|false}//只过滤包含定义的结果。默认值=false
  • include={label，labelGenerated，definition，parents}//default=本例中的所有属性
  • ontology_types={ontology，VALUE_SET_COLLECTION}//默认=返回所有本体类型
  • property_types={object，annotation，datatype}//将结果限制为特定的属性类型（object、annotation、datatype）。默认值=返回所有属性类型
  • page={表示页码的整数}//默认值=1
  • pagesize={表示返回页面大小的整数}//默认值=50

注解器

Annotator端点将检查文本输入并返回相关类。

• 为文本添加批注
• GET（获取） 邮政 /解说员？text=｛输入文本｝
• 例子：/解说员？text=黑色素瘤+是+a+恶性+肿瘤+黑色素细胞+其中+发现+主要+在+皮肤+但+也+在+肠道+和+眼睛+。
• 参数
  • 筛选查询行为（&Q）
    • 本体={本体_id1，本体_id2..，本体_id N}
    • semantic_types={semType1，semType2..，semType N}
    • expand_semantic_types_hierarchy={true|false}//default=false。true表示使用“semantic_types”参数中传递的语义类型及其所有直接子级。false表示仅使用“semantic_types”参数中传递的语义类型。
    • expand_class_hierarchy={true|false}//default=false。仅与“class_hierarchy_max_level”参数结合使用；确定在执行注释时是否包含给定类的祖先。
    • class_hierarchy_max_level={0..N}//default=0。执行注释时要使用的层次结构的深度。
    • expand_mappings={true|false}//default=false。true表示将在注释中使用以下手动映射：UMLS、REST、CUI、OBOXREF。
    • stop_words=｛word1，word2..，wordN｝（不区分大小写）
    • 最小匹配长度={0..N}
    • exclude_numbers={true|false}//default=false
    • whole_word_only={true|false}//default=true
    • exclude_synonyms={true|false}//default=false
    • longest_only=｛true|false｝//默认值=false。true表示只返回给定短语的最长匹配项。
• 默认停止字
  • 默认情况下使用以下停止词：
    • 一、 a，上面，后面，反对，全部，单独，总是，am，数量，an，and，any，are，around，as，at，back，be，before，behind，below，between，both，bottom，by，call，can，co，con，de，detail，do，done，down，due，due，得到，给予，去，有，有，没有，他，她，她的，他，他的，我，即如果，进，进，是，它，最后，少，有限，多，可能，我，米尔，我的，更多，大多数，大多数，必须，我的名字，下一个，九，不，没有，也没有，没有，现在，of，关，经常，开，一次，一次，因为，六，所以，一些，有时，仍然，拿，十，然后，第三，这个，厚的，薄的，三，通过，到，一起，顶部，朝向，朝向，十二，二，联合，在下，直到，向上，在上，我们，非常，通过，是，我们，好的，当，当，谁，整体，会，有，内，外，你，你自己，你自己

推荐人

推荐器端点接收文本或关键字列表，并为它们建议适当的本体。

• 推荐
• GET（获取） 邮政 /推荐人？input={输入文本或关键字}
• 示例：为文本“黑色素瘤是黑色素细胞的恶性肿瘤，主要存在于皮肤，也存在于肠道和眼睛”提出本体论：/推荐人？输入=黑色素瘤%20is%20a%20alignant%20tumor%20of%20melanocells%20其中%20are%20found%20majory%20in%20skin%20and%20also%20in%10in%20肠道%20和%20eye
• 参数
  • input_type={1|2}//默认值=1。1表示输入类型为文本。2表示输入类型是逗号分隔的关键字列表。
  • output_type={1|2}//默认值=1。1意味着输出将是个体本体的排序列表。2表示输出将是一个本体集的排名列表。
  • max_elements_set={2|3|4}//默认值=3。每个集合的最大本体数（仅适用于output_type=2）。
  • wc={范围[0,1]}中的值//默认值=0.55。分配给本体覆盖标准的权重。
  • wa={范围[0,1]}中的值//默认值=0.15。分配给本体验收标准的权重。
  • wd={范围[0,1]}中的值//默认值=0.15。分配给本体细节标准的权重。
  • ws={范围[0,1]}内的值//默认值=0.15。分配给本体专门化标准的权重。
  • ontologies={本体论_id1，本体论_id 2，…，本体论_ id N}//default=（空）（将评估所有BioPortal本体）。
• 其他示例
  • 为提供本体论建议关键字“白细胞、吞噬细胞、运动细胞、代谢细胞、树突状细胞、移液管”：
  /推荐人？输入=白细胞、吞噬细胞、能动细胞、代谢细胞、树突状细胞、吸液管和输入类型=2
  • 为提供本体论建议关键字“白细胞、吞噬细胞、运动细胞、代谢细胞、树突状细胞、移液管”，仅限于本体论UBERON、CL、NCIT和EFO:
  /推荐人？输入=白细胞、吞噬细胞、能动细胞、代谢细胞、树突状细胞、吸液管和输入类型=2&ontologies=UBERON、CL、NCIT、EFO
  • 建议本体集对于关键字“白细胞、吞噬细胞、运动细胞、代谢细胞、树突状细胞、移液管”：
  /推荐人？输入=白细胞、吞噬细胞、能动细胞、代谢细胞、树突状细胞、吸液管&input_type=2&output_type=2
  • 为文本“黑色素瘤是黑色素细胞的恶性肿瘤，主要存在于皮肤，也存在于肠道和眼睛”提出本体论，将评估限制为本体覆盖（其他标准（验收、细节和专业化）的权重将设置为0）：
  /推荐人？输入=黑色素瘤%20is%20a%20癌细胞%20tumor%20of%20黑色素细胞%20其中%20are%20发现%20主要是%20在%20皮肤%20中，但%20也在%20肠道%20和%20眼睛&wa=0&wd=0&ws=0

批处理终结点

为了减少获取资源信息所需的HTTP请求数量，我们正在探索批处理端点的使用将对多个资源使用一个请求/响应周期。目前，只有支持类。

邮政 /批处理

批处理服务在POST请求的BODY中进行输入。输入应为具有以下结构的JSON文档：

{"http://www.w3.org/2002/07/owl#类": {“集合”：[{“类”：“http://example.org/ontology1/class1",“本体”：“http://example.org/ontology1"},{“类”：“http://example.org/ontology2/class1",“本体”：“http://example.org/ontology2"},{“类”：“http://example.org/ontologyN/classN",“本体”：“http://example.org/ontologyN"}]，“display”：“prefLabel，synonym，semanticTypes”}}

例子：

{"http://www.w3.org/2002/07/owl#类": {“集合”：[{“类”：“http://bioontology.org/ontologies/BiomedicalResourceOntology.owl#Ontology开发和管理",“本体”：“http://data.bioontology.org/ontologies/BRO"},{“类”：“http://bioontology.org/ontologies/BiomedicalResourceOntology.owl#Modular_Component",“本体”：“http://data.bioontology.org/ontologies/BRO"},{“类”：“http://bioontology.org/ontologies/BiomedicalResourceOntology.owl#模拟器",“本体”：“http://data.bioontology.org/ontologies/BRO"}]，“display”：“prefLabel，synonym，semanticTypes”}}

本体分析

用于检索Google Analytics提供的本体访问者统计信息的端点。

按月/年列出的本体分析

允许检索特定月份/年份组合的所有本体的分析

• 获取所有分析数据
• GET（获取） /分析
• 例子：/分析
• 获取给定月份/年份的分析数据
• GET（获取） /分析？月={月号}&year={year}
• 例子：/分析？月=4年=2014
• 参数
  • 月份={1-12}
  • 年份={2013-…}

单一本体分析

允许检索单个本体的所有分析数据

• 获取给定本体的分析数据
• GET（获取） /本体/{缩写}/分析
• 例子：/本体论/NCIT/分析

资源终结点

RESTful资源的端点可以在下面找到，特别是在媒体类型列表中。使用提供的超媒体链接，您可以在资源之间导航。每个媒体类型都有一个相应的集合URL（如果可用），它是可以用于操作资源，资源描述（包括可用属性），以及可以在每个资源上找到的超媒体链接列表。

媒体类型和超媒体链接

文档

下面的文档描述了API中可用的媒体类型以及连接它们的超媒体链接。媒体类型描述了可用资源的类型，包括可能与它们一起使用的HTTP动词和每个资源包含的属性。

超媒体链接

此编程接口由HTTP命令组成，这些命令返回自身包含指向其他位置的链接的对象以URL的形式。除了实际返回值之外，返回的对象还包含一组指向相关信息的链接。您可以使用HTTP命令（通常是GET）访问这些链接。因此，可以遍历BioPortal的信息通过从本体列表开始并遍历可用的链接-以编程方式或在浏览器中。下面描述了不同的资源，包括有关它们可用的属性、链接和可用于与它们交互的HTTP动词。

HTTP动词

API使用不同的动词来支持资源处理。这包括创建或删除单独的资源或更具体的搜索或注释。通常，动词将用于与表示给定资源id的URL结合。下面是我们如何解释这些动词：

• GET（获取）用于检索资源或资源集合。
• 邮政用于在服务器确定资源id时创建资源。
• PUT（输出）用于在客户端确定资源的id时创建资源。
• 补丁用于修改现有资源。PATCH请求中的属性将替换现有属性。
• 删除用于删除现有资源。

可用介质类型

1. http://data.biontology.org/metadata/Category
2. http://www.w3.org/2002/07/owl#类
3. http://data.bioontology.org/metadata/Group
4. http://data.bioontology.org/metadata/Instance
5. http://data.bioontology.org/meta数据/映射
6. http://data.bioontology.org/metadata/Metrics
7. http://data.bioontology.org/metadata/Note
8. http://data.bioontology.org/metadata/Reply
9. http://www.w3.org/2002/07/owl#ObjectProperty网站
10. http://data.bioontology.org/metadata/Oontology
11. http://data.bioontology.org/metadata/Ontology提交
12. http://data.biontology.org/metadata/Project网站
13. http://data.bioontology.org/metadata/ProvisionalClass
14. http://data.bioontology.org/metadata/ProvisionalRelation网站
15. http://data.biontology.org/metadata/Review
16. http://data.bioontology.org/metadata/Slice
17. http://data.biontology.org/metadata/用户

http://data.biontology.org/metadata/Category

http://www.w3.org/2002/07/owl#类

http://data.bioontology.org/metadata/Group

http://data.bioontology.org/metadata/Instance

http://data.bioontology.org/metadata/Mapping

http://data.bioontology.org/metadata/Metrics

http://data.bioontology.org/metadata/Note

http://data.bioontology.org/metadata/Reply

http://www.w3.org/2002/07/owl#ObjectProperty网站

http://data.bioontology.org/metadata/本体

http://data.bioontology.org/metadata/Ontology提交

http://data.biontology.org/metadata/Project网站

http://data.bioontology.org/metadata/ProvisionalClass

http://data.bioontology.org/metadata/ProvisionalRelation网站

http://data.biontology.org/metadata/Review

http://data.bioontology.org/metadata/Slice

http://data.biontology.org/metadata/用户

内容类型

API返回JSON作为默认内容类型。可以使用格式具有值的查询字符串参数杰森,跨域访问，或xml格式API还尊重接受标题条目（例如：应用程序/json,应用程序/xml)，优先考虑格式参数。

JSON格式

默认的内容类型是JSON，特别是一个名为JSON-LD格式,或JSON链接数据。您可以像对待普通JSON一样对待此变量。所有JSON解析器都可以正常解析输出。JSON-LD的优点是它支持超媒体链接将在标记为@标识，对应于的id父资源，或在名为链接，其中包含具有相应URL的链接类型哈希。

以下是JSON响应格式的输出示例：

{“管理员”：["http://data.bioontology.org/user/nevada（美国内华达州）"]，“首字母缩略词”：“ABA-API-TST”，“name”：“ABA成年小鼠大脑”，“@id”：“http://data.bioontology.org/ontology/ABA-API-TST",“@type”：“http://data.bioontology.org/metadata/本体",“链接”：{“指标”：“http://data.bioontology.org/ontologies/ABA-API-TST/metrics",“提交”：“http://data.bioontology.org/ontologies/ABA-API-TST/submissions网站",“类”：“http://data.bioontology.org/ontologies/ABA-API-TST/classes",“根”：“http://data.bioontology.org/ontologies/ABA-API-TST/classes/roots",“评论”：“http://data.bioontology.org/ontologies/ABA-API-TST/reviews"},“@context”：{“@vocab”：“http://data.bioontology.org/metadata（数据）/",“缩写词”：“http://omv.ontoware.org/2005/05/ontology#缩写",“名称”：“http://omv.ontoware.org/2005/05/ontology#name",“管理员”：{“@id”：“http://data.biontology.org/metadata/用户",“@type”：“@id”}}}

• 第7行显示了资源的id。对id执行HTTP GET将检索资源。
• 第8行显示媒体类型（见下文）。
• 第9行启动链接散列。
• 第16行是资源的上下文，可用于确定id列表的类型。例如，第2行列出管理本体的用户的id，可以通过查找管理员属性在中@上下文搞砸。
• 如果您对资源中使用的谓词URI值感兴趣，可以通过查找中的属性@上下文散列或通过附加的值@人声（第17行）到属性名属性没有在@上下文.

XML格式

XML也可以作为替代内容类型。

以下是XML格式的输出示例：

<本体><按集合管理><管理员>http://data.bioontology.org/user/nevada（美国内华达州）</管理员></administeredByCollection>ABA-API-TSTABA成年小鼠大脑<标识>http://data.bioontology.org/ontology/ABA-API-TST</id><链接><self href=“http://data.bioontology.org/ontology/ABA-API-TST“rel=”http://data.bioontology.org/metadata/本体"/><metrics href=“/本体论/ABA-API-TST/metrics”/><submissions href=“/ontologies/ABA-API-TST/提交”rel=“http://data.bioontology.org/metadata/Ontology提交"/><classes href=“/本体论/ABA-API-TST/classes”rel=“http://www.w3.org/2002/07/owl#类“/><roots href=“/本体论/ABA-API-TST/classes/roots”rel=“http://www.w3.org/2002/07/owl#类"/><reviews href=“/本体论/ABA-API-TST/reviews”rel=“http://data.biontology.org/metadata/Review"/></链接></本体>

• 第8行开始链接部分
• 第9-14行按类型列出链接。这个href公司属性包含链接位置和相对属性定义类型将在该位置找到的资源。
• 链接外部的元素也可以包含href公司和相对属性（即将推出…）