Figshare · Schema

CollectionComplete

Figshare CollectionComplete schema

Research DataData RepositoryOpen ScienceDOIDatasetsAcademicFile StorageOpen Access

Properties

Name Type Description
funding array Full Collection funding information
resource_id string Collection resource id
resource_doi string Collection resource doi
resource_title string Collection resource title
resource_link string Collection resource link
resource_version integer Collection resource version
version integer Collection version
description string Collection description
categories array List of collection categories
references array List of collection references
related_materials array List of related materials; supersedes references and resource DOI/title.
tags array List of collection tags. Keywords can be used instead
keywords array List of collection keywords. Tags can be used instead
authors array List of collection authors
institution_id integer Collection institution
group_id integer Collection group
articles_count integer Number of articles in collection
public boolean True if collection is published
citation string Collection citation
custom_fields array Collection custom fields
modified_date string Date when collection was last modified
created_date string Date when collection was created
timeline object
View JSON Schema on GitHub

JSON Schema

figshare-collectioncomplete-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CollectionComplete",
  "description": "Figshare CollectionComplete schema",
  "required": [
    "articles_count",
    "authors",
    "categories",
    "citation",
    "created_date",
    "custom_fields",
    "description",
    "funding",
    "group_id",
    "institution_id",
    "keywords",
    "modified_date",
    "public",
    "references",
    "related_materials",
    "resource_doi",
    "resource_id",
    "resource_link",
    "resource_title",
    "resource_version",
    "tags",
    "timeline",
    "version"
  ],
  "properties": {
    "funding": {
      "type": "array",
      "description": "Full Collection funding information",
      "items": {
        "$ref": "#/components/schemas/FundingInformation"
      }
    },
    "resource_id": {
      "type": "string",
      "description": "Collection resource id",
      "example": ""
    },
    "resource_doi": {
      "type": "string",
      "description": "Collection resource doi",
      "example": "10.6084/m9.figshare.123"
    },
    "resource_title": {
      "type": "string",
      "description": "Collection resource title",
      "example": "test"
    },
    "resource_link": {
      "type": "string",
      "description": "Collection resource link",
      "example": "http://figshare.com"
    },
    "resource_version": {
      "type": "integer",
      "description": "Collection resource version",
      "example": 0
    },
    "version": {
      "type": "integer",
      "description": "Collection version",
      "example": 1
    },
    "description": {
      "type": "string",
      "description": "Collection description",
      "example": "description"
    },
    "categories": {
      "type": "array",
      "description": "List of collection categories",
      "items": {
        "$ref": "#/components/schemas/Category"
      }
    },
    "references": {
      "type": "array",
      "description": "List of collection references",
      "items": {
        "type": "string",
        "format": "url"
      }
    },
    "related_materials": {
      "type": "array",
      "description": "List of related materials; supersedes references and resource DOI/title.",
      "example": [
        {
          "id": 10432,
          "identifier": "10.6084/m9.figshare.1407024",
          "identifier_type": "DOI",
          "relation": "IsSupplementTo",
          "title": "Figshare for institutions brochure",
          "is_linkout": false
        }
      ],
      "items": {
        "$ref": "#/components/schemas/RelatedMaterial"
      }
    },
    "tags": {
      "type": "array",
      "description": "List of collection tags. Keywords can be used instead",
      "example": [
        "t1",
        "t2"
      ],
      "items": {
        "type": "string"
      }
    },
    "keywords": {
      "type": "array",
      "description": "List of collection keywords. Tags can be used instead",
      "example": [
        "t1",
        "t2"
      ],
      "items": {
        "type": "string"
      }
    },
    "authors": {
      "type": "array",
      "description": "List of collection authors",
      "items": {
        "$ref": "#/components/schemas/Author"
      }
    },
    "institution_id": {
      "type": "integer",
      "description": "Collection institution",
      "example": 1
    },
    "group_id": {
      "type": "integer",
      "description": "Collection group",
      "example": 1
    },
    "articles_count": {
      "type": "integer",
      "description": "Number of articles in collection",
      "example": 1
    },
    "public": {
      "type": "boolean",
      "description": "True if collection is published",
      "example": true
    },
    "citation": {
      "type": "string",
      "description": "Collection citation",
      "example": "citation"
    },
    "custom_fields": {
      "type": "array",
      "description": "Collection custom fields",
      "items": {
        "$ref": "#/components/schemas/CustomArticleField"
      }
    },
    "modified_date": {
      "type": "string",
      "description": "Date when collection was last modified",
      "example": "2017-05-15T15:12:26Z"
    },
    "created_date": {
      "type": "string",
      "description": "Date when collection was created",
      "example": "2017-05-15T15:12:26Z"
    },
    "timeline": {
      "$ref": "#/components/schemas/Timeline"
    }
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/Collection"
    }
  ],
  "x-tag": "collections"
}