OMIM搜索帮助-OMIM公司

OMIM API


概述:

OMIM API URL的组织方式非常简单:

/api/[处理程序]?[参数]

/api/[handler]/[component]?[参数]

/api/[处理程序]/[操作]?[参数]

处理程序引用数据对象,例如条目或临床概要。

组件是可选的,它引用数据对象中的特定数据组件,例如条目中的引用。

该操作是可选的,是指要对数据对象执行的操作,例如搜索条目。

对于基本的“GET”,组件或操作通常是可选的。

参数包括MIM编号、数据检索选项和数据格式选项。

由于这是一个只读数据库,“GET”是用于公共访问的唯一HTTP方法,所有其他HTTP方法都将返回错误(支持“POST”和“DELETE”的apiKey处理程序除外,该处理程序用于在饼干)。


基础知识:

1.1
1.4
1.5
1.6

处理人:

2.1
2.4
2.5
2.6


1.1
API密钥

API密钥是每个想要访问API的开发人员所独有的密钥。它由OMIM分配,不应共享。这必须包含在每个请求中,并在处理请求之前进行验证。有三种方式包含在请求中。

添加为HTTP标头,如下所示:

ApiKey:nfNEOscLNWWXdSmUoMLPPA

添加为cookie,如下所示:

Cookie:ApiKey=nfNEOscLNWWXdSmUoMLPPA

添加为url请求的参数,如下所示:

https://api.omim.org/….?…&apiKey=nfNEOscLNWWXdSmUoMLPPA

请注意,API键参数名称区分大小写。


1.2
通用参数

所有处理程序都支持许多通用参数,这些参数是:

参数 描述
格式 这指定返回数据的格式,包括“json”和“xml”(例如“format=json”)。

1.3
API HTML接口

API提供了一个简单但功能强大的基于HTML的接口,用于查看url的结构。

基于HTML的界面的主页是:

https://api.omim.org/api/html


1.4
限制

API将限制在单个请求中可以检索的条目数。

如果指定了任何“包括”,则每个请求的条目和临床摘要限制为20个,否则就没有限制。

每个请求的基因图条目限制为100个。

可以使用“开始”和“限制”参数批量检索结果,如下所示:

…起始=0,极限=20。。。
…开始=20&限制=20。。
…开始=40,限制=20。。


1.5
压缩

该API支持gzip压缩,因此,如果可能的话,您应该在客户端中启用gzip编码以减少网络流量。压缩可以将响应的大小减小4或5倍,这在带宽受限的环境中非常有利。

某些客户端自动支持压缩,而其他客户端则需要专门启用压缩。请检查您正在使用的客户端的文档。

表示客户端可以接收压缩响应的HTTP标头如下:

接受编码:gzip

例如,curl默认情况下不启用gzip压缩,因此它将收到未压缩的响应:

卷曲“https://api.omim.org/api/。。。"

将HTTP标头添加到将接收压缩响应:

curl-H“接受编码:gzip”https://api.omim.org/api/。。。“|gunzip


1.6
API主机

API主机是:

api.omim.org网站


1.7
HTTP状态代码

API返回以下HTTP状态代码:

状态 姓名 描述
200 好 啊 请求成功
400 错误的请求 请求失败,因为URL不正确
401 未经授权 请求失败,因为API密钥无效或不活动
404 找不到 请求失败,因为请求的数据不存在
429 请求太多 请求失败,因为已超过API密钥的配额
500 内部服务器错误 由于内部服务器错误,请求失败

2.1
“entry”处理程序

条目处理程序支持以下操作/组件:

[无]

这是默认情况,需要一个参数“mimNumber”来指定要检索的MIM条目,例如:

https://api.omim.org/api/entry?mimNumber=100100

可以按如下方式指定多个MIM编号:

https://api.omim.org/api/entry?mimNumber=100100和mimNumber=100200

或如下:

https://api.omim.org/api/entry?mimNumber=100100,100200

这将返回MIM编号、前缀、状态和标题。

可以使用“include”参数检索其他内容,包括如下内容:

