# CSIRO Api-V2 Supporting Data API

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

The Api-V2 Supporting Data API from CSIRO — 57 operation(s) for api-v2 supporting data.

## Operations (60 of 62)

| Method | Path | Summary |
|---|---|---|
| PUT | `/api/v2/help/page/{page}/{key}` | Update existing help text item |
| PUT | `/api/v2/doiFiles` | Update DoiFilesDataset record. Requires admin priveledges |
| POST | `/api/v2/doiFiles` | Create new DOI and save to new DoiFilesDataset record |
| GET | `/api/v2/collectionTemplates/{id}` | Retrieve a collection template by id |
| PUT | `/api/v2/collectionTemplates/{id}` | Update existing template |
| DELETE | `/api/v2/collectionTemplates/{id}` | Delete a collection template by id |
| GET | `/api/v2/activities/{activityId}` | Retrieve activity by id |
| PUT | `/api/v2/activities/{activityId}` | Update an existing activity |
| POST | `/api/v2/users` | Create a new user |
| POST | `/api/v2/users/organisations` | Create a new organisation |
| POST | `/api/v2/collectionTemplates/{type}` | Create a new template |
| POST | `/api/v2/collectionTemplates/{id}/copy` | Copy an existing template. Creates a new template |
| POST | `/api/v2/activities` | Create a new activity |
| GET | `/api/v2/users/search` | Search for users by search term |
| GET | `/api/v2/users/organisations/search` | Search for an organisation by search term |
| GET | `/api/v2/users/groups/search` | Search for permitted groups by search term |
| GET | `/api/v2/users/depositors/search` | Search for depositors by search term |
| GET | `/api/v2/users/contributors/search` | Search for contributors by search term |
| GET | `/api/v2/users/contributors/other-users/search` | Search for non-csiro users by search term |
| GET | `/api/v2/users/contributors/iseditable` | Check if the given contributor can be edited |
| GET | `/api/v2/users/contacts/search` | Search for contacts by search term |
| GET | `/api/v2/users/collaborators/search` | Search for collaborators |
| GET | `/api/v2/users/approvers/search` | Search for approvers |
| GET | `/api/v2/users/approvers/nrca/search` | Search for NRCA approvers |
| GET | `/api/v2/users/approvers/casda/search` | Search for CASDA approvers |
| GET | `/api/v2/users/advisers/search` | Search for advisers |
| GET | `/api/v2/tombstone/dataset/{uuid}` | Get data set tombstone |
| GET | `/api/v2/settings` | Retrieve application settings |
| GET | `/api/v2/serviceMetadata` | Harvest OGC Service metadata |
| GET | `/api/v2/orgNodes/relatedNodes` | Retrieve org nodes related to a given node i.e. business unit, group, program |
| GET | `/api/v2/orgNodes/projects/search` | Search for WBS org units by code or title |
| GET | `/api/v2/orgNodes/costCentres` | Retrieve all cost centres for a given business unit |
| GET | `/api/v2/orgNodes/businessUnits` | Retrieve all business units |
| GET | `/api/v2/opalProjects/{projectCode}` | Get OPAL project by project code |
| GET | `/api/v2/opalProjects/search` | Search for OPAL projects already known to DAP. |
| GET | `/api/v2/lookups` | Retrieve all lookup data for populating various fields of a collection |
| GET | `/api/v2/licences` | Retrieve licences available for all collection types |
| GET | `/api/v2/licences/{id}` | Retrieve a single licence by record id |
| GET | `/api/v2/licences/type/{contentType}` | Retrieve licences available for given collection type |
| GET | `/api/v2/help/page` | Get all help pages |
| GET | `/api/v2/help/page/{page}` | Get all help messages for a given page |
| GET | `/api/v2/files/fieldMetadata` | Retrieve file metadata field definitions for all schema types |
| GET | `/api/v2/facility/{type}` | Retrieve all national collection or facilities |
| GET | `/api/v2/externalsystems` | Retrieve external systems known to DAP |
| GET | `/api/v2/dontcallme3` | Swagger codegen licence dto |
| GET | `/api/v2/dontcallme2` | Swagger codegen lookup value DTO |
| GET | `/api/v2/dontcallme1` | Swagger codegen ado parameter field dto |
| GET | `/api/v2/doiFiles/{id}` | Retrieve a DoiFiles Dataset for a given id |
| DELETE | `/api/v2/doiFiles/{id}` | Delete a DoiFiles Dataset for a given id. Requires admin priveledges |
| GET | `/api/v2/doiFiles/uuid/{uuid}` | Retrieve a DoiFiles Dataset for a given UUID |
| GET | `/api/v2/doiFiles/uuid/{uuid}/files` | Retrieve files for a given UUID split by available and withdrawn collection… |
| GET | `/api/v2/doiFiles/resolver` | Retrieve configured DoiFiles DOI resolver service baseUrl |
| GET | `/api/v2/doiFiles/doi/{linkA}/{linkB}` | Retrieve a DoiFiles Dataset for a given doi link value |
| GET | `/api/v2/doiFiles/creator` | Retrieve all DoiFilesDataset records created by calling User (Users.id) |
| GET | `/api/v2/doiFiles/creator/{id}` | Retrieve all DoiFilesDataset records for a given creatorId (Users.id) |
| GET | `/api/v2/depositMethods` | Retrieve deposit methods avaliable for a user |
| GET | `/api/v2/dataCollectionTypes` | Retrieve data collection type definitions |
| GET | `/api/v2/collectionTemplates/ids/{type}` | Retrieve summary information of all templates for user |
| GET | `/api/v2/activities/search` | Create a new activity for a collection |
| GET | `/api/v2/FOR/search` | Search for FOR categories by keyword |

…and 2 more operations. They are listed in full on the page.

## Machine-readable artifacts (17)

- **OpenAPI** — https://artifacts.apis.io/csiro/openapi/csiro-api-v2-supporting-data-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 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 Supporting Data

---

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