Expand description
§Research activity identifier (RAiD) metadata schema
See https://metadata.raid.org/en/v1.6/index.html for official documentation on schema.
Use ACORN to generate JSON schema for RAiD metadata with acorn schema --raid
Structs§
- Access
- Metadata schema block containing RAiD access information
- Access
Builder - Use builder syntax to set the inputs and finish with
build()
. - Access
Identifier - Access type identifier
- Access
Identifier Builder - Use builder syntax to set the inputs and finish with
build()
. - Access
Statement - Metadata schema block containing an explanation for any access type that is not “open”, with the explanation’s associated properties
- Access
Statement Builder - Use builder syntax to set the inputs and finish with
build()
. - Alternate
Identifier - Metadata schema block containing alternative local or global identifiers for the project or activity associated with the RAiD
- Alternate
Identifier Builder - Use builder syntax to set the inputs and finish with
build()
. - Alternate
Url - Link to another website related to the project or activity
- Alternate
UrlBuilder - Use builder syntax to set the inputs and finish with
build()
. - Contributor
- Metadata schema block containing a contributor to a RAiD and their associated properties
- Contributor
Builder - Use builder syntax to set the inputs and finish with
build()
. - Contributor
Position - Metadata schema sub-block describing a contributor’s administrative position on a project or activity
- Contributor
Position Builder - Use builder syntax to set the inputs and finish with
build()
. - Date
- Start and end dates for the associated metadata
- Date
Builder - Use builder syntax to set the inputs and finish with
build()
. - Description
- Metadata schema block containing the description of the RAiD and associated properties
- Description
Builder - Use builder syntax to set the inputs and finish with
build()
. - Description
Identifier - Metadata schema block declaring the type of description
- Identifier
- Metadata schema block containing information about the associated type
- Identifier
Builder - Use builder syntax to set the inputs and finish with
build()
. - Language
- Metadata schema block declaring the language of the associated text
- Language
Builder - Use builder syntax to set the inputs and finish with
build()
. - Metadata
- Research Activity Identifier (RAiD) Metadata
- Metadata
Builder - Use builder syntax to set the inputs and finish with
build()
. - Metadata
Identifier - Metadata schema block containing the RAiD name and associated properties
- Metadata
Identifier Builder - Use builder syntax to set the inputs and finish with
build()
. - Organization
- Metadata schema block containing the organization associated with a RAiD and its associated properties
- Organization
Role - Organization role
- Owner
- Metadata schema sub-block that declares the owner of the RAiD (i.e. the organization requesting the RAiD)
- Owner
Builder - Use builder syntax to set the inputs and finish with
build()
. - Registration
Agency - Metadata schema block containing the RAiD name and associated properties
- Registration
Agency Builder - Use builder syntax to set the inputs and finish with
build()
. - Related
Object - Metadata schema block containing inputs, outputs, and process documents related to a RAiD plus associated properties
- Related
Object Builder - Use builder syntax to set the inputs and finish with
build()
. - Related
Object Category - Related object category information
- Related
Object Category Builder - Use builder syntax to set the inputs and finish with
build()
. - Related
Object Identifier - Related object identifier
- Related
Object Identifier Builder - Use builder syntax to set the inputs and finish with
build()
. - Related
Raid - Metadata schema block containing related RAiDs and qualifying the relationship
- Related
Raid Builder - Use builder syntax to set the inputs and finish with
build()
. - Related
Raid Identifier - Related RAiD identifier
- Related
Raid Identifier Builder - Use builder syntax to set the inputs and finish with
build()
. - Role
- Metadata schema sub-block describing a contributor’s scientific or scholarly role on a project using the CRediT vocabulary
- Role
Builder - Use builder syntax to set the inputs and finish with
build()
. - Title
- Metadata schema block containing the title of RAiD and associated properties
- Title
Builder - Use builder syntax to set the inputs and finish with
build()
. - Title
Identifier - Metadata schema block containing information about the title type
Enums§
- Access
Type - Allowed values for access types
- Credit
Role - CRediT role
- Description
Type - Description types
- Flag
- Flag indicating that a value is affirmative (e.g., for
leader
orcontact
) - Object
Category Type - Category of input, output, or process document
- Object
Type - Type of input, output, or process document
- Organization
Role Type - Organization role identifier
- Position
Type - Represents a contributor’s administrative position on a project (such as their position on a grant application)
- Related
Raid Type - RAiD Relation Type
- Title
Type - Allowed values for title identifiers