参数 描述
文本 包含文本字段部分和条目。
现有标志 在条目中包括“存在”标志(临床概要、等位基因变体、基因图谱和表型图谱)。
所有变量列表 在条目中包含等位基因变体列表。
临床概要 在条目中包含临床概要。
另请参见 在条目中包含“see also”字段。
参考列表 在条目中包含参考列表。
基因图谱 在条目中包括基因图谱/表型图谱数据。
外部链接 在条目中包含外部链接。
贡献者 在条目中包含“贡献者”字段。
创建日期 在条目中包含“创建日期”字段。
编辑历史记录 在条目中包含“编辑历史记录”字段。
日期 在条目中包含日期数据。
全部的 在条目中包含上述数据。

例如:

https://api.omim.org/api/entry?mimNumber=100100&include=text&incluse=geneMap

或:

https://api.omim.org/api/entry?mimNumber=100100&include=text,基因图谱

默认情况下,“text”include将返回很长的整个文本。您可以指定哪个文本通过将冒号后跟文本节名称附加到“text”来返回节,例如:

https://api.omim.org/api/entry?mimNumber=100100&include=text:clinicalFeatures

文本部分包括:

节名称 章节标题
动物模型 动物模型
生物化学特征 生物化学特征
临床特征 临床特征
临床管理 临床管理
克隆 克隆和表达
细胞遗传学 细胞遗传学
描述 描述
诊断 诊断
进化 进化
基因家族 基因家族
geneFunction(基因功能) 基因功能
基因结构 基因结构
基因治疗 基因治疗
遗传变异性 遗传变异性
基因型 基因型
基因型表型相关性 基因型/表型相关性
异质性 异质性
历史 历史
继承 继承
映射 映射
分子遗传学 分子遗传学
命名法 术语
其他功能 其他功能
发病机理 发病机制
表型 表型
人口遗传学 群体遗传学
文本 文本(条目开头的未焊接文本部分)

最后,如果需要所有数据,可以指定:

参数 描述
全部的 在条目中包含所有数据。

例如:

https://api.omim.org/api/entry?mimNumber=100100&include=all

强烈建议在请求中只检索所需的数据。检索不需要的数据意味着您的请求将花费比正常情况更长的时间。

还有一个“exclude”参数用于排除不需要的部分,例如您可能需要除临床概要外的所有数据:

https://api.omim.org/api/entry?mimNumber=100100&include=all排除=clinicalSynopsis

“搜索”

搜索由SOLR提供,并使用扩展的demox解析器:

OMIM搜索帮助

OMIM搜索字段

阿帕奇SOLR

阿帕奇·卢森

SOLR帮助

SOLR搜索帮助

这允许客户端使用以下参数执行搜索:

参数 描述
搜索 搜索(必需)
滤波器 过滤器(可选)
领域 字段,默认为“数字^5标题^3默认值”
分类 要使用的排序顺序默认为“score desc”
操作人员 要使用的操作员
开始 结果的起始偏移,默认值为0
限制 要返回的结果数,默认为10
检索 检索与条目相对应的基因图或临床摘要,而不是条目本身

例如:

https://api.omim.org/api/entry/search?search=duchenne&start=0&limit=20

此外,上述章节中列出的所有参数也适用,例如:

https://api.omim.org/api/entry/search?search=duchenne&start=0&limit=20&include=geneMap

“operator”参数是可选的,可用于要求返回的文档包含搜索中的所有术语:

参数 描述
要求返回的文档包含搜索中的所有术语

“sort”参数采用条目索引中可用的任何搜索字段,一些有用的排序顺序包括:

参数 描述
分数描述 用于分数降序
score desc,前缀sort desc 对于降序得分顺序和降序前缀排序顺序
创建日期描述 对于创建日期递减的订单
创建日期asc 对于创建日期升序的订单
date_updated描述 用于降序更新的订单
更新日期asc 对于升序日期更新顺序

例如:

https://api.omim.org/api/entry/search?search=duchenne&sort=score+描述

如果未指定,则排序默认为“score desc”。请注意,需要排序顺序('asc'或'desc')。

“检索”参数允许检索与条目相对应的基因图或临床摘要,而不是条目本身:

