base¶
Base schema from which community specific schemas are built.
Type: object¶
⚠️ Additional properties are not allowed.
Property |
Type |
Required |
Possible values |
Default |
Description |
|---|---|---|---|---|---|
custom_fields |
|
✅ |
object |
Block for custom data. |
|
custom_fields.dsmd |
|
✅ |
object |
Domain specific metadata (dsmd). |
|
metadata |
|
✅ |
object |
Resource metadata. |
|
metadata.title |
|
✅ |
string |
Title of resource. |
|
metadata.description |
|
✅ |
string |
Summary of resource. |
|
metadata.creators |
|
✅ |
object |
List of creators. |
|
metadata.creators[].affiliations |
|
object |
Member affiliations. |
||
metadata.creators[].affiliations[].name |
|
✅ |
string |
Name of institution. |
|
metadata.creators[].person_or_org |
|
✅ |
object |
Person or organisation. |
|
metadata.creators[].person_or_org.name |
|
string |
Full set of given names. |
||
metadata.creators[].person_or_org.family_name |
|
string |
Family name(s). |
||
metadata.creators[].person_or_org.given_name |
|
string |
Given name(s). |
||
metadata.creators[].person_or_org.identifiers |
|
object and/or object |
ORCIDs or other IDs |
||
metadata.creators[].person_or_org.type |
|
✅ |
|
Personal or organisation. |
|
metadata.rights |
|
✅ |
object |
Rights or license. |
|
metadata.rights[].id |
|
✅ |
|
ID of rights or license. |
|
metadata.resource_type |
|
✅ |
object |
Type of resource. |
|
metadata.resource_type.id |
|
✅ |
|
Resource class. |
|
metadata.subjects |
|
object |
|
List of keywords defining subjects resource covers. |
|
metadata.subjects[].subject |
|
✅ |
string |
Subject keyword. |
|
metadata.version |
|
✅ |
Current version of resource. |
||
metadata.publisher |
|
string |
Publisher of resource. |
||
metadata.publication_date |
|
None |
Date of publication of resource. |
||
metadata.identifiers |
|
object and/or object |
Resource identifiers such as ORCID or DOI. |
||
access |
|
object |
|
Accessibility of data outside of owners. |
|
access.embargo |
|
object |
Details of resource embargo. |
||
access.embargo.active |
|
✅ |
boolean |
Whether resource is under embargo. |
|
access.embargo.reason |
|
✅ |
string |
Cause for embargo. |
|
access.files |
|
|
|
Accessibility to individual files. |
|
access.record |
|
|
|
Accessibility to record as a whole. |
|
access.status |
|
|
Current status or resource. |
||
files |
|
object |
Details of files. |
||
files.enabled |
|
✅ |
boolean |
Whether file is enabled. |
|
community |
|
UUID of community associated with resource. |