# CSIRO Collection Search API

**Canonical:** https://apis.io/apis/csiro/csiro-collection-search-api/  
**Provider:** CSIRO — https://apis.io/providers/csiro/  
**Base URL:** https://data.csiro.au/dap/ws/v2  
**Documentation:** https://research.csiro.au/dap/developer-tools/web-services-ws-v2/

CSIRO Collection Search API is one of 20 APIs that [CSIRO](https://apis.io/providers/csiro/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 14 JSON Schema definitions. Tagged areas include Collection Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 14 JSON Schemas.

The Collection Search API from CSIRO — 20 operation(s) for collection search.

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| POST | `/ws/v2/collections/{dataCollectionId}/globus` | Create globus guest collection mapped to a dap datacollection |
| POST | `/ws/v2/collections/advancedSearch` | This function allows a client to search for collections using advanced criteria |
| GET | `/ws/v2/tombstone/{dataCollectionId}` | Get collection tombstone |
| GET | `/ws/v2/collections{ext}` | This function allows a client to search for collections matching specific… |
| GET | `/ws/v2/collections/{id}/versions` | Get all versions |
| GET | `/ws/v2/collections/{id}/version-history` | Get collection data versions |
| GET | `/ws/v2/collections/{id}/support` | Get collection supporting file list |
| GET | `/ws/v2/collections/{id}/support/{fileId}` | Get collection supporting file |
| GET | `/ws/v2/collections/{id}/relatedcollections` | Retrieve a list of 'Related Collections' for a given data collection id |
| GET | `/ws/v2/collections/{id}/metadata` | Get collection metadata list |
| GET | `/ws/v2/collections/{id}/metadata/{type}` | Get collection metadata by type |
| GET | `/ws/v2/collections/{id}/images` | Get collection image file list |
| GET | `/ws/v2/collections/{id}/files/excelExport` | Get export collection to excel |
| GET | `/ws/v2/collections/{id}` | This function allows a client to get a collection using ID, DOI or PID. |
| GET | `/ws/v2/collections/{doi}/**` | This function allows a client to get a collection using ID, DOI or PID. |
| GET | `/ws/v2/collections/searchbylocation` | This function allows a client to search for collections matching specific… |
| GET | `/ws/v2/collections/search` | This function allows a client to search for collections by lead researcher or… |
| GET | `/ws/v2/collections/searchByIndex` | This function allows a client to browse collections using certain keywords |
| GET | `/ws/v2/collections/browse/{browseType}/{browseValue}` | This function allows a client to browse collections using certain keywords |
| GET | `/ws/v2/collections/advancedSearchParams` | Returns valid search by and filter by values for the advanced search |

## Machine-readable artifacts (17)

- **OpenAPI** — https://artifacts.apis.io/csiro/openapi/csiro-collection-search-api-openapi.yml
- **Documentation** — https://research.csiro.au/dap/developer-tools/
- **APIExplorer** — https://data.csiro.au/dap/swagger-ui.html
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-data-collection-dto-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-casda-metadata-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-casda-observation-search-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-data-collections-result-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-specimen-image-result-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-specimen-image-search-request-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-data-collection-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-my-collection-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-casda-observation-validation-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-doi-files-dataset-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-globus-collection-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-orcid-results-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-orcid-work-dto-schema.json
- **JSONSchema** — https://artifacts.apis.io/csiro/json-schema/csiro-orcid-user-dto-schema.json

## Other CSIRO APIs (12)

- [CSIRO AAHL API](https://apis.io/apis/csiro/csiro-aahl-api/)
- [CSIRO Api-V2 Admin API](https://apis.io/apis/csiro/csiro-api-v2-admin-api/)
- [CSIRO Api-V2 Authentication API](https://apis.io/apis/csiro/csiro-api-v2-authentication-api/)
- [CSIRO Api-V2 Casda Observations API](https://apis.io/apis/csiro/csiro-api-v2-casda-observations-api/)
- [CSIRO Api-V2 Collections API](https://apis.io/apis/csiro/csiro-api-v2-collections-api/)
- [CSIRO Api-V2 DNA Sequence Collections API](https://apis.io/apis/csiro/csiro-api-v2-dna-sequence-collections-api/)
- [CSIRO Api-V2 Supporting Data API](https://apis.io/apis/csiro/csiro-api-v2-supporting-data-api/)
- [CSIRO Api-V2 User Profile API](https://apis.io/apis/csiro/csiro-api-v2-user-profile-api/)
- [CSIRO Api-V2 User Tasks API](https://apis.io/apis/csiro/csiro-api-v2-user-tasks-api/)
- [CSIRO ATNF API](https://apis.io/apis/csiro/csiro-atnf-api/)
- [CSIRO CASDA API](https://apis.io/apis/csiro/csiro-casda-api/)
- [CSIRO Collection Browse API](https://apis.io/apis/csiro/csiro-collection-browse-api/)

## Tags

Collection Search

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/csiro/csiro-collection-search-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/csiro/.