参数 描述
基因图谱 检索相应的基因图谱
临床概要 检索相应的临床摘要

请注意,也可以通过搜索处理程序进行搜索,在这种情况下,处理程序和操作被翻转,因此:

https://api.omim.org/api/entry/search?search=duchenne&start=0&limit=20&include=geneMap

与以下内容相同:

https://api.omim.org/api/search/entry?search=duchenne&start=0&limit=20&include=geneMap

'allelicVariantList'

这允许客户端检索指定MIM条目的等位变量,例如:

https://api.omim.org/api/entry/allelicVariantList?mimNumber=100100

'参考列表'

这允许客户端检索指定MIM条目的引用,例如:

https://api.omim.org/api/entry/referenceList?mimNumber=100100


输入数据:

字段评论
奥米姆
条目列表
进入
前缀
mim编号
标题
首选标题标题和符号,用“;”分隔
包含的标题标题用“;;”分隔,和标题/符号用“;”分隔
地位“live”、“moved”、“removed”
移动到如果移动,将设置为目标条目mim编号
临床概要存在true | false-取决于是否存在临床概要,如果设置了“exists”include,则设置
allelicVariant存在true | false-取决于是否存在等位基因变体,如果设置了“exists”include,则设置
geneMap存在true | false-取决于基因图是否存在,如果设置了“exists”include,则设置
表型图存在true | false-取决于表型图是否存在,如果设置了“exists”include,则设置
表型序列存在true | false-取决于表型序列是否存在,如果设置了“exists”include,则设置
text节列表按顺序排列的文本节列表
text节
text节名称
text节标题
text节内容
所有变量列表
等位变体
地位“live”、“moved”、“removed”
移动到如果移动,将设置为目标条目mim编号
名称
备选名称
突变
文本
克林顿加入ClinVar登录的逗号列表
数据库快照以逗号分隔的SNP列表
gnomadSnpsgnomAD单核苷酸多态性
另请参见请参阅also列表,用“;”分隔
参考列表
参考
mim编号
参考编号
作者
标题
来源
公共ID
文章URL
国防部
基因映射列表
基因图谱
序列ID
染色体1-24
染色体符号1-22,X,Y
染色体排序
染色体定位开始(如果可用)
染色体位置结束(如果可用)
文字记录(如果可用)
细胞定位
计算细胞位置(如果可用)
mim编号
分子序列号分子序列号的逗号分隔列表
基因符号以逗号分隔的符号列表
基因名称
参考文献
评论
鼠标基因符号
鼠标GiID
批准的GeneSymbols
基因ID
信号群ID
表型映射列表
表型图
mim编号
表型
表型MimNumber
表型序列号表型序列号的逗号分隔列表
表型映射键
表型遗传
表型映射列表
表型图
mim编号
表型
表型MimNumber
表型序列号表型序列号的逗号分隔列表
表型映射键
表型遗传
序列ID基因图序列ID
染色体1-24
染色体符号1-22,X,Y
染色体分类
染色体定位开始(如果可用)
染色体位置结束(如果可用)
文字记录(如果可用)
细胞定位
计算细胞位置(如果可用)
基因符号以逗号分隔的符号列表
批准的GeneSymbols
基因ID
信号群ID
外部链接
基因IDentrez基因ID的逗号分隔列表
hgncIDHGNC标识
信号群ID以coma-分隔的信号群ID对的三列分隔列表
批准的GeneSymbols批准的基因符号的逗号分隔列表
ncbi引用序列NCBI引用序列的逗号分隔列表
基因库核苷酸序列以逗号分隔的genbank核苷酸序列列表
蛋白质序列以逗号分隔的蛋白质序列列表
uniProtIDuniprot ID的逗号分隔列表
本地特定数据库用三个分号分隔的数据库名称/url元组,每个元组用双分号分隔
mgiIDMGI ID的逗号分隔列表
mgi人类疾病MGI人类疾病标志(真|假)
蠕虫ID蠕虫ID的逗号分隔列表
蚯蚓蚯蚓酶DO
nbkID双分号分隔的NBK ID/临床疾病名称对的三分号分隔列表
负鼠综合征以三个分号分隔的双分号分隔负鼠ID/负鼠综合征名称对列表
飞行基地ID以逗号分隔的飞行基地ID列表
zfinID(zfinID)zfin ID的逗号分隔列表
hprdIDhprd ID的逗号分隔列表
科瑞尔病双半结肠分隔型coriell病的三重半结肠分隔列表
孤儿疾病以双分号分隔的孤儿ID/疾病对的三分号分隔列表
订单疾病GARD/ORDR疾病
破译综合征DECIPHER综合征
破译基因DECIPHER基因标志(true|false)
geneticsHomeReferenceID遗传学家庭参考ID
奥米亚德OMIA标识
snomedctIDSNOMEDCT ID
icd10cmIDICD10CM ID
icd9cmIDICD9CM标识
umlsIDUMLS ID
疾病OntologyID疾病本体ID
基因联盟ID遗传联盟ID
全球技术法规全球技术法规
cmgGene基因CMG基因
凯格通道KEGG通道
gwas目录GWAS目录
ClinGen剂量ClinGen剂量
clinGen有效性ClinGen有效性
君主君主
新生儿筛查新生儿筛查
药方IDPharmGKB ID
联合基因组联盟基因组
贡献者
创建日期
编辑历史记录
创建日期Web日期
epoch已创建Unix纪元
更新日期Web日期
epoch已更新Unix纪元

