Figshare · Schema

Collection

Figshare Collection schema

Research DataData RepositoryOpen ScienceDOIDatasetsAcademicFile StorageOpen Access

Properties

Name Type Description
id integer Collection id
title string Collection title
doi string Collection DOI
handle string Collection Handle
url string Api endpoint
timeline object
View JSON Schema on GitHub

JSON Schema

figshare-collection-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Collection",
  "description": "Figshare Collection schema",
  "required": [
    "doi",
    "handle",
    "id",
    "timeline",
    "title",
    "url"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Collection id",
      "example": 123
    },
    "title": {
      "type": "string",
      "description": "Collection title",
      "example": "Sample collection"
    },
    "doi": {
      "type": "string",
      "description": "Collection DOI",
      "example": "10.6084/m9.figshare.123"
    },
    "handle": {
      "type": "string",
      "description": "Collection Handle",
      "example": "111184/figshare.1234"
    },
    "url": {
      "type": "string",
      "description": "Api endpoint",
      "example": "https://api.figshare.com/v2/collections/123"
    },
    "timeline": {
      "$ref": "#/components/schemas/Timeline"
    }
  },
  "x-tag": "collections"
}