# CSIRO Api-V2 Collections API

**Canonical:** https://apis.io/apis/csiro/csiro-api-v2-collections-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 Api-V2 Collections 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 Api-V2 Collections. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 14 JSON Schemas.

The Api-V2 Collections API from CSIRO — 47 operation(s) for api-v2 collections.

## Operations (60)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v2/system/collections/{id}` | Retrieve collection for a system user for editing by id |
| PUT | `/api/v2/system/collections/{id}` | Save collection as draft by a system user |
| DELETE | `/api/v2/system/collections/{id}` | Delete draft collection by system user |
| GET | `/api/v2/collections/{id}` | Retrieve collection for editing by id |
| PUT | `/api/v2/collections/{id}` | Save draft collection |
| DELETE | `/api/v2/collections/{id}` | Delete draft collection |
| PUT | `/api/v2/collections/{id}/files/{fileId}` | Update the metadata of a single file |
| PUT | `/api/v2/collections/{id}/files/bulk` | Selectively update the metadata of multiple files |
| PUT | `/api/v2/collections/{id}/casdaFiles/resolve` | Update the Pawsey file paths for a CASDA derived data collection and return the… |
| PUT | `/api/v2/collections/{dataCollectionId}/permitted-users` | Update the permitted users of a collection by depositor without creating a new… |
| PUT | `/api/v2/collections/{dataCollectionId}/embargo-acccess` | update the permitted users for a given embargoed collection |
| POST | `/api/v2/system/collections/{type}` | Create and save a new self service draft collection by a system user |
| POST | `/api/v2/collections/{type}` | Create a new self service draft collection and save it |
| POST | `/api/v2/collections/{id}/{type}/update` | Update type of a service collection to generic or software. |
| POST | `/api/v2/collections/{id}/update` | Update a collection. Creates a new version of a collection |
| POST | `/api/v2/collections/{id}/supportingFiles` | Upload supporting file |
| DELETE | `/api/v2/collections/{id}/supportingFiles` | Delete supporting file(s) |
| GET | `/api/v2/collections/{id}/submit` | Retrieve the current approval details as a starting point for submitting the… |
| POST | `/api/v2/collections/{id}/submit` | Submit a previously saved draft data collection for approval or direct… |
| POST | `/api/v2/collections/{id}/returnToDraft` | Return a collection to Draft, if it is submitted but not approved |
| GET | `/api/v2/collections/{id}/reassign` | Retrieve the current depositor details as a starting point for reassigning the… |
| POST | `/api/v2/collections/{id}/reassign` | Reassign a data collection |
| GET | `/api/v2/collections/{id}/folders` | Get the folder tree for a given collection |
| POST | `/api/v2/collections/{id}/folders` | Create a folder for a draft collection |
| DELETE | `/api/v2/collections/{id}/folders` | Delete a folder in a draft collection |
| GET | `/api/v2/collections/{id}/files` | Get a list files for a given folder and page number |
| POST | `/api/v2/collections/{id}/files` | Upload files |
| DELETE | `/api/v2/collections/{id}/files` | Delete a file from the file system for a draft collection |
| POST | `/api/v2/collections/{id}/files/unlock` | Unlock files so that they can be modified. |
| POST | `/api/v2/collections/{id}/copy` | Copy an existing collection. Creates a new collection |
| POST | `/api/v2/collections/{id}/changeCollaborators` | Change the deposit collaborators of a collection |
| GET | `/api/v2/collections/{id}/changeApprover` | Retrieve the approver details as the first step to changing approver |
| POST | `/api/v2/collections/{id}/changeApprover` | Change the approver of a collection |
| POST | `/api/v2/collections/{id}/amend` | re-opens a collections so files can be amended and the collection republished |
| POST | `/api/v2/collections/xml` | Create collections from XML metadata files. |
| POST | `/api/v2/collections/xml/validate` | Upload XML metadata files for preliminary validation |
| POST | `/api/v2/collections/casda/{projectCode}` | Create a derived CASDA collection for an ATNF project |
| GET | `/api/v2/collections/atnf/{projectCode}` | Retrieve a list of the 'master' collections for an ATNF pulsar project |
| POST | `/api/v2/collections/atnf/{projectCode}` | Create any missing 'master' collections for an ATNF pulsar project |
| POST | `/api/v2/collection/{id}/withdraw` | Withdraw a collection |
| GET | `/api/v2/user-collections` | Retrieve collections for the passed in non csiro user |
| GET | `/api/v2/my-templates` | Retrieve collection templates for the current user |
| GET | `/api/v2/my-collections` | Retrieve collections for the current user |
| GET | `/api/v2/featuredCollections` | Retrieve current list of featured collections |
| GET | `/api/v2/dontcallme` | Swagger codegen casda file DTO |
| GET | `/api/v2/collections/{id}/validate` | Validate a previously saved draft data collection |
| GET | `/api/v2/collections/{id}/supportingFiles/{fileId}` | Retrieve supporting file(s) |
| GET | `/api/v2/collections/{id}/folders/contents` | Get a list files for a given folder and page number |
| GET | `/api/v2/collections/{id}/files/summary` | Get summary information about the files in a collection |
| GET | `/api/v2/collections/{id}/files/s3uploadurl` | Get a presigned URL for direct file upload into S3 |
| GET | `/api/v2/collections/{id}/files/s3` | S3Info to access a collection in Amazon S3 |
| GET | `/api/v2/collections/{id}/files/s3/pulsar` | S3Info to access a pulsar collection in Amazon S3 |
| GET | `/api/v2/collections/{id}/files/metadata` | Get all the existing file metadata values for a text field. |
| GET | `/api/v2/collections/{id}/files/fileState` | Retrieve a collections current file state |
| GET | `/api/v2/collections/{id}/file` | Get the metadata of a single file by path |
| GET | `/api/v2/collections/{id}/collaborators` | Retrieve the deposit collaborator(s) for a collection |
| GET | `/api/v2/collections/{id}/casdaFiles` | Retrieve the Pawsey file paths for a CASDA derived data collection |
| GET | `/api/v2/collections/{id}/access` | Retrieve collection metadata and data access levels. |
| GET | `/api/v2/collections/{fedoraId}/history` | Retrieve all versions of a the collection matching the fedora id |
| GET | `/api/v2/collections/{collectionId}/approvalHistory` | /collections/{collectionId}/approvalHistory |

## Machine-readable artifacts (17)

- **OpenAPI** — https://artifacts.apis.io/csiro/openapi/csiro-api-v2-collections-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 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/)
- [CSIRO Collection Data API](https://apis.io/apis/csiro/csiro-collection-data-api/)

## Tags

Api-V2 Collections

---

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