条目等位基因变异数据:

字段评论
奥米姆
所有变量列表
所有变量列表
等位变体
前缀
mim编号
首选标题
地位“live”、“moved”、“removed”
移动到如果移动,将设置为目标条目mim编号
名称
备选名称
突变
文本
数据库SNP以逗号分隔的dbSNP列表

条目参考数据:

字段评论
奥米姆
参考列表
参考列表
参考
mim编号
参考编号
作者
标题
来源
公共ID
文章URL
国防部

2.2
“clinicalSynopsis”处理程序

临床概要处理程序支持以下操作/组件:

[无]

这是默认情况,需要一个参数“mimNumber”来指定要检索的MIM条目,例如:

https://api.omim.org/api/clinicalSynopsis?mimNumber=100100

可以按如下方式指定多个MIM编号:

https://api.omim.org/api/clinicalSynopsis?mimNumber=100100&mimNumber=100200

或如下:

https://api.omim.org/api/clinicalSynopsis?mimNumber=100100,100200

这将返回MIM编号、前缀、状态和标题。

可以使用“include”参数检索其他内容,包括如下内容:

参数 描述
临床概要 在条目中包括临床概要。
现有标志 在条目中包括“exists”标记(临床概要、等位基因变体、基因图和表型图)。
外部链接 在条目中包含外部链接。
贡献者 在条目中包含参与者。
创建日期 在条目中包含创建日期。
编辑历史记录 在条目中包含编辑历史记录。
日期 在条目中包含日期。
全部的 在条目中包含上述数据。

例如:

https://api.omim.org/api/clinicalSynopsis?mimNumber=100100&include=clinicalSynopsis&incluse=externalLinks

或:

https://api.omim.org/api/clinicalSynopsis?mimNumber=100100&include=clinicalSynopsi,外部链接

最后,如果需要所有数据,可以指定:

参数 描述
全部的 在条目中包含所有数据。

例如:

https://api.omim.org/api/clinicalSynopsis?mimNumber=100100&include=all

强烈建议在请求中只检索所需的数据。检索不需要的数据意味着您的请求将花费更长的时间。

还有一个“exclude”参数用于排除不需要的部分,例如,您可能需要除外部链接之外的所有数据:

https://api.omim.org/api/clinicalSynopsis?mimNumber=100100&include=all&exclude=外部链接

“搜索”

搜索由SOLR提供,并使用扩展的demox解析器:

OMIM搜索帮助

OMIM搜索字段

阿帕奇SOLR

阿帕奇·卢森

SOLR帮助

SOLR搜索帮助

这允许客户端使用以下参数执行搜索:

