Skip to main content

File

A file entity (MediaObject) with file-specific metadata.

idstring<uri>required

A URI-based identifier, used to reference the entity or file in the RO-Crate. This ensures global uniqueness and enables cross-linking of entities.

Possible values: Value must match regular expression ^https?:\/\/.+

Example: https://catalog.paradisec.org.au/repository/LRB/001
filenamestringrequired

The name of the file.

Possible values: non-empty and <= 255 characters

Example: recording.wav
mediaTypestringrequired

The MIME type of the file.

Possible values: <= 127 characters, Value must match regular expression ^[a-z]+/[a-z0-9\-\+\.]+$

Example: audio/wav
sizeinteger<int64>required

The size of the file in bytes.

Possible values: >= 0

Example: 1024
memberOfstring<uri>required

A URI-based identifier, used to reference the entity or file in the RO-Crate. This ensures global uniqueness and enables cross-linking of entities.

Possible values: Value must match regular expression ^https?:\/\/.+

Example: https://catalog.paradisec.org.au/repository/LRB/001
rootCollectionstring<uri>required

A URI-based identifier, used to reference the entity or file in the RO-Crate. This ensures global uniqueness and enables cross-linking of entities.

Possible values: Value must match regular expression ^https?:\/\/.+

Example: https://catalog.paradisec.org.au/repository/LRB/001
contentLicenseIdstring<uri>required

A URI-based identifier, used to reference the entity or file in the RO-Crate. This ensures global uniqueness and enables cross-linking of entities.

Possible values: Value must match regular expression ^https?:\/\/.+

Example: https://catalog.paradisec.org.au/repository/LRB/001
access objectrequired

Access information for this file, including content permissions and enrolment details.

contentbooleanrequired

Whether content is accessible to the current user.

contentAuthorizationUrlstring<uri>

URL for enrolment or authorisation process if content access is restricted.

File
{
  "id": "https://catalog.paradisec.org.au/repository/LRB/001",
  "filename": "recording.wav",
  "mediaType": "audio/wav",
  "size": 1024,
  "memberOf": "https://catalog.paradisec.org.au/repository/LRB/001",
  "rootCollection": "https://catalog.paradisec.org.au/repository/LRB/001",
  "contentLicenseId": "https://catalog.paradisec.org.au/repository/LRB/001",
  "access": {
    "content": true
  }
}