University of Alberta · JSON Structure

University Of Alberta Search Item Structure

JSON Structure for a Borealis (Dataverse) Search API result item describing a University of Alberta dataset, dataverse, or file.

Type: object Properties: 25 Required: 3
EducationHigher EducationUniversityResearch DataOpen DataLibraryCanada

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

Properties

name type url global_id description published_at publisher citation identifier_of_dataverse name_of_dataverse publicationStatuses storageIdentifier keywords subjects fileCount versionId versionState majorVersion minorVersion createdAt updatedAt contacts producers geographicCoverage authors

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/university-of-alberta/main/json-structure/university-of-alberta-search-item-structure.json",
  "name": "BorealisSearchItem",
  "description": "JSON Structure for a Borealis (Dataverse) Search API result item describing a University of Alberta dataset, dataverse, or file.",
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "type": { "type": "string" },
    "url": { "type": "string" },
    "global_id": { "type": "string" },
    "description": { "type": "string" },
    "published_at": { "type": "string" },
    "publisher": { "type": "string" },
    "citation": { "type": "string" },
    "identifier_of_dataverse": { "type": "string" },
    "name_of_dataverse": { "type": "string" },
    "publicationStatuses": { "type": "array", "items": { "type": "string" } },
    "storageIdentifier": { "type": "string" },
    "keywords": { "type": "array", "items": { "type": "string" } },
    "subjects": { "type": "array", "items": { "type": "string" } },
    "fileCount": { "type": "int32" },
    "versionId": { "type": "int32" },
    "versionState": { "type": "string" },
    "majorVersion": { "type": "int32" },
    "minorVersion": { "type": "int32" },
    "createdAt": { "type": "string" },
    "updatedAt": { "type": "string" },
    "contacts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "affiliation": { "type": "string" }
        }
      }
    },
    "producers": { "type": "array", "items": { "type": "string" } },
    "geographicCoverage": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "country": { "type": "string" },
          "state": { "type": "string" },
          "city": { "type": "string" }
        }
      }
    },
    "authors": { "type": "array", "items": { "type": "string" } }
  },
  "required": ["name", "type", "url"]
}