12 access

Definition: a metadata schema block containing RAiD access information

Requirement: mandatory

Occurrence: 1

Example JSON

{
  "access": {
    "type": {
      "id": "https://vocabularies.coar-repositories.org/access_rights/c_f1cf/",
      "schemaUri": "https://vocabularies.coar-repositories.org/access_rights/"
    },
    "embargoExpiry": "2027-06-30",
    "statement": {
      "text": "Metadata for this record is embargoed until the primary data custodian approves release of the linked data collection.",
      "language": {
        "id": "eng",
        "schemaUri": "https://www.iso.org/standard/74575.html"
      }
    }
  }
}

12.1 access.type

Definition: a metadata schema sub-block containing RAiD access type information

Requirement: mandatory

Occurrence: 1

Example JSON

{
  "type": {
    "id": "https://vocabularies.coar-repositories.org/access_rights/c_f1cf/",
    "schemaUri": "https://vocabularies.coar-repositories.org/access_rights/"
  }
}

12.1.1 access.type.id

Definition: the type of access granted to a RAiD metadata record

Requirement: mandatory

Occurrence: 1

Allowed values: closed controlled list derived from access.type.schemaUri, published at https://vocabulary.raid.org/access.type.id/scheme

https://vocabularies.coar-repositories.org/access_rights/c_abf2/ (Open access)
https://vocabularies.coar-repositories.org/access_rights/c_f1cf/ (Embargoed access)

Default: ‘Open access’

Constraints: ‘Restricted access’ and ‘Metadata only’, though part of the upstream vocabulary, are disallowed

12.1.2 access.type.schemaUri

Definition: the URI of the access type schema

Requirement: mandatory

Occurrence: 1

Allowed values: closed controlled list defined at https://vocabulary.raid.org/access.type.schemaUri/scheme

https://vocabularies.coar-repositories.org/access_rights/

Default: https://vocabularies.coar-repositories.org/access_rights/, the only value in this closed controlled list

Note: The RAiD controlled list includes only a subset of the COAR vocabulary (https://vocabularies.coar-repositories.org/access_rights/1.1/), including ‘Open access’ and ‘Embargoed access’, but excluding ‘Restricted access’ (since no permanently restricted RAiDs are allowed), and ‘Metadata only’ (since RAiDs by design contain only metadata).

12.2 access.embargoExpiry

Definition: the date any embargo on access to the RAiD metadata ends

Requirement: mandatory if access.type is ‘Embargoed access’

Occurrence: 0-1

Allowed values: ISO 8601 standard date

Format: YYYY-MM-DD

Constraints: an embargo expiration date must be within 18 months of the date the RAiD was registered; the year, month, and day that the embargo ends must be specified

Example(s): 2021-08-28

12.3 access.statement

Definition: a metadata schema sub-block containing an explanation of why the RAiD metadata record is not openly accessible, along with the explanation’s associated properties

Requirement: mandatory if access.type.id is not ‘Open access’

Occurrence: 0-1

Example JSON

{
  "statement": {
    "text": "Metadata for this record is embargoed until the primary data custodian approves release of the linked data collection.",
    "language": {
      "id": "eng",
      "schemaUri": "https://www.iso.org/standard/74575.html"
    }
  }
}

12.3.1 access.statement.text

Definition: the text of an access statement that explains any restrictions on access

Requirement: mandatory if access.type.id is not ‘Open access’

Occurrence: 0-1

Allowed values: free text

Constraints: maximum 1,000 characters

12.3.2 access.statement.language

Definition: a metadata schema sub-block declaring the language of the text in the access statement

Requirement: recommended

Occurrence: 0-1

Example JSON

{
  "language": {
    "id": "eng",
    "schemaUri": "https://www.iso.org/standard/74575.html"
  }
}

12.3.2.1 access.statement.language.id

Definition: the language used for the access statement text, identified by a code or other identifier

Requirement: mandatory for each access.statement.language supplied

Occurrence: 1

Allowed values: closed controlled list derived from access.statement.language.schemaUri

Example(s): eng

Note: Individual codes are not listed here, unlike other closed lists in this schema, because ISO 639:2023 (Set 3) contains several thousand language codes. Browse the full list at https://iso639-3.sil.org/code_tables/639/data.

12.3.2.2 access.statement.language.schemaUri

Definition: the URI of the language identifier schema

Requirement: mandatory for each access.statement.language supplied

Occurrence: 1

Allowed values: closed controlled list of allowed language schemas defined at https://vocabulary.raid.org/access.statement.language.schemaUri/196

https://www.iso.org/standard/74575.html (ISO 639:2023 Code for individual languages and language groups (Set 3))

Default: https://www.iso.org/standard/74575.html, the only value in this closed controlled list

Constraints: currently limited to ISO 639:2023 (Set 3)