Overview
The Data Access Portal provides RESTful web services APIs for programmatic use of the DAP, as well as an OAI-PMH provider for harvesting metadata.
There are three main groups of web service endpoints that can be used:
| Endpoints | Status | Also known as | Access | Description | Documentation |
|---|---|---|---|---|---|
| https://ws.data.csiro.au/collections | Stable | /ws/v1 | Public - read only | Use this to search and access DAP collections. | DAP Web Services - ws v1 |
| https://data.csiro.au/dap/ws/v2/collections | In development | /ws/v2 | Public - read only | Use this to search and access DAP collections. | https://data.csiro.au/dap/swagger-ui.html#/ |
| https://data.csiro.au/dap/api/v1 | In development | /api/v1 | CSIRO staff only:
| Use this to programmatically create DAP collections. | https://data.csiro.au/dap/swagger-ui.html#/ |
Comparison of Versions
For searching and accessing DAP collections, the options are to use /ws/v1 (https://ws.data.csiro.au/collections) or /ws/v2 (https://data.csiro.au/dap/ws/v2/collections).
Although /ws/v2 is still in development, it retains all the features of /ws/v1 and adds a number of new features. Generally speaking /ws/v2 is a better option, although it is possible you will need to re-factor any code that uses it after a new DAP release.
| Feature | /ws/v1 | /ws/v2 |
|---|---|---|
| Responses in JSON or XML |  | |
| Authenticate as Nexus, Partners or OPAL user |  | |
| Search collections by keyword | | |
| Search by location | | |
Search by:
| | |
| Search by publication date range | | |
| Apply search facets to filter results | | |
| Retrieve collection metadata | | |
| List a collection's available versions | | |
| List a collection's files | Partial | |
Retrieve a file from a collection (for mounted collections < 10GB) |
| |
| List a collection's supporting attachments | | |
| Retrieve a supporting file from a collection | | |
| Retrieve image thumbnails from a collections | | |
| List accessible download options for a collection | | |
| List the folder tree for a collection | | |
| Retrieve a paginated list of files for a given folder in a collection | | |
| Retrieve a list of files as a zip archive | | |
| Export a collection's file level metadata to Excel | | |
| Mount a collection | | |
| Retrieve a licence | | |
| Retrieve a list of "external system" tags | | |
| Retrieve a list of collections for a external system tag | | |
| AAHL Virus Image Search endpoints | | |
| ATNF Pulsar Observation Search endpoints | | |
| CASDA Observation Search endpoints | | |
| CASDA Skymap Search endpoints | | |
Need help with the Data Access Portal? Please contact Research Data Support at researchdatasupport@csiro.au or phone: +61 2 4960 6086