Skip to main content

Entity

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

For MediaObject entities, the entity id is also the file identifier. Use it directly with the /file/{id} and /files endpoints to access or list the corresponding file.

idstring<uri>required

RO-Crate ID that uniquely identifies this entity.

Example: https://catalog.paradisec.org.au/repository/NT1/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.
entityTypestring<uri>required

A URI identifying the nature of the entity. Implementers may use any valid URI as an entity type. The following core types have specific API behaviour: http://pcdm.org/models#Collection (collections), http://pcdm.org/models#Object (objects), http://schema.org/MediaObject (media objects), and http://schema.org/Person (people).

Example: http://pcdm.org/models#Collection
Examples:
Example: http://pcdm.org/models#Collection
memberOf object

An optional parent entity that this entity belongs to.

oneOf

A resolved reference to an entity, containing its ID and name.

idstring<uri>required
namestringrequired
rootCollection object

The top-level collection this entity is part of.

oneOf

A resolved reference to an entity, containing its ID and name.

idstring<uri>required
namestringrequired
metadataLicenseIdstring<uri>required

The metadata license.

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

The content license.

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.

roCrateIdsstring<uri>[]

Optional core — present only when deposit.supported is true.

The RO-Crates whose current versions contribute to this entity. Usually one; more when the implementation's materialisation merges contributions from several RO-Crates into a single entity. An entity MAY be removed once no RO-Crate contributes to it.

Example: ["https://catalog.paradisec.org.au/repository/NT1/001"]
Entity
{
  "id": "https://catalog.paradisec.org.au/repository/NT1/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": {
    "id": "string",
    "name": "string"
  },
  "rootCollection": {
    "id": "string",
    "name": "string"
  },
  "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"
  },
  "roCrateIds": [
    "https://catalog.paradisec.org.au/repository/NT1/001"
  ]
}