参数 描述
搜索 搜索(必需)
滤波器 过滤器(可选)
领域 字段,默认为“数字^5标题^3默认值”
分类 要使用的排序顺序默认为“score desc”
开始 结果的起始偏移,默认值为0
限制 要返回的结果数,默认为10

例如:

https://api.omim.org/api/clinicalSynopsis/search?search=disorder&start=0&limit=20

此外,上述章节中列出的所有参数也适用,例如:

https://api.omim.org/api/clinicalSynopsis/search?search=disorder&start=0&limit=20&include=all

“排序”参数采用临床概要索引中可用的任何搜索字段,一些有用的排序顺序包括:

参数 描述
分数描述 用于分数降序
score desc,前缀sort desc 对于降序得分顺序和降序前缀排序顺序
创建日期描述 对于创建日期递减的订单
创建日期asc 对于创建日期升序的订单
更新日期说明 对于降序日期更新顺序
更新日期asc 对于升序日期更新顺序

例如:

https://api.omim.org/api/clinicalSynopsis/search?search=disorder&sort=score+描述

如果未指定,则排序默认为“score desc”。请注意,需要排序顺序('asc'或'desc')。

请注意,也可以通过搜索处理程序进行搜索,在这种情况下,将翻转处理程序>和操作,因此:

https://api.omim.org/api/clinicalSynopsis/search?search=disorder&start=0&limit=20

与以下内容相同:

https://api.omim.org/api/search/clinicalSynopsis?search=disorder&start=0&limit=20


临床概要数据:

字段评论
奥米姆
临床概要列表
临床概要
mim编号
前缀
首选标题标题取自mim条目
继承所有字段中的功能都用“;”分隔
生长并包括UMLS、SNOMEDCT、,
生长高度ICD10CM、ICD9CM和HPO
生长重量
增长其他
头部和颈部
头部和颈部头部
头部和颈部面部
头部和颈部耳朵
头部和颈部眼睛
头部和颈部鼻子
头部和颈部嘴巴
头部和颈部牙齿
头部和颈部颈部
心血管疾病
心脏血管
心血管的
呼吸系统的
口罩鼻咽
呼吸喉
呼吸道
呼吸肺
胸部
箱子外部特征
胸骨胸骨锁骨和肩胛骨
胸部胸部
胸部隔膜
腹部
腹部外部特征
腹部肝脏
腹部胰腺
腹胆道
腹部脾脏
腹部胃肠道
泌尿生殖科
生殖泌尿生殖外生殖器男性
生殖器泌尿外生殖器女性
生殖器尿道内生殖器男性
生殖器内生殖器女性
生殖泌尿生殖肾
泌尿生殖道输尿管
泌尿生殖膀胱
骨骼
骨骼头骨
骨骼脊椎
骨盆
骨骼肢体
骷髅手
骨骼脚
皮肤鼻毛
skinNailsHairSkin皮肤
皮肤病毛发皮肤组织学
皮肤指甲头发皮肤电子显微镜
皮肤指甲
皮肤毛发毛发
肌肉软组织
神经病学的
神经中枢神经系统
神经学周围神经系统
神经行为精神病学表现
嗓音
新陈代谢特征
内分泌特征
血液学
免疫学
肿瘤形成
产前表现
产前表现运动
产前表现羊水
产前表现胎盘和脐带
产前表现母体
产前表现交付
实验室异常
杂项
分子基础
继承存在如果包含数据(ii),则为true
增长存在如果本标题及其任何副标题包含数据(i),则为true
增长高度存在(ii)
增长权重存在(ii)
增长其他存在(ii)
头部和颈部存在(i)
头部和颈部头部存在(ii)
头部和颈部存在(ii)
头颈耳存在(ii)
头部和颈部眼睛存在(ii)
头部和颈部鼻子存在(ii)
头颈口存在(ii)
存在头部和颈部牙齿(ii)
头部和颈部存在(ii)
心脏血管存在(i)
心脏血管存在(ii)
心血管血管存在(ii)
呼吸器存在(i)
呼吸鼻咽存在(ii)
呼吸喉存在(ii)
呼吸器气道存在(ii)
呼吸肺存在(ii)
箱子存在(i)
箱子外部特征存在(ii)
胸骨胸骨锁骨和肩胛骨存在(ii)
胸部胸部现有(ii)
胸部隔膜存在(ii)
腹部存在(i)
腹部外部特征存在(ii)
腹部生命存在(ii)
腹部胰腺存在(ii)
存在腹部胆道(ii)
腹部SpleenExists(ii)
腹部胃肠道存在(ii)
生殖泌尿生殖系统存在(i)
泌尿生殖外部生殖器男性存在(ii)
生殖器外生殖器女性存在(ii)
生殖器泌尿系统内部男性生殖器存在(ii)
生殖器内生殖器女性存在(ii)
生殖泌尿生殖肾存在(ii)
生殖泌尿生殖尿道存在(ii)
泌尿生殖膀胱存在(ii)
骨骼存在(i)
骨骼头骨存在(ii)
骨骼脊椎存在(ii)
骨骼骨盆存在(ii)
骨骼肢体存在(ii)
骨骼手存在(ii)
骨骼脚存在(ii)
皮肤毛发存在(i)
skinNailsHairSkin存在(ii)
皮肤病毛发皮肤病史存在(ii)
皮肤病毛发皮肤电子显微镜存在(ii)
皮肤指甲存在(ii)
皮肤毛发毛发存在(ii)
肌肉软组织存在(ii)
神经系统存在(i)
神经中枢神经系统存在(ii)
神经学周围神经系统存在(ii)
存在神经行为精神病学表现(ii)
语音存在(ii)
代谢特征存在(ii)
内分泌特征存在(ii)
血液学存在(ii)
免疫学存在(ii)
肿瘤存在(ii)
产前表现存在(i)
产前表现运动存在(ii)
产前表现羊水存在(ii)
产前表现胎盘和脐带存在(ii)
产前表现母体存在(ii)
产前表现交付存在(ii)
实验室存在异常(i)
杂项存在(ii)
分子基础存在(ii)
旧格式旧格式的临床概要将被重新映射为新格式
外部链接外部链接见上文
贡献者
创建日期
编辑历史记录
创建日期Web日期
epoch已创建Unix纪元
更新日期Web日期
epoch已更新Unix纪元

2.3
“geneMap”处理程序

基因图处理程序支持以下操作/组件:

[无]

这是默认情况,支持三个不同的参数来检索数据(“染色体排序”是“染色体”的子参数):

参数 描述
序列ID 基因图谱中的序列ID(这些是没有中断的连续整数值,在一天的范围外不稳定)。
mim编号 mim编号。
染色体 染色体,1-22,23(X),24(Y),25(M),X,Y,M(线粒体),A(常染色体组),S(XY组)
染色体分类 染色体中的染色体排序(这些是连续的整数值,没有中断,并且在一天的范围之外不稳定)。

“sequenceID”和“chromosomeSort”参数还支持“start”和“limit”参数,以支持在地图上导航:

参数 描述
开始 基因图的起始偏移量,默认为0(从序列ID获取列表时可以为负数
限制 要返回的条目数,默认为10

此外,“表型存在”标志可用于将返回的条目限制为具有或不具有表型的条目,默认情况下返回所有条目:

参数 描述
描述
表型存在 “true”只返回具有表型的条目,“false”只返回不带表型的条目

例如,要检索100100的基因图条目:

https://api.omim.org/api/geneMap?mimNumber=100100

可以按如下方式指定多个MIM编号:

https://api.omim.org/api/geneMap?mimNumber=100100&mimNumber=100200

或如下:

https://api.omim.org/api/geneMap?mimNumber=100100,100200

检索序列ID 10的基因图条目:

https://api.omim.org/api/geneMap?sequenceID=10

要从序列ID 10开始检索基因图中的下10个条目:

https://api.omim.org/api/geneMap?sequenceID=10&limit=10

要获取随后的10个条目,url应为:

https://api.omim.org/api/geneMap?sequenceID=20&limit=10

在上述两种情况下,“start”参数默认为0,但您可以设置为负值:

https://api.omim.org/api/geneMap?sequenceID=20&start=-4限制=10(&L)

要检索1号染色体基因图中的前10个条目,url应为:

https://api.omim.org/api/geneMap?染色体=1&start=0&limit=10

要检索接下来的10个条目,url应该是:

https://api.omim.org/api/geneMap?染色体=1&start=10&limit=10

“chromosomeSort”参数也可用于检索染色体上的条目。

要检索1号染色体基因图中的前10个条目,url应为:

https://api.omim.org/api/geneMap?染色体=1&chromosomeSort=1limit=10

要检索接下来的10个条目,url应该是:

https://api.omim.org/api/geneMap?染色体=1&chromosomeSort=10&limit=10

这也可以与“start”参数混合使用:

https://api.omim.org/api/geneMap?染色体=1&chromosomeSort=1&start=1&limit=10

“sequenceID”和“chromosomeSort”参数不应被视为超出一天范围的稳定参数(基因图谱每天更新)。

“搜索”

搜索由SOLR提供,并使用扩展的demox解析器:

OMIM搜索帮助

OMIM搜索字段

阿帕奇SOLR

阿帕奇·卢森

SOLR帮助

SOLR搜索帮助

这允许客户端使用以下参数执行搜索:

参数 描述
搜索 搜索(必需)
滤波器 过滤器(可选)
领域 字段,默认为“default”
分类 要使用的排序顺序默认为“score desc”
开始 结果的起始偏移,默认值为0
限制 要返回的结果数,默认为10

例如:

https://api.omim.org/api/geneMap/search?search=kinase&start=0&limit=20

“sort”参数采用基因图索引中可用的任何搜索字段,一些有用的排序顺序包括:

参数 描述
分数描述 用于分数降序
染色体数目asc 用于染色体编号升序
染色体_编号asc,染色体_位置_起始asc 用于递增染色体编号顺序和染色体位置开始顺序

如果未指定,则排序默认为“score desc”。请注意,需要排序顺序('asc'或'desc')。

请注意,也可以通过搜索处理程序进行搜索,在这种情况下,处理程序和操作被翻转,因此:

https://api.omim.org/api/geneMap/search?search=kinase&start=0&limit=20

与以下内容相同:

https://api.omim.org/api/search/geneMap?search=kinase&start=0&limit=20


基因图数据:

字段评论
奥米姆
listResponse(列表响应)
染色体1-24
染色体符号1-22,X,Y
total个结果
启动索引
endIndex(结束索引)
基因映射列表
基因图谱
序列ID
染色体1-24
染色体符号1-22,X,Y
染色体分类
染色体定位开始(如果可用)
染色体位置结束(如果可用)
文字记录(如果可用)
细胞定位
计算细胞位置(如果可用)
mim编号
分子序列号分子序列号的逗号分隔列表
基因符号以逗号分隔的符号列表
基因名称
参考文献
评论
鼠标基因符号
鼠标GiID
批准的GeneSymbols
基因ID
信号群ID
表型映射列表
表型图
mim编号
表型
表型MimNumber
表型序列号表型序列号的逗号分隔列表
表型映射键
表型遗传

2.4
“搜索”处理程序

“搜索”处理程序用于搜索,并包含在上述四个处理程序中。


搜索响应数据:

字段评论
奥米姆
搜索响应
搜索
展开的搜索
解析搜索
搜索建议
searchSpelling(搜索拼写)
滤波器
展开的筛选器
领域
搜索报告
total个结果
启动索引
endIndex(结束索引)
分类
搜索时间
*列表enty/临床概要/基因图谱/表型图谱列表

2.5
“状态”处理程序

“status”处理程序可用于检查API状态。

例如:

https://api.omim.org/api/status网站


2.6
“apiKey”处理程序

apiKey处理程序允许API html接口在浏览器cookie中设置API密钥。它只支持一个参数:

参数 描述
api密钥 api密钥

例如,要在浏览器cookie中设置密钥(仅限“POST”方法):

https://api.omim.org/api/apiKey?apiKey=foo

要从浏览器cookie中删除密钥(仅限“删除”方法):

https://api.omim.org/api/apiKey网站

这里只支持API html接口。