DataONE Architecture¶
The Data Observation Network for Earth (DataONE) implements and deploys core services and infrastructure to support long term access and re-use of data collected through NSF funded and other research projects.
These documents describe the architecture and APIs for deployed DataONE cyberinfrastructure.
API Reference¶
Components of the DataONE infrastructure interact through the DataONE APIs. Participating data repositories expose the Member Node APIs and Coordinating Nodes expose the Coordinating Node APIs.
API service endpoints use a restful pattern. All API interactions occur over HTTPS with XML encoded messages. The XML messages are defined by the DataONE Types XML Schema. Exceptions Raised by MN and CN APIs are cast to applicable HTTP error codes, with the response body containing an XML representation of the error. The RESTful implementation is more fully described in the REST Interface Overview.
Services¶
Design Documents¶
The design documents describe the intended functionality of the DataONE infrastructure. User Scenarios provide a functional overview from a user perspective. Use Cases provides a more detailed view of how the APIs are used to support specific component interactions.
- Node Identity and Registration
- What is Data (DataONE Perspective)?
- Data Packaging
- DataONE Preservation Strategy
- Replication Overview
- Mutability of Content in DataONE
- Identifiers in DataONE
- Content Discovery
- Querying DataONE
- Supporting Online Citation Managers through COinS
- DataONE Cybersecurity Plan
- Identity Management and Authenticated Session Management
- Authorization in DataONE
- Supporting Access Control in Search
- System Metadata
- Getting a Handle on Systems Metadata for the Long Haul
- Natural History of System Metadata
- Serialization of Types for Transfer Over HTTP
- NodeList
- Coordinating Node Internals
- Event Logging and Reporting
- Log Aggregation Overview
- Event Log Index Schema
- DataONE Usage Statistics
- Event Log Index Schema
- Analysis and Modeling Tools
- Investigator Toolkit
- What is This Thing?
- Semantic Search Design
Notes and Miscellanea¶
- General Design and Implementation Notes
- Logging and Privacy concerns
- Cross Domain Indexing and Access for Data and Metadata
- Replication Notes
- Notes for MN API
- Coordinating Node Requirements
- Apache Configuration for DataONE Services
- Mutability of Metadata
- Selectors for Data Package Components
- Time and Bandwidth Constraints
- Proposal for API Refactoring
- License and Copyright Policy
- Acknowledgements
- About These Documents
- Glossary
- Change Log
- 2014-02-12: Version 1.2. Clarification edits
- 2013-10-17: Version 1.2. Minor edits
- 2012-10-09: Version 1.1. Clarifying count parameter for slicing
- 2012-09-28: Version 1.1. Adding MNQuery API
- 2012-09-25: Version 1.1. Revising proposed Query API
- 2012-08-20: Version 1.1. Augmenting Search API
- 2012-05-31: Version 1.0, Correction to URIs in Resource Maps
- 2012-05-02: Version 1.0, MethodCrossReference.xls
- 2012-05-01: Version 1.0, MethodCrossReference.xls
- 2012-03-26: Version 1.0, MethodCrossReference.xls
- 2012-03-26: Version 1.0, MethodCrossReference.xls
- 2012-03-25: Version 1.0, MethodCrossReference.xls
- 2012-02-27: Version 1.0, MethodCrossReference.xls
- 2012-02-24 : dataoneTypes.xsd
- 2012-02-17 : Version 1.0, MethodCrossReference.xls
- 2012-02-15 : Version 1.0, MethodCrossReference.xls
- 2012-02-02 : Version 1.0, MethodCrossReference.xls
- 2012-02-01 : Version 1.0, MethodCrossReference.xls
- 2012-01-20 : Version 1.0, MethodCrossReference.xls
- 2012-01-19 : Version 1.0, MethodCrossReference.xls
- 2012-01-12 : Version 1.0, MethodCrossReference.xls
- 2012-01-10 : Version 1.0, MethodCrossReference.xls
- 2012-01-03 : Version 1.0, MethodCrossReference.xls
- 2011-12-19 : Version 1.0, dataoneTypes.xsd
- 2011-12-13 : Version 1.0
- 2011-12-12 : Version 1.0
- 2011-12-08 : Version 1.0
- 2011-12-06 Version 1.0.0 Branch
- 2011-12-05 Version 1.0.0 Branch
- 2011-11-08 Version 1.0.0 Branch
- 2011-11-03 Version 1.0.0 Branch
- 2011-11-02 Version 1.0.0 Branch
- 2011-11-01 Version 1.0.0 Branch
- 2011-10-26 Version 1.0.0 Branch
