Figshare · Schema

PrivateFile

Figshare PrivateFile schema

Research DataData RepositoryOpen ScienceDOIDatasetsAcademicFile StorageOpen Access

Properties

Name Type Description
viewer_type string File viewer type
preview_state string File preview state
upload_url string Upload url for file
upload_token string Token for file upload
is_attached_to_public_version boolean True if the file is attached to a public item version
View JSON Schema on GitHub

JSON Schema

figshare-privatefile-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PrivateFile",
  "description": "Figshare PrivateFile schema",
  "required": [
    "is_attached_to_public_version",
    "preview_state",
    "upload_token",
    "upload_url",
    "viewer_type"
  ],
  "properties": {
    "viewer_type": {
      "type": "string",
      "description": "File viewer type"
    },
    "preview_state": {
      "type": "string",
      "description": "File preview state",
      "example": "preview not available"
    },
    "upload_url": {
      "type": "string",
      "description": "Upload url for file",
      "format": "url",
      "example": "https://uploads.figshare.com"
    },
    "upload_token": {
      "type": "string",
      "description": "Token for file upload",
      "example": "9dfc5fe3-d617-4d93-ac11-8afe7e984a4b"
    },
    "is_attached_to_public_version": {
      "type": "boolean",
      "description": "True if the file is attached to a public item version",
      "example": true
    }
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/PublicFile"
    }
  ],
  "x-tag": "common"
}