Dataverse DataFile

A data file within a dataset as represented by the University of Chile Dataverse API. Properties reflect the DataFile schema published in the deployment's live OpenAPI document (Dataverse 5.13).

EducationHigher EducationUniversityResearch DataOpen DataRepositoryOAI-PMHDataverseChile

Properties

Name Type Description
id number Internal numeric identifier of the file.
contentType string MIME content type of the file.
filesize number Size of the file in bytes.
checksumType string Checksum algorithm (e.g. MD5, SHA-1).
checksumValue string Checksum value for integrity verification.
restricted boolean Whether the file is access-restricted.
deleted boolean Whether the file is marked deleted.
markedAsDuplicate boolean Whether the file is flagged as a duplicate.
duplicateFilename string Filename of the duplicate, if any.
rootDataFileId number Root data file id for replaced files.
previousDataFileId number Previous data file id for replaced files.
storageIdentifier string Storage location identifier.
identifier string Persistent identifier suffix for the file, if minted.
protocol string Persistent identifier protocol.
authority string Persistent identifier authority.
identifierRegistered boolean Whether the file global ID is registered.
previewImageAvailable boolean Whether a preview image is available.
publicationDate string Publication date of the file.
createDate string Creation date of the file record.
dataTables array Tabular data tables ingested from the file.
fileMetadatas array Per-version file metadata records.
View JSON Schema on GitHub

JSON Schema

university-of-chile-datafile-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/university-of-chile/main/json-schema/university-of-chile-datafile-schema.json",
  "title": "Dataverse DataFile",
  "description": "A data file within a dataset as represented by the University of Chile Dataverse API. Properties reflect the DataFile schema published in the deployment's live OpenAPI document (Dataverse 5.13).",
  "type": "object",
  "properties": {
    "id": { "type": "number", "description": "Internal numeric identifier of the file." },
    "contentType": { "type": "string", "description": "MIME content type of the file." },
    "filesize": { "type": "number", "description": "Size of the file in bytes." },
    "checksumType": { "type": "string", "description": "Checksum algorithm (e.g. MD5, SHA-1)." },
    "checksumValue": { "type": "string", "description": "Checksum value for integrity verification." },
    "restricted": { "type": "boolean", "description": "Whether the file is access-restricted." },
    "deleted": { "type": "boolean", "description": "Whether the file is marked deleted." },
    "markedAsDuplicate": { "type": "boolean", "description": "Whether the file is flagged as a duplicate." },
    "duplicateFilename": { "type": "string", "description": "Filename of the duplicate, if any." },
    "rootDataFileId": { "type": "number", "description": "Root data file id for replaced files." },
    "previousDataFileId": { "type": "number", "description": "Previous data file id for replaced files." },
    "storageIdentifier": { "type": "string", "description": "Storage location identifier." },
    "identifier": { "type": "string", "description": "Persistent identifier suffix for the file, if minted." },
    "protocol": { "type": "string", "description": "Persistent identifier protocol." },
    "authority": { "type": "string", "description": "Persistent identifier authority." },
    "identifierRegistered": { "type": "boolean", "description": "Whether the file global ID is registered." },
    "previewImageAvailable": { "type": "boolean", "description": "Whether a preview image is available." },
    "publicationDate": { "type": "string", "format": "date-time", "description": "Publication date of the file." },
    "createDate": { "type": "string", "format": "date-time", "description": "Creation date of the file record." },
    "dataTables": { "type": "array", "description": "Tabular data tables ingested from the file.", "items": { "type": "object" } },
    "fileMetadatas": { "type": "array", "description": "Per-version file metadata records.", "items": { "type": "object" } }
  },
  "additionalProperties": true
}