Skip to main content

File

A file with file-specific metadata. For files that are also represented as MediaObject entities in the RO-Crate, the file id and the MediaObject entity id are identical.

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.

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

The name of the file.

Possible values: non-empty and <= 255 characters

Example: NT1-001-001A.mp3
mediaTypestringrequired

The MIME type of the file.

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

Example: audio/mpeg
sizeinteger<int64>required

The size of the file in bytes.

Possible values: >= 0

Example: 1024
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/NT1/001",
"filename": "NT1-001-001A.mp3",
"mediaType": "audio/mpeg",
"size": 1024,
"access": {
"content": true
}
}