La Trobe University · JSON Structure

La Trobe University Article Structure

JSON Structure description of a La Trobe OPAL (Open @ La Trobe) article as returned by the Figshare REST API GET /articles/{article_id}. Institution-scoped to La Trobe (institution id 234).

Type: object Properties: 32 Required: 10

EducationHigher EducationUniversityAustraliaResearchOpen DataRepositoryLibrary

LaTrobeOpalArticle is a JSON Structure definition published by La Trobe University, describing 32 properties, of which 10 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id title doi handle url url_public_html figshare_url thumb description citation defined_type defined_type_name group_id size version status is_public is_embargoed is_confidential is_metadata_record created_date modified_date published_date tags keywords references license timeline authors categories custom_fields files

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/la-trobe-university/main/json-structure/la-trobe-university-article-structure.json",
  "name": "LaTrobeOpalArticle",
  "type": "object",
  "description": "JSON Structure description of a La Trobe OPAL (Open @ La Trobe) article as returned by the Figshare REST API GET /articles/{article_id}. Institution-scoped to La Trobe (institution id 234).",
  "properties": {
    "id": { "type": "int64", "description": "Unique article identifier." },
    "title": { "type": "string", "description": "Article title." },
    "doi": { "type": "string", "description": "DOI (La Trobe prefix 10.26181)." },
    "handle": { "type": "string", "description": "Persistent handle (may be empty)." },
    "url": { "type": "uri", "description": "API endpoint for the article." },
    "url_public_html": { "type": "uri", "description": "Public landing page on opal.latrobe.edu.au." },
    "figshare_url": { "type": "uri" },
    "thumb": { "type": "string" },
    "description": { "type": "string", "description": "Abstract / description (HTML)." },
    "citation": { "type": "string" },
    "defined_type": { "type": "int32", "description": "Numeric item type code." },
    "defined_type_name": { "type": "string", "description": "Item type name (thesis, dataset, etc.)." },
    "group_id": { "type": "int64" },
    "size": { "type": "int64", "description": "Total file size in bytes." },
    "version": { "type": "int32" },
    "status": { "type": "string" },
    "is_public": { "type": "boolean" },
    "is_embargoed": { "type": "boolean" },
    "is_confidential": { "type": "boolean" },
    "is_metadata_record": { "type": "boolean" },
    "created_date": { "type": "datetime" },
    "modified_date": { "type": "datetime" },
    "published_date": { "type": "datetime" },
    "tags": { "type": "array", "items": { "type": "string" } },
    "keywords": { "type": "array", "items": { "type": "string" } },
    "references": { "type": "array", "items": { "type": "string" } },
    "license": {
      "type": "object",
      "properties": {
        "value": { "type": "int32" },
        "name": { "type": "string" },
        "url": { "type": "uri" }
      }
    },
    "timeline": {
      "type": "object",
      "properties": {
        "posted": { "type": "string" },
        "firstOnline": { "type": "string" },
        "publisherPublication": { "type": "string" }
      }
    },
    "authors": {
      "type": "array",
      "items": {
        "type": "object",
        "name": "Author",
        "properties": {
          "id": { "type": "int64" },
          "full_name": { "type": "string" },
          "first_name": { "type": "string" },
          "last_name": { "type": "string" },
          "is_active": { "type": "boolean" },
          "url_name": { "type": "string" },
          "orcid_id": { "type": "string" }
        }
      }
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "name": "Category",
        "properties": {
          "id": { "type": "int32" },
          "parent_id": { "type": "int32" },
          "title": { "type": "string" },
          "path": { "type": "string" },
          "source_id": { "type": "string" },
          "taxonomy_id": { "type": "int32" }
        }
      }
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "name": "CustomField",
        "properties": {
          "name": { "type": "string" },
          "value": { "type": "any" },
          "field_type": { "type": "string" },
          "is_mandatory": { "type": "boolean" }
        }
      }
    },
    "files": {
      "type": "array",
      "items": {
        "type": "object",
        "name": "PublicFile",
        "properties": {
          "id": { "type": "int64" },
          "name": { "type": "string" },
          "size": { "type": "int64" },
          "is_link_only": { "type": "boolean" },
          "download_url": { "type": "uri" },
          "supplied_md5": { "type": "string" },
          "computed_md5": { "type": "string" },
          "mimetype": { "type": "string" }
        }
      }
    }
  },
  "required": [
    "id",
    "title",
    "doi",
    "url",
    "defined_type",
    "defined_type_name",
    "published_date",
    "timeline",
    "authors",
    "files"
  ]
}