University of Canterbury · JSON Structure

University Of Canterbury Article Structure

JSON Structure for a figshare Article as exposed by the figshare REST API backing the Canterbury Figshare instance.

Type: object Properties: 16 Required: 6

EducationHigher EducationUniversityResearchOpen DataRepositoryOAI-PMHNew Zealand

FigshareArticle is a JSON Structure definition published by University of Canterbury, describing 16 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id title doi handle url url_public_html url_public_api url_private_html url_private_api thumb defined_type defined_type_name resource_doi resource_title created_date timeline

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/university-of-canterbury/main/json-structure/university-of-canterbury-article-structure.json",
  "name": "FigshareArticle",
  "description": "JSON Structure for a figshare Article as exposed by the figshare REST API backing the Canterbury Figshare instance.",
  "type": "object",
  "properties": {
    "id": { "type": "int64", "description": "Unique identifier for article" },
    "title": { "type": "string", "description": "Title of article" },
    "doi": { "type": "string", "description": "DOI" },
    "handle": { "type": "string", "description": "Handle" },
    "url": { "type": "uri", "description": "Api endpoint for article" },
    "url_public_html": { "type": "uri", "description": "Public site endpoint" },
    "url_public_api": { "type": "uri", "description": "Public Api endpoint" },
    "url_private_html": { "type": "uri", "description": "Private site endpoint" },
    "url_private_api": { "type": "uri", "description": "Private Api endpoint" },
    "thumb": { "type": "uri", "description": "Thumbnail image" },
    "defined_type": { "type": "int32", "description": "Type of article identifier" },
    "defined_type_name": { "type": "string", "description": "Name of the article type identifier" },
    "resource_doi": { "type": "string", "description": "Publisher article DOI" },
    "resource_title": { "type": "string", "description": "Publisher article title" },
    "created_date": { "type": "string", "description": "Date when article was created (RFC3339)" },
    "timeline": {
      "type": "object",
      "description": "Publishing timeline dates",
      "properties": {
        "posted": { "type": "string" },
        "submission": { "type": "string" },
        "revision": { "type": "string" },
        "firstOnline": { "type": "string" },
        "publisherPublication": { "type": "string" },
        "publisherAcceptance": { "type": "string" }
      }
    }
  },
  "required": ["id", "title", "doi", "handle", "url", "created_date"]
}