Developer Tools
Overview
The Data Access Portal provides RESTful web services APIs for programmatic use of the DAP.
There are four main groups of web service endpoints that can be used:
Endpoints | Status | Also known as | Access | Description | Documentation |
https://data.csiro.au/dap/ws/v2/collections | Stable | /ws/v2 | Public – read only | Use this to search and access DAP collections. | https://data.csiro.au/dap/swagger-ui.html?urls.primaryName=%40DAP-WS-V2 |
https://data.csiro.au/dap/api/v2 | Stable / In Development | /api/v2 | CSIRO staff only | All deposit features available in the DAP user interface. | https://data.csiro.au/dap/swagger-ui.html?urls.primaryName=DAP-API-V2 |
Features
Feature | /ws/v2 (stable) |
---|---|
Responses in JSON or XML | Yes |
Authenticate as CSIRO staff, Partners or OPAL user | Yes |
Search collections by keyword | Yes |
Search by location | Yes |
Search by:
|
Yes |
Search by publication date range | Yes |
Apply search facets to filter results | Yes |
Retrieve collection metadata | Yes |
List a collection’s available versions | Yes |
List a collection’s files | Yes |
Retrieve a file from a collection
(for mounted collections < 10GB) |
Yes |
List a collection’s supporting attachments | Yes |
Retrieve a supporting file from a collection | Yes |
Retrieve image thumbnails from a collections | Yes |
List accessible download options for a collection | Yes |
List the folder tree for a collection | Yes |
Retrieve a paginated list of files for a given folder in a collection | Yes |
Retrieve a list of files as a zip archive | Yes |
Export a collection’s file level metadata to Excel | Yes |
Mount a collection | Yes |
Retrieve a licence | Yes |
Retrieve a list of “external system” tags | Yes |
Retrieve a list of collections for a external system tag | Yes |
AAHL Virus Image Search endpoints | Yes |
ATNF Pulsar Observation Search endpoints | Yes |
CASDA Observation Search endpoints | Yes |
CASDA Skymap Search endpoints | Yes |
Read more about DAP identifiers at Understanding DAP Collection Identifiers