Skip to main content

RoCrate

An RO-Crate is the unit of deposit: a metadata document plus all the files it references, stored as deposited.

Catalog entities are materialised from RO-Crates by implementation-specific rules — one RO-Crate may yield one entity or many, and several RO-Crates may contribute to a single merged entity. The deposited metadata document (GET /ro-crate/{id}/metadata) is the single source of truth for the RO-Crate's content inventory; the RO-Crate carries no file list of its own.

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
entityIdsstring<uri>[]required

The entities materialised from this RO-Crate's current version — the inverse of the entity's roCrateIds. Can change when later deposits (of this or other RO-Crates) alter the materialisation.

Example: ["https://catalog.paradisec.org.au/repository/NT1/001","https://catalog.paradisec.org.au/repository/NT1/001/NT1-001-001A.mp3"]
createdAtstring<date-time>required

When the RO-Crate was first created (its first successful finalise).

lastDepositedAtstring<date-time>required

When the RO-Crate's current version was published (its most recent successful finalise).

access objectrequired

Access information for this RO-Crate. metadata governs GET /ro-crate/{id}; content governs the deposited metadata document (GET /ro-crate/{id}/metadata). Files are governed by each File's own access.

metadatabooleanrequired

Whether this RO-Crate resource is accessible to the current user.

contentbooleanrequired

Whether the deposited metadata document is accessible to the current user. The document holds the metadata of every entity materialised from the RO-Crate, so this SHOULD be true only if the current user has metadata access to all of them.

metadataAuthorizationUrlstring<uri>

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

contentAuthorizationUrlstring<uri>

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

RoCrate
{
"id": "https://catalog.paradisec.org.au/repository/NT1/001",
"entityIds": [
"https://catalog.paradisec.org.au/repository/NT1/001",
"https://catalog.paradisec.org.au/repository/NT1/001/NT1-001-001A.mp3"
],
"createdAt": "2024-07-29T15:51:28.071Z",
"lastDepositedAt": "2024-07-29T15:51:28.071Z",
"access": {
"metadata": true,
"content": true
}
}