University of British Columbia · Example Payload

Ubc Search Datasets Example

Representative response from the Dataverse Search API (GET /api/search?q=*&type=dataset) on the UBC Abacus repository. Field shape follows the Dataverse 5.9 search response envelope.

EducationHigher EducationUniversityPublic Research UniversityCanadaBritish ColumbiaU15LibraryDigital CollectionsResearch DataResearch RepositoryOpen DataIdentity FederationOAI-PMHIIIFDataverse

Ubc Search Datasets Example is an example object payload from University of British Columbia, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

x-provenancedescriptionstatusdata

Example Payload

{
  "x-provenance": {
    "generated": "2026-08-19",
    "method": "generated",
    "source": "REPRESENTATIVE, NOT CAPTURED. Hand-shaped to the Dataverse 5.9 search envelope; not a recorded response from https://abacus.library.ubc.ca. Treat the values (including total_count) as illustrative.",
    "x-operator": "institution"
  },
  "description": "Representative response from the Dataverse Search API (GET /api/search?q=*&type=dataset) on the UBC Abacus repository. Field shape follows the Dataverse 5.9 search response envelope.",
  "status": "OK",
  "data": {
    "q": "*",
    "total_count": 1240,
    "start": 0,
    "spelling_alternatives": {},
    "items": [
      {
        "name": "UBC Open Data Sample Survey",
        "type": "dataset",
        "url": "https://abacus.library.ubc.ca/dataset.xhtml?persistentId=doi:10.5683/SP3/EXAMPLE",
        "global_id": "doi:10.5683/SP3/EXAMPLE",
        "description": "Sample dataset describing the structure of a published record in Abacus.",
        "published_at": "2025-04-12T00:00:00Z",
        "publisher": "Abacus Dataverse Network",
        "citationHtml": "Example Author, 2025, \"UBC Open Data Sample Survey\", https://doi.org/10.5683/SP3/EXAMPLE, Abacus Dataverse Network, V1",
        "versionId": 90210,
        "versionState": "RELEASED",
        "majorVersion": 1,
        "minorVersion": 0,
        "fileCount": 3
      }
    ],
    "count_in_response": 1
  }
}