Skip to main content

Entity

An entity represents a single collection or item within the repository, conforming to a specific RO-Crate profile.

idstring<uri>required

RO-Crate ID that uniquely identifies this entity.

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

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

Name of the entity.

Possible values: non-empty and <= 255 characters

Example: Recordings of West Alor languages
descriptionstring

A concise description of the entity’s contents or purpose.

Possible values: non-empty and <= 1000 characters

Example: A compilation of recordings featuring various West Alor languages, curated for linguistic research.
entityTypeEntityType (string)required

An enumerated type describing the nature of the entity, such as a collection, object, or media object

Possible values: [http://pcdm.org/models#Collection, http://pcdm.org/models#Object, http://schema.org/MediaObject, http://schema.org/Person]

Example: http://pcdm.org/models#Collection
memberOfstring<uri>required

An optional parent entity that this entity belongs to.

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

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

The top-level collection this entity is part of.

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

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

The metadata license.

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

Example: https://catalog.paradisec.org.au/licenses/metadata
contentLicenseIdstring<uri>required

The content license.

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

Example: https://catalog.paradisec.org.au/licenses/content
access objectrequired

Access information for this entity, including permissions and enrolment details.

metadatabooleanrequired

Whether metadata is accessible to the current user.

contentbooleanrequired

Whether content is accessible to the current user.

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.

fileIdstring<uri>

The file ID to use with /files endpoints. Only present for MediaObject entities. Implementations may use any identifier they choose.

Example: https://catalog.paradisec.org.au/repository/LRB/001/recording.wav
Entity
{
  "id": "https://catalog.paradisec.org.au/repository/LRB/001",
  "name": "Recordings of West Alor languages",
  "description": "A compilation of recordings featuring various West Alor languages, curated for linguistic research.",
  "entityType": "http://pcdm.org/models#Collection",
  "memberOf": "https://catalog.paradisec.org.au/repository/LRB",
  "rootCollection": "https://catalog.paradisec.org.au/repository/LRB",
  "metadataLicenseId": "https://catalog.paradisec.org.au/licenses/metadata",
  "contentLicenseId": "https://catalog.paradisec.org.au/licenses/content",
  "access": {
    "metadata": true,
    "content": false,
    "contentAuthorizationUrl": "https://test.cadre.example.com/catalogue/application?id=https%3A%2F%2Fhttps%3A%2F%2Fcatalog.paradisec.org.au%2Flicenses%2Ftest"
  },
  "fileId": "https://catalog.paradisec.org.au/repository/LRB/001/recording.wav"
}