CSIRO

CSIRO Collection Data API

The Collection Data API from CSIRO — 11 operation(s) for collection data.

Documentation GitHub OpenAPI

Operations 11

GET /ws/v2/data/token Get collection data file #

GET /ws/v2/collections/{id}/thumbnail/{size} Retrieve a thumbnail for an image file by file path #

GET /ws/v2/collections/{id}/services Get a list of services for a Collection #

GET /ws/v2/collections/{id}/folders Get a list of folders for the collection. #

GET /ws/v2/collections/{id}/files This function allows a client to view a list files for a given folder and page… #

GET /ws/v2/collections/{id}/files/imageCount Retrieve the number of image files contained within the collection #

GET /ws/v2/collections/{id}/downloadOptions Get file download options #

GET /ws/v2/collections/{id}/data Get collection data file list #

GET /ws/v2/collections/{id}/data/{fileId} Get collection data file 1 #

GET /ws/v2/collections/thumbnail/{adoId}/{size} Retrieve a thumbnail for an image file by file id #

GET /ws/v2/collections/content/columns Get file columns #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/csiro:csiro-collection-data-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Csiro Collection Data API
  version: v2
  description: 'Operations tagged Collection Data across 2 of this provider''s published API definitions: csiro-dap-ws-v2-openapi.json, csiro-dap-ws-v2-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://data.csiro.au/dap
  description: Generated server url
security:
- basicAuth: []
- bearerAuth: []
- oauth2: []
tags:
- name: Collection Data
paths:
  /ws/v2/data/token:
    get:
      tags:
      - Collection Data
      operationId: getCollectionDataFile
      parameters:
      - name: jwt
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Get collection data file
      x-summary-source: derived
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/{id}/thumbnail/{size}:
    get:
      tags:
      - Collection Data
      summary: Retrieve a thumbnail for an image file by file path
      operationId: getThumbnailByPath
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: size
        in: path
        required: true
        schema:
          type: string
      - name: path
        in: query
        required: true
        schema:
          type: string
      - name: jwt
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/{id}/services:
    get:
      tags:
      - Collection Data
      summary: Get a list of services for a Collection
      operationId: getServices
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResultDto'
            application/xml:
              schema:
                $ref: '#/components/schemas/ServiceResultDto'
            text/xml:
              schema:
                $ref: '#/components/schemas/ServiceResultDto'
            application/atom+xml;type=entry:
              schema:
                $ref: '#/components/schemas/ServiceResultDto'
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/{id}/folders:
    get:
      tags:
      - Collection Data
      summary: Get a list of folders for the collection.
      operationId: getFolders
      parameters:
      - name: id
        in: path
        description: data collection id.
        required: true
        schema:
          type: string
        example: 12345
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderDto'
            application/xml:
              schema:
                $ref: '#/components/schemas/FolderDto'
            text/xml:
              schema:
                $ref: '#/components/schemas/FolderDto'
            application/atom+xml;type=entry:
              schema:
                $ref: '#/components/schemas/FolderDto'
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/{id}/files:
    get:
      tags:
      - Collection Data
      summary: This function allows a client to view a list files for a given folder and page…
      operationId: getFiles
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: q
        in: query
        required: false
        schema:
          type: string
      - name: folder
        in: query
        required: true
        schema:
          type: string
      - name: size
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: sb
        in: query
        required: false
        schema:
          type: string
          default: filename
      - name: so
        in: query
        required: false
        schema:
          type: string
          default: ASC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFilesDto'
            application/xml:
              schema:
                $ref: '#/components/schemas/DataFilesDto'
            text/xml:
              schema:
                $ref: '#/components/schemas/DataFilesDto'
            application/atom+xml;type=entry:
              schema:
                $ref: '#/components/schemas/DataFilesDto'
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/{id}/files/imageCount:
    get:
      tags:
      - Collection Data
      summary: Retrieve the number of image files contained within the collection
      operationId: getImageFilesCount
      parameters:
      - name: id
        in: path
        description: Collection identifier.  Can include version.  E.g. csiro:1234v2
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageFileCountDto'
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/{id}/downloadOptions:
    get:
      tags:
      - Collection Data
      operationId: getFileDownloadOptions
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadOptionsDto'
            application/xml:
              schema:
                $ref: '#/components/schemas/DownloadOptionsDto'
            text/xml:
              schema:
                $ref: '#/components/schemas/DownloadOptionsDto'
            application/atom+xml;type=entry:
              schema:
                $ref: '#/components/schemas/DownloadOptionsDto'
      summary: Get file download options
      x-summary-source: derived
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/{id}/data:
    get:
      tags:
      - Collection Data
      operationId: getCollectionDataFileList
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFilesDto'
            application/xml:
              schema:
                $ref: '#/components/schemas/DataFilesDto'
            application/atom+xml;type=entry:
              schema:
                $ref: '#/components/schemas/DataFilesDto'
      summary: Get collection data file list
      x-summary-source: derived
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/{id}/data/{fileId}:
    get:
      tags:
      - Collection Data
      operationId: getCollectionDataFile_1
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: fileId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
      summary: Get collection data file 1
      x-summary-source: derived
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/thumbnail/{adoId}/{size}:
    get:
      tags:
      - Collection Data
      summary: Retrieve a thumbnail for an image file by file id
      operationId: getThumbnailForFile
      parameters:
      - name: adoId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: size
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
  /ws/v2/collections/content/columns:
    get:
      tags:
      - Collection Data
      operationId: getFileColumns
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ColumnDto'
      summary: Get file columns
      x-summary-source: derived
    servers:
    - url: https://data.csiro.au/dap
      description: Generated server url
