NIMH数据存档Web服务

NIMH数据存档(NDA)提供了各种Web服务,以支持计算科学家并促进研究系统之间的有效集成。这些直接的系统到系统接口可用于存放和访问NDA数据和元数据。 

在下面,您可以找到每个可用服务的简短描述,以及一个链接,可让您访问这些资源。 这些服务提供了RESTful接口,我们正在积极更新每个接口,以遵循 开放API规范 使用 Swagger API框架,包括基于浏览器的用户界面。

除了更现代的RESTful服务之外,我们还提供了基于SOAP的旧版服务,用于发布临时凭证,该凭证可与Amazon Web Services S3 API一起使用以访问数据文件中的内容(即, Omics和Neurosignal Recordings数据)。 有关更多详细信息,请参见 云段 of our Tools page.

保密协议 Web服务最近已更新。请访问 变更文件 section for details.

随着新服务的推出,它们将在此处进行记录。 如果您对现有服务有任何反馈或对改进或新服务的想法,请发送给 保密协议Help@mail.nih.gov

 

例子

样例代码 您可以在我们的GitHub帐户中找到有关与服务进行交互的信息,包括如何获取AWS身份验证令牌和下载文件。

  • AWS下载 是用于从AWS S3对象存储下载数据文件的Python命令行脚本。与Python 2和Python 3兼容。要下载,用户可以输入程序包ID,数据结构文件,带有S3链接列表的.txt文件或单个S3链接作为参数。
  • 资料存取 是一款Jupyter Notebook,演示了从NDAR软件包获取S3链接的方法,以及如何使用Python从本地从AWS S3对象存储中以编程方式下载文件的方法。还包括一些使用API​​的示例代码。
  • 保密协议 AWS令牌生成器 contains 用于获取AWS身份验证令牌的Bash和Python脚本。
  • Brainhack 2017 是Jupyter笔记本,它演示了如何从特定的GUID访问数据,以及如何从S3 Object Storage中下载任何关联的文件。
  • 数据登台服务 是一款Jupyter笔记本,它演示了如何将数据直接发布到miNDAR中,以及如何将数据上传到S3中的暂存空间。

 

变更文件

以下记录了对NDA网络服务的重大全球更新,这可能会影响现有的管道:

三月11,2019

服务名称

描述

回应格式

数据字典

提供 metadata about all of the measures (data structures) available within the 保密协议数据字典;包括组成每个数据结构的数据元素的详细信息。

 

此服务不需要身份验证。

 

说明文件: //nda.gratlusbc.net/api/datadictionary/v2/docs/swagger-ui.html

应用程序/ json
application/xml

实验

提供 metadata on all fMRI, Eye Tracking, and EEG 实验 研究人员已经定义了这些数据,然后将这些数据提交给NDA共享。

此服务不需要身份验证。

说明文件: //nda.gratlusbc.net/swagger/#/experiment

应用程序/ json
application/xml

搜索

保密协议搜寻 使用此服务在整个平台上提供搜索。

 

提供 the ability to query publicly available content across all of NDA, including Studies, Collections, the Data Dictionary, experiments, and web pages.

 

此服务不需要身份验证。

 

说明文件: //nda.gratlusbc.net/api/search/docs/swagger-ui.html

应用程序/ json

 

图形用户界面

提供 所提供的GUID为其共享了数据的所有数据结构(按类型组织)的列表,并执行附加操作来检索用户有权访问的GUID的所有数据。

 

需要HTTP基本身份验证。

 

说明文件: //nda.gratlusbc.net/api/guid/docs/swagger-ui.html

应用程序/ json
application/xml

微雷达

提供 a RESTful interface for depositing data into a 微雷达。未来的API服务将支持miNDAR的验证,打包和提交数据。

 

其他服务正在添加到此服务中,以支持miNDAR列出和检索数据。

 

需要 HTTP基本身份验证。

 

说明文件: //nda.gratlusbc.net/api/mindar/docs/swagger-ui.html

应用程序/ json
application/xml
验证

提供 RESTful接口,用于在提交给NDA之前验证数据结构。该服务将返回数据中的任何错误或警告,并提供唯一的UUID来检查验证状态。

 

说明文件: //nda.gratlusbc.net/api/validation/docs/swagger-ui.html

应用程序/ json
application/xml
提交包

RESTful接口,用于为已成功通过验证的多个数据文件创建提交包。从每个文件的验证要求UUID,并具有提交到集合或备用终结点的权限。该服务将为包裹返回唯一的UUID,可用于检查包裹的状态。

 

需要 HTTP基本身份验证。

 

说明文件: //nda.gratlusbc.net/api/submission-package/docs/swagger-ui.html

应用程序/ json
application/xml
提交

提供一个RESTful接口,用于在成功验证所有数据文件并创建提交包之后将数据提交到NDA。需要提交包服务中的UUID。允许检查提交状态,查看所有以前的提交, 并检查包中每个文件的上传状态。

 

需要 HTTP基本身份验证。

 

说明文件: //nda.gratlusbc.net/api/submission/docs/swagger-ui.html

应用程序/ json
application/xml