components:
  schemas:
    FileMetadataDto:
      type: object
      properties:
        name:
          type: string
        value: {}
        units:
          type: string
        dateValue:
          type: string
        stringValue:
          type: string
        numericValue:
          type: number
          format: float
      required:
      - name
    DownloadProtocolDTO:
      type: object
      properties:
        type:
          type: string
        description:
          type: string
        webDownload:
          type: boolean
    ImageFileCountDto:
      type: object
      properties:
        imageFileCount:
          type: integer
          format: int64
    ColumnDto:
      type: object
      properties:
        label:
          type: string
        key:
          type: string
        parameter:
          type: string
        type:
          type: string
          enum:
          - TEXT
          - SIZE
          - IMAGE
          - LINK
          - DIALOG
          - PROJECT_LINKS
        defaultOrder:
          type: integer
          format: int32
        tooltip:
          type: string
        sortable:
          type: boolean
      required:
      - key
      - label
      - parameter
      - sortable
      - tooltip
      - type
      xml:
        name: column
        namespace: urn:au:csiro:rds:dap:1.0
    DownloadOptionsDto:
      type: object
      properties:
        protocols:
          type: array
          items:
            $ref: '#/components/schemas/DownloadProtocolDTO'
    ServiceDto:
      type: object
      properties:
        title:
          type: string
          xml:
            name: Title
        type:
          type: string
          xml:
            name: Type
        url:
          type: string
          xml:
            name: URL
        parameters:
          type: object
          additionalProperties: {}
      required:
      - title
      - type
      - url
      xml:
        name: service
        namespace: urn:au:csiro:rds:dap:1.0
    LinkDto:
      type: object
      properties:
        relationship:
          type: string
          xml:
            name: rel
            attribute: true
        mediaType:
          type: string
          xml:
            name: type
            attribute: true
        href:
          type: string
          format: uri
          xml:
            attribute: true
        fileUpload:
          type: boolean
        fileId:
          type: integer
          format: int32
    FileDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        filename:
          type: string
        lastUpdated:
          type: string
        fileSize:
          type: integer
          format: int64
        link:
          $ref: '#/components/schemas/LinkDto'
        presignedLink:
          $ref: '#/components/schemas/LinkDto'
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/FileMetadataDto'
          xml:
            wrapped: true
        smallThumbnail:
          type: string
        mediumThumbnail:
          type: string
        largeThumbnail:
          type: string
        fullThumbnail:
          type: string
        zipDownloadable:
          type: boolean
      required:
      - filename
      - id
      - link
    DataFilesDto:
      type: object
      properties:
        id:
          type: string
        self:
          type: string
          format: uri
        licence:
          type: string
        licenceLink:
          $ref: '#/components/schemas/LinkDto'
          xml:
            name: link
        rights:
          type: string
        access:
          type: string
        file:
          type: array
          items:
            $ref: '#/components/schemas/FileDto'
          xml:
            name: files
            wrapped: true
        filesInFolder:
          type: integer
          format: int64
      required:
      - access
      - id
      - licence
      - licenceLink
      - rights
      - self
      xml:
        name: dataFiles
        namespace: urn:au:csiro:rds:dap:1.0
    ServiceResultDto:
      type: object
      properties:
        service:
          type: array
          items:
            $ref: '#/components/schemas/ServiceDto'
      xml:
        name: serviceResult
        namespace: urn:au:csiro:rds:dap:1.0
    FolderDto:
      type: object
      properties:
        name:
          type: string
        fileCount:
          type: integer
          format: int64
        totalSize:
          type: integer
          format: int64
        folders:
          type: array
          items:
            $ref: '#/components/schemas/FolderDto'
          uniqueItems: true
      required:
      - fileCount
      - folders
      - name
      - totalSize
      xml:
        name: folder
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/0fe05593-19ac-4f98-adbf-0375fce7f160/oauth2/v2.0/authorize
          tokenUrl: /dap/auth/csiro/token
          scopes:
            openid: OpenID Connect
x-refined-from:
- csiro-dap-ws-v2-openapi.json
- csiro-dap-ws-v2-openapi.yml

CSIRO Collection Data API

Operations 11

Documentation

Specifications

Schemas & Data

Other Resources