{ "modelVersion": "0.1", "title": "The JSON Schema for the NIST Extended Resource Data model (NERDm)", "description": [ "A JSON Schema specfying the core NERDm classes", "These classes extend the based NERDm schema to different types of published data" ], "generatedFrom": { "source": "etc/help/nerdm-view.json", "sourceFormat": "nerdm-view", "generator": "etc/help/nerdm-guide-pipeline/python/nerdm_pipeline/model.py", "notes": [ "Generated from the current NERDm schema view without changing production guide files.", "Required-field metadata is not present in nerdm-view.json and is therefore emitted as false in the generated model." ] }, "typeGroups": [ { "id": "Resource", "label": "Resource", "description": "Resource-level metadata types.", "anchor": "group-Resource" }, { "id": "Component", "label": "Component", "description": "Component-level metadata types for files, pages, tools, and related resource parts.", "anchor": "group-Component" }, { "id": "Other", "label": "Other", "description": "Supporting named types used by resource and component metadata.", "anchor": "group-Other" } ], "types": [ { "id": "Resource", "name": "Resource", "label": "Resource", "group": "Resource", "valueType": "object", "displayType": "object", "description": [ "a resource (e.g. data collection, service, website or tool) that can participate in a data-driven application.", "There are different types of Resources; this Named Type represents a generic resource. The other Resource types described later in this section add additional metadata to the base set shown here to describe more specific kinds of resources (like data publications, APIs, etc.)" ], "brief": "a resource (e.g. data collection, service, website or tool) that can participate in a data-driven application", "anchor": "Resource", "usage": [ { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "PublicDataResource" } } ], "inheritsFrom": [], "properties": [ { "id": "Resource.title", "name": "title", "label": "Title", "parentType": "Resource", "value": { "jsonType": "string", "display": "text" }, "description": [ "Human-readable, descriptive name of the resource" ], "brief": "Human-readable, descriptive name of the resource", "anchor": "Resource.title", "required": false, "inheritedFrom": null, "schemaNotes": [ "Acronyms should be avoided" ], "readerNotes": [], "examples": [ "\"The NIST High Temperature Superconducting Materials Database\"", "\"Organic Contaminants in Non-Fortified Human Milk\"" ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/0" } }, { "id": "Resource.version", "name": "version", "label": "Version", "parentType": "Resource", "value": { "jsonType": "string", "display": "text" }, "description": [ "a string indicating the version of the release of this resource" ], "brief": "a string indicating the version of the release of this resource", "anchor": "Resource.version", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [ "\"1.0.5\"", "\"11\"" ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/1" } }, { "id": "Resource.versionHistory", "name": "versionHistory", "label": "History", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of VersionRelease objects", "itemType": "VersionRelease" }, "description": [ "a list describing the release of different versions of this resource" ], "brief": "a list describing the release of different versions of this resource", "anchor": "Resource.versionHistory", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/2" } }, { "id": "Resource.replaces", "name": "replaces", "label": "Replaces", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of references to other resources" }, "description": [ "a listing of other existing resources that are deprecated by this resource" ], "brief": "a listing of other existing resources that are deprecated by this resource", "anchor": "Resource.replaces", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/3" } }, { "id": "Resource.isReplacedBy", "name": "isReplacedBy", "label": "Replaced by", "parentType": "Resource", "value": { "jsonType": "unknown", "display": "a reference to another resource" }, "description": [ "another existing resource that should be considered a replacement for this resource" ], "brief": "another existing resource that should be considered a replacement for this resource", "anchor": "Resource.isReplacedBy", "required": false, "inheritedFrom": null, "schemaNotes": [ "This typically refers to a newer version of this resource", "In the PDR system, this value is automatically generated given the overall state of the PDR's catalog" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/4" } }, { "id": "Resource.description", "name": "description", "label": "Description", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "Human-readable description (e.g., an abstract) of the resource" ], "brief": "Human-readable description (e.g., an abstract) of the resource", "anchor": "Resource.description", "required": false, "inheritedFrom": null, "schemaNotes": [ "Each element in the array should be considered a separate paragraph" ], "readerNotes": [ "Each list element should be considered as a separate paragraph." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/5" } }, { "id": "Resource.keyword", "name": "keyword", "label": "Tags", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users." ], "brief": "Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.", "anchor": "Resource.keyword", "required": false, "inheritedFrom": null, "schemaNotes": [ "Surround each keyword with quotes. Separate keywords with commas. Avoid duplicate keywords in the same record." ], "readerNotes": [ "Each value in the list represents a different keyword. Keywords can be made up of multiple words" ], "examples": [ "metals", "quantum mechanics" ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/6" } }, { "id": "Resource.topic", "name": "topic", "label": "topic", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "A tag or label taken from a pre-defined vocabulary for a thing or concept that this resource addresses or speaks to" ], "brief": "A tag or label taken from a pre-defined vocabulary for a thing or concept that this resource addresses or speaks to", "anchor": "Resource.topic", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/7" } }, { "id": "Resource.modified", "name": "modified", "label": "modified", "parentType": "Resource", "value": { "jsonType": "object", "display": "ISO8601DateRange object", "objectType": "ISO8601DateRange" }, "description": [ "Most recent date on which the dataset was changed, updated or modified." ], "brief": "Most recent date on which the dataset was changed, updated or modified.", "anchor": "Resource.modified", "required": false, "inheritedFrom": null, "schemaNotes": [ "Dates should be ISO 8601 of highest resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset. If there is a need to reflect that the dataset is continually updated, ISO 8601 formatting can account for this with repeating intervals. For instance, R/P1D for daily, R/P2W for every two weeks, and R/PT5M for every five minutes." ], "readerNotes": [ "The value is usually a single formated date, like 2017-04-21, or a data and time, like 2019-02-23T14:31:10.3", "A special format is used to indicate the resource is regularly update; e.g., R/P1W (for once a week); see ISO8601DateRange for details." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/8" } }, { "id": "Resource.issued", "name": "issued", "label": "Release Date", "parentType": "Resource", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "Date of formal issuance of the resource" ], "brief": "Date of formal issuance of the resource", "anchor": "Resource.issued", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [ "The value is usually a single formated date, like 2017-04-21" ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/9" } }, { "id": "Resource.publisher", "name": "publisher", "label": "publisher", "parentType": "Resource", "value": { "jsonType": "object", "display": "Organization object", "objectType": "Organization" }, "description": [ "The publishing entity and optionally their parent organization(s)." ], "brief": "The publishing entity and optionally their parent organization(s).", "anchor": "Resource.publisher", "required": false, "inheritedFrom": null, "schemaNotes": [ "This is a container for a publisher object which groups together the fields: name and subOrganization. The subOrganization field can also contain a publisher object which allows one to describe an organization's hierarchy. Where greater specificity is desired, include as many levels of publisher as is useful, in ascending order, using the below format." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/10" } }, { "id": "Resource.contactPoint", "name": "contactPoint", "label": "contactPoint", "parentType": "Resource", "value": { "jsonType": "object", "display": "ContactInfo object", "objectType": "ContactInfo" }, "description": [ "Contact information for getting more information about this resource" ], "brief": "Contact information for getting more information about this resource", "anchor": "Resource.contactPoint", "required": false, "inheritedFrom": null, "schemaNotes": [ "This should include at least a name and an email address", "The information can reflect either a person or a group (such as a help desk)" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/11" } }, { "id": "Resource.accessLevel", "name": "accessLevel", "label": "Public Access Level", "parentType": "Resource", "value": { "jsonType": "string", "display": "text" }, "description": [ "The degree to which this dataset could be made publicly-available, regardless of whether it has been made available" ], "brief": "The degree to which this dataset is publicly-available (or is restricted in some way)", "anchor": "Resource.accessLevel", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/12" }, "allowedValues": [ { "value": "public", "description": "Data asset is or could be made publicly available to all without restrictions" }, { "value": "restricted public", "description": "Data asset is available under certain use restrictions" }, { "value": "non-public", "description": "Data asset is not available to members of the public" } ] }, { "id": "Resource.license", "name": "license", "label": "License", "parentType": "Resource", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "A pointer to the primary license or non-license (i.e. Public Domain) statement with which the dataset or API has been published" ], "brief": "A pointer to the primary license or non-license (i.e. Public Domain) statement with which the dataset or API has been published", "anchor": "Resource.license", "required": false, "inheritedFrom": null, "schemaNotes": [ "Software and data developed primarily by federal employees must be considered in the public domain; software primarily developed by contract can be assigned a license, including an open source license.", "By default, NIST-produced data and software should point to http://www.nist.gov/data/license.cfm", "See Open Licenses (https://project-open-data.cio.gov/open-licenses/) for more information." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/13" } }, { "id": "Resource.rights", "name": "rights", "label": "Rights", "parentType": "Resource", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "information regarding access or restrictions based on privacy, security, or other policies" ], "brief": "information regarding access or restrictions based on privacy, security, or other policies", "anchor": "Resource.rights", "required": false, "inheritedFrom": null, "schemaNotes": [ "This should also provide an explanation for the selected \"accessLevel\" including instructions for how to access a restricted file, if applicable, or explanation for why a \"non-public\" or \"restricted public\" data assetis not \"public,\" if applicable.", "Text must be 255 or fewer characters." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/14" } }, { "id": "Resource.components", "name": "components", "label": "components", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of Component objects", "itemType": "Component" }, "description": [ "a listing of the various component resources, tools, and distributions of this resource. A component usually represents data that is part of this resource that be retrieved or a way to interact with the data." ], "brief": "a listing of the various component resources, tools, and distributions of this resource", "anchor": "Resource.components", "required": false, "inheritedFrom": null, "schemaNotes": [ "Records for the resources referenced in this list should specify this resource in its isPartOf field.", "The @type property will indicate which type of component it is. The first value in the @type list should be considered the primary or most important classification.", "If an item's @type includes dcat:Distribution, the item should be convertable to a distribution in the POD schema.", "The order should be considered meaningful (at least for components of the same type). The meaning or intention behind the order can depend on the type; however, generally, display of the components of a common type should preserve the order. For clarity then, it is recommended that items of the same primary type should be grouped together in the list." ], "readerNotes": [ "This list often includes the list of data files (represented as DataFile components) that are available to download.", "Data files can be organized into a hierarchy of subcollections (like file folders). When this is the case, this list will also include Subcollection components. Both DataFile and Subcollection components included a filepath that indicates where it is located in the hierarchy." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/15" } }, { "id": "Resource.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "Resource", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the resource conforms to" ], "brief": "URI used to identify a standardized specification the resource conforms to", "anchor": "Resource.conformsTo", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [ "This identifier might refer to a file or dataset format, to database schema, or to a web API." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/16" } }, { "id": "Resource.isPartOf", "name": "isPartOf", "label": "Collection", "parentType": "Resource", "value": { "jsonType": "object", "display": "ResourceReference object", "objectType": "ResourceReference" }, "description": [ "The collection of which the dataset is a subset" ], "brief": "The collection of which the dataset is a subset", "anchor": "Resource.isPartOf", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [ "The resource being referenced normally is one that is also described by a NERDm record which is accessible via its identifier (given in the proxyFor property)." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/17" } }, { "id": "Resource.language", "name": "language", "label": "Language", "parentType": "Resource", "value": { "jsonType": "array | null", "display": "list of text values", "itemType": "string" }, "description": [ "The primary language used in the dataset" ], "brief": "The primary language used in the dataset", "anchor": "Resource.language", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/18" } }, { "id": "Resource.landingPage", "name": "landingPage", "label": "Homepage URL", "parentType": "Resource", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "a URL to a human-friendly web page that represents the home or gateway to the resources that are part of this dataset. This page represents the definitive location for accessing the resource." ], "brief": "a URL to a human-friendly web page for accessing the resource.", "anchor": "Resource.landingPage", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/19" } }, { "id": "Resource.references", "name": "references", "label": "Related Documents", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of BibliographicReference objects", "itemType": "BibliographicReference" }, "description": [ "Related documents such as literature articles, technical reports about a dataset, developer documentation, etc. that refer to or describe this resource" ], "brief": "Other documents describing or relating to this resource", "anchor": "Resource.references", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/20" } }, { "id": "Resource.theme", "name": "theme", "label": "Category", "parentType": "Resource", "value": { "jsonType": "array | null", "display": "list of text values", "itemType": "string" }, "description": [ "Main thematic category of the dataset." ], "brief": "Main thematic category of the dataset.", "anchor": "Resource.theme", "required": false, "inheritedFrom": null, "schemaNotes": [ "Could include ISO Topic Categories (http://www.isotopicmaps.org/)" ], "readerNotes": [ "Values are taken from the Taxonomy of NIST Research Areas." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/21" } }, { "id": "Resource.@id", "name": "@id", "label": "@id", "parentType": "Resource", "value": { "jsonType": "string", "display": "text" }, "description": [ "The NIST-assigned unique identifier for the resource" ], "brief": "The NIST-assigned identifier for the resource", "anchor": "Resource.@id", "required": false, "inheritedFrom": null, "schemaNotes": [ "It is expected that this field will contain a type of identifier that is of a uniform type across all resource descriptions in the system", "This identifier should, by default, resolve to the metadata record (or some rendering of it) rather than to the resource itself (e.g. via its landing page)." ], "readerNotes": [ "This identifier takes a the form of a NIST-issued ARK identifier (and thus starts with ark:/88434/)", "If the resource has been assigned a DOI, it will appear in the doi" ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/22" } }, { "id": "Resource.doi", "name": "doi", "label": "doi", "parentType": "Resource", "value": { "jsonType": "string", "display": "text" }, "description": [ "A Digital Object Identifier (DOI) in non-resolving form." ], "brief": "The Digital Object Identifier (DOI)", "anchor": "Resource.doi", "required": false, "inheritedFrom": null, "schemaNotes": [ "The DOI value should not have the resolver URI base, but should have the form 'doi:NNNNN/XXXXXX'", "It is expected that this will primarily be Datacite DOIs" ], "readerNotes": [], "examples": [ "\"doi:10.18434/T42S31\"" ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/23" } }, { "id": "Resource.ediid", "name": "ediid", "label": "ediid", "parentType": "Resource", "value": { "jsonType": "string", "display": "text" }, "description": [ "the NIST EDI identifier assigned to the resource. This is the identifier assigned by the MIDAS system." ], "brief": "the NIST EDI identifier assigned to the resource", "anchor": "Resource.ediid", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/24" } }, { "id": "Resource.abbrev", "name": "abbrev", "label": "abbrev", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "An abbreviated form of the resource's title. This abbreviation can be used as a compact, human-readable reference to the resource." ], "brief": "an abbreviated form of the resource's title", "anchor": "Resource.abbrev", "required": false, "inheritedFrom": null, "schemaNotes": [ "this can be used as a label for a compact display or text for a link to this resource" ], "readerNotes": [], "examples": [ "\"SRD 13\"", "\"JRes-NIST\"" ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/25" } }, { "id": "Resource.@type", "name": "@type", "label": "@type", "parentType": "Resource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "The linked-data class types for this resource. The labels given in this list indicate the kind of thing is being described by metadata." ], "brief": "the linked-data class types for this resource", "anchor": "Resource.@type", "required": false, "inheritedFrom": null, "schemaNotes": [ "The value must always be given as an array, even when only one type is provided.", "Multiple values indicate that the Resource can be considered of multiple types", "If this resource is not to be considered a subtype of the nrd:Resource, its value should be 'nrd:Resource'." ], "readerNotes": [ "This property is a list because it is possible for a resource to be catorgorized as multiple types simultaneously", "The first value in the list will be the most specific resource type that applies to the resource and should be considered, therefore, its primary type.", "Often, the values refer to Named Types defined explicitly in the NERDm schema (e.g. DataPublication); in this case, the resource metadata can include the extended metadata properties for that type.", "Some values are just semantic labels that do not imply the existance of additional extended metadata.", "These values are intended to be compliant with use of @type property in the JSON-LD format." ], "examples": [ "\"nrdp:DataPublication\"", "\"nrdp:SRD\"", "\"dcat:Dataset\"" ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0/properties/26" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/0" } }, { "id": "PublicDataResource", "name": "PublicDataResource", "label": "PublicDataResource", "group": "Resource", "valueType": "object", "displayType": "object", "description": [ "a resource that can/should have a record in NIST's public data listing (PDL)" ], "brief": "a resource that can/should have a record in NIST's public data listing (PDL)", "anchor": "PublicDataResource", "usage": [ { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "DataPublication" } } ], "inheritsFrom": [ "Resource" ], "properties": [ { "id": "PublicDataResource.accrualPeriodicity", "name": "accrualPeriodicity", "label": "Frequency", "parentType": "PublicDataResource", "value": { "jsonType": "fixed | null | string", "display": "fixed value: \"irregular\" or text" }, "description": [ "Frequency with which dataset is published." ], "brief": "Frequency with which dataset is published.", "anchor": "PublicDataResource.accrualPeriodicity", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/properties/0" } }, { "id": "PublicDataResource.bureauCode", "name": "bureauCode", "label": "Bureau Code", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "an identifier provided by the OMB Circular A-11, Appendix C that identifies the originating federal agency" ], "brief": "an identifier provided by the OMB Circular A-11, Appendix C that identifies the originating federal agency", "anchor": "PublicDataResource.bureauCode", "required": false, "inheritedFrom": null, "schemaNotes": [ "OMB Circular A-11, Appendix C is available via http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf", "A machine-readable listing of the defined codes is available via https://project-open-data.cio.gov/data/omb_bureau_codes.csv", "Codes have the format of 015:01" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/properties/1" } }, { "id": "PublicDataResource.programCode", "name": "programCode", "label": "Program Code", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "an identifier provided by the Federal Program Inventory that identifies the primary program related to this data asset" ], "brief": "an identifier provided by the Federal Program Inventory that identifies the primary program related to this data asset", "anchor": "PublicDataResource.programCode", "required": false, "inheritedFrom": null, "schemaNotes": [ "A machine-readable listing of the defined codes is available via https://www.performance.gov/sites/default/files/files/FederalProgramInventory_FY13_MachineReadable_091613.xls", "Codes have the format of 015:001" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/properties/2" } }, { "id": "PublicDataResource.dataQuality", "name": "dataQuality", "label": "Data Quality", "parentType": "PublicDataResource", "value": { "jsonType": "boolean | null", "display": "boolean" }, "description": [ "Whether the dataset meets the agency's Information Quality Guidelines" ], "brief": "Whether the dataset meets the agency's Information Quality Guidelines", "anchor": "PublicDataResource.dataQuality", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/properties/3" } }, { "id": "PublicDataResource.primaryITInvestmentUII", "name": "primaryITInvestmentUII", "label": "Primary IT Investment UII", "parentType": "PublicDataResource", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The IT Unique Investment Identifier (UII) that is associated with this dataset" ], "brief": "The IT Unique Investment Identifier (UII) that is associated with this dataset", "anchor": "PublicDataResource.primaryITInvestmentUII", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/properties/4" } }, { "id": "PublicDataResource.systemOfRecords", "name": "systemOfRecords", "label": "System of Records", "parentType": "PublicDataResource", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The URL to the System of Records Notice related to this dataset if is so designated under the Privacy Act of 1974" ], "brief": "The URL to the System of Records Notice related to this dataset if is so designated under the Privacy Act of 1974", "anchor": "PublicDataResource.systemOfRecords", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/properties/5" } }, { "id": "PublicDataResource.title", "name": "title", "label": "Title", "parentType": "PublicDataResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "Human-readable, descriptive name of the resource" ], "brief": "Human-readable, descriptive name of the resource", "anchor": "Resource.title", "required": false, "inheritedFrom": { "type": "Resource", "property": "title", "anchor": "Resource.title" }, "schemaNotes": [ "Acronyms should be avoided" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/0" } }, { "id": "PublicDataResource.version", "name": "version", "label": "Version", "parentType": "PublicDataResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "a string indicating the version of the release of this resource" ], "brief": "a string indicating the version of the release of this resource", "anchor": "Resource.version", "required": false, "inheritedFrom": { "type": "Resource", "property": "version", "anchor": "Resource.version" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/1" } }, { "id": "PublicDataResource.versionHistory", "name": "versionHistory", "label": "History", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of VersionRelease objects", "itemType": "VersionRelease" }, "description": [ "a list describing the release of different versions of this resource" ], "brief": "a list describing the release of different versions of this resource", "anchor": "Resource.versionHistory", "required": false, "inheritedFrom": { "type": "Resource", "property": "versionHistory", "anchor": "Resource.versionHistory" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/2" } }, { "id": "PublicDataResource.replaces", "name": "replaces", "label": "Replaces", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of (see JSON schema)s" }, "description": [ "a listing of other existing resources that are deprecated by this resource" ], "brief": "a listing of other existing resources that are deprecated by this resource", "anchor": "Resource.replaces", "required": false, "inheritedFrom": { "type": "Resource", "property": "replaces", "anchor": "Resource.replaces" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/3" } }, { "id": "PublicDataResource.isReplacedBy", "name": "isReplacedBy", "label": "Replaced by", "parentType": "PublicDataResource", "value": { "jsonType": "unknown", "display": "(see JSON schema)" }, "description": [ "another existing resources that should be considered a replacement for this resource" ], "brief": "another existing resources that should be considered a replacement for this resource", "anchor": "Resource.isReplacedBy", "required": false, "inheritedFrom": { "type": "Resource", "property": "isReplacedBy", "anchor": "Resource.isReplacedBy" }, "schemaNotes": [ "This typically refers to a newer version of this resource", "In the PDR system, this value is automatically generated given the overall state of the PDR's catalog" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/4" } }, { "id": "PublicDataResource.description", "name": "description", "label": "Description", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "Human-readable description (e.g., an abstract) of the resource" ], "brief": "Human-readable description (e.g., an abstract) of the resource", "anchor": "Resource.description", "required": false, "inheritedFrom": { "type": "Resource", "property": "description", "anchor": "Resource.description" }, "schemaNotes": [ "Each element in the array should be considered a separate paragraph" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/5" } }, { "id": "PublicDataResource.keyword", "name": "keyword", "label": "Tags", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users." ], "brief": "Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.", "anchor": "Resource.keyword", "required": false, "inheritedFrom": { "type": "Resource", "property": "keyword", "anchor": "Resource.keyword" }, "schemaNotes": [ "Surround each keyword with quotes. Separate keywords with commas. Avoid duplicate keywords in the same record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/6" } }, { "id": "PublicDataResource.topic", "name": "topic", "label": "topic", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this resource addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this resource addresses or speaks to", "anchor": "Resource.topic", "required": false, "inheritedFrom": { "type": "Resource", "property": "topic", "anchor": "Resource.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/7" } }, { "id": "PublicDataResource.modified", "name": "modified", "label": "modified", "parentType": "PublicDataResource", "value": { "jsonType": "object", "display": "ISO8601DateRange object", "objectType": "ISO8601DateRange" }, "description": [ "Most recent date on which the dataset was changed, updated or modified." ], "brief": "Most recent date on which the dataset was changed, updated or modified.", "anchor": "Resource.modified", "required": false, "inheritedFrom": { "type": "Resource", "property": "modified", "anchor": "Resource.modified" }, "schemaNotes": [ "Dates should be ISO 8601 of highest resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset. If there is a need to reflect that the dataset is continually updated, ISO 8601 formatting can account for this with repeating intervals. For instance, R/P1D for daily, R/P2W for every two weeks, and R/PT5M for every five minutes." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/8" } }, { "id": "PublicDataResource.issued", "name": "issued", "label": "Release Date", "parentType": "PublicDataResource", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "Date of formal issuance of the resource" ], "brief": "Date of formal issuance of the resource", "anchor": "Resource.issued", "required": false, "inheritedFrom": { "type": "Resource", "property": "issued", "anchor": "Resource.issued" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/9" } }, { "id": "PublicDataResource.publisher", "name": "publisher", "label": "publisher", "parentType": "PublicDataResource", "value": { "jsonType": "object", "display": "Organization object", "objectType": "Organization" }, "description": [ "The publishing entity and optionally their parent organization(s)." ], "brief": "The publishing entity and optionally their parent organization(s).", "anchor": "Resource.publisher", "required": false, "inheritedFrom": { "type": "Resource", "property": "publisher", "anchor": "Resource.publisher" }, "schemaNotes": [ "This is a container for a publisher object which groups together the fields: name and subOrganization. The subOrganization field can also contain a publisher object which allows one to describe an organization's hierarchy. Where greater specificity is desired, include as many levels of publisher as is useful, in ascending order, using the below format." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/10" } }, { "id": "PublicDataResource.contactPoint", "name": "contactPoint", "label": "contactPoint", "parentType": "PublicDataResource", "value": { "jsonType": "object", "display": "ContactInfo object", "objectType": "ContactInfo" }, "description": [ "Contact information for getting more information about this resource" ], "brief": "Contact information for getting more information about this resource", "anchor": "Resource.contactPoint", "required": false, "inheritedFrom": { "type": "Resource", "property": "contactPoint", "anchor": "Resource.contactPoint" }, "schemaNotes": [ "This should include at least a name and an email address", "The information can reflect either a person or a group (such as a help desk)" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/11" } }, { "id": "PublicDataResource.accessLevel", "name": "accessLevel", "label": "Public Access Level", "parentType": "PublicDataResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "The degree to which this dataset could be made publicly-available, regardless of whether it has been made available" ], "brief": "The degree to which this dataset could be made publicly-available, regardless of whether it has been made available", "anchor": "Resource.accessLevel", "required": false, "inheritedFrom": { "type": "Resource", "property": "accessLevel", "anchor": "Resource.accessLevel" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/12" }, "allowedValues": [ { "value": "public", "description": "Data asset is or could be made publicly available to all without restrictions" }, { "value": "restricted public", "description": "Data asset is available under certain use restrictions" }, { "value": "non-public", "description": "Data asset is not available to members of the public" } ] }, { "id": "PublicDataResource.license", "name": "license", "label": "License", "parentType": "PublicDataResource", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "A pointer to the primary license or non-license (i.e. Public Domain) statement with which the dataset or API has been published" ], "brief": "A pointer to the primary license or non-license (i.e. Public Domain) statement with which the dataset or API has been published", "anchor": "Resource.license", "required": false, "inheritedFrom": { "type": "Resource", "property": "license", "anchor": "Resource.license" }, "schemaNotes": [ "Software and data developed primarily by federal employees must be considered in the public domain; software primarily developed by contract can be assigned a license, including an open source license.", "By default, NIST-produced data and software should point to http://www.nist.gov/data/license.cfm", "See Open Licenses (https://project-open-data.cio.gov/open-licenses/) for more information." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/13" } }, { "id": "PublicDataResource.rights", "name": "rights", "label": "Rights", "parentType": "PublicDataResource", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "information regarding access or restrictions based on privacy, security, or other policies" ], "brief": "information regarding access or restrictions based on privacy, security, or other policies", "anchor": "Resource.rights", "required": false, "inheritedFrom": { "type": "Resource", "property": "rights", "anchor": "Resource.rights" }, "schemaNotes": [ "This should also provide an explanation for the selected \"accessLevel\" including instructions for how to access a restricted file, if applicable, or explanation for why a \"non-public\" or \"restricted public\" data assetis not \"public,\" if applicable.", "Text must be 255 or fewer characters." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/14" } }, { "id": "PublicDataResource.components", "name": "components", "label": "components", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of Component objects", "itemType": "Component" }, "description": [ "a listing of the various component resources, tools, and distributions of this resource" ], "brief": "a listing of the various component resources, tools, and distributions of this resource", "anchor": "Resource.components", "required": false, "inheritedFrom": { "type": "Resource", "property": "components", "anchor": "Resource.components" }, "schemaNotes": [ "Records for the resources referenced in this list should specify this resource in its isPartOf field.", "The @type property will indicate which type of component it is. The first value in the @type list should be considered the primary or most important classification.", "If an item's @type includes dcat:Distribution, the item should be convertable to a distribution in the POD schema.", "The order should be considered meaningful (at least for components of the same type). The meaning or intention behind the order can depend on the type; however, generally, display of the components of a common type should preserve the order. For clarity then, it is recommended that items of the same primary type should be grouped together in the list." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/15" } }, { "id": "PublicDataResource.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "PublicDataResource", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the resource conforms to" ], "brief": "URI used to identify a standardized specification the resource conforms to", "anchor": "Resource.conformsTo", "required": false, "inheritedFrom": { "type": "Resource", "property": "conformsTo", "anchor": "Resource.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/16" } }, { "id": "PublicDataResource.isPartOf", "name": "isPartOf", "label": "Collection", "parentType": "PublicDataResource", "value": { "jsonType": "object", "display": "ResourceReference object", "objectType": "ResourceReference" }, "description": [ "The collection of which the dataset is a subset" ], "brief": "The collection of which the dataset is a subset", "anchor": "Resource.isPartOf", "required": false, "inheritedFrom": { "type": "Resource", "property": "isPartOf", "anchor": "Resource.isPartOf" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/17" } }, { "id": "PublicDataResource.language", "name": "language", "label": "Language", "parentType": "PublicDataResource", "value": { "jsonType": "array | null", "display": "list of text values", "itemType": "string" }, "description": [ "The primary language used in the dataset" ], "brief": "The primary language used in the dataset", "anchor": "Resource.language", "required": false, "inheritedFrom": { "type": "Resource", "property": "language", "anchor": "Resource.language" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/18" } }, { "id": "PublicDataResource.landingPage", "name": "landingPage", "label": "Homepage URL", "parentType": "PublicDataResource", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "a URL to a human-friendly web page that represents the home or gateway to the resources that are part of this dataset." ], "brief": "a URL to a human-friendly web page that represents the home or gateway to the resources that are part of this dataset.", "anchor": "Resource.landingPage", "required": false, "inheritedFrom": { "type": "Resource", "property": "landingPage", "anchor": "Resource.landingPage" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/19" } }, { "id": "PublicDataResource.references", "name": "references", "label": "Related Literature", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of BibliographicReference objects", "itemType": "BibliographicReference" }, "description": [ "Related documents such as technical information about a dataset, developer documentation, literature articles, etc." ], "brief": "Related documents and articles", "anchor": "Resource.references", "required": false, "inheritedFrom": { "type": "Resource", "property": "references", "anchor": "Resource.references" }, "schemaNotes": [], "readerNotes": [ "This list is much like the references at the end of an article." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/20" } }, { "id": "PublicDataResource.theme", "name": "theme", "label": "Category", "parentType": "PublicDataResource", "value": { "jsonType": "array | null", "display": "list of text values", "itemType": "string" }, "description": [ "Main thematic category of the dataset." ], "brief": "Main thematic category of the dataset.", "anchor": "Resource.theme", "required": false, "inheritedFrom": { "type": "Resource", "property": "theme", "anchor": "Resource.theme" }, "schemaNotes": [ "Could include ISO Topic Categories (http://www.isotopicmaps.org/)" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/21" } }, { "id": "PublicDataResource.@id", "name": "@id", "label": "@id", "parentType": "PublicDataResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "A (primary) unique identifier for the resource" ], "brief": "A (primary) unique identifier for the resource", "anchor": "Resource.@id", "required": false, "inheritedFrom": { "type": "Resource", "property": "@id", "anchor": "Resource.@id" }, "schemaNotes": [ "It is expected that this field will contain a type of identifier that is of a uniform type across all resource descriptions in the system", "This identifier should, by default, resolve to the metadata record (or some rendering of it) rather than to the resource itself (e.g. via its landing page)." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/22" } }, { "id": "PublicDataResource.doi", "name": "doi", "label": "doi", "parentType": "PublicDataResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "A Digital Object Identifier (DOI) in non-resolving form." ], "brief": "A Digital Object Identifier (DOI) in non-resolving form.", "anchor": "Resource.doi", "required": false, "inheritedFrom": { "type": "Resource", "property": "doi", "anchor": "Resource.doi" }, "schemaNotes": [ "The DOI value should not have the resolver URI base, but should have the form 'doi:NNNNN/XXXXXX'", "It is expected that this will primarily be Datacite DOIs" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/23" } }, { "id": "PublicDataResource.ediid", "name": "ediid", "label": "ediid", "parentType": "PublicDataResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "the NIST EDI identifier assigned to the resource" ], "brief": "the NIST EDI identifier assigned to the resource", "anchor": "Resource.ediid", "required": false, "inheritedFrom": { "type": "Resource", "property": "ediid", "anchor": "Resource.ediid" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/24" } }, { "id": "PublicDataResource.abbrev", "name": "abbrev", "label": "abbrev", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "an abbreviated form of the resource's title" ], "brief": "an abbreviated form of the resource's title", "anchor": "Resource.abbrev", "required": false, "inheritedFrom": { "type": "Resource", "property": "abbrev", "anchor": "Resource.abbrev" }, "schemaNotes": [ "this can be used as a label for a compact display or text for a link to this resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/25" } }, { "id": "PublicDataResource.@type", "name": "@type", "label": "@type", "parentType": "PublicDataResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the linked-data class types for this resource" ], "brief": "the linked-data class types for this resource", "anchor": "Resource.@type", "required": false, "inheritedFrom": { "type": "Resource", "property": "@type", "anchor": "Resource.@type" }, "schemaNotes": [ "The value must always be given as an array, even when only one type is provided.", "Multiple values indicate that the Resource can be considered of multiple types", "If this resource is not to be considered a subtype of the nrd:Resource, its value should be 'nrd:Resource'." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15/inheritedProperties/0/properties/26" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/15" } }, { "id": "DataPublication", "name": "DataPublication", "label": "DataPublication", "group": "Resource", "valueType": "object", "displayType": "object", "description": [ "Data presented by one or more authors as citable publication" ], "brief": "Data presented by one or more authors as citable publication", "anchor": "DataPublication", "usage": [], "inheritsFrom": [ "PublicDataResource" ], "properties": [ { "id": "DataPublication.subtitle", "name": "subtitle", "label": "subtitle", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "a secondary or sub-title for the resource" ], "brief": "a secondary or sub-title for the resource", "anchor": "DataPublication.subtitle", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/properties/0" } }, { "id": "DataPublication.aka", "name": "aka", "label": "aka", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "other (unofficial) titles that this resource is sometimes known as" ], "brief": "other (unofficial) titles that this resource is sometimes known as", "anchor": "DataPublication.aka", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/properties/1" } }, { "id": "DataPublication.authors", "name": "authors", "label": "authors", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of Person objects", "itemType": "Person" }, "description": [ "the ordered list of authors of this data publication" ], "brief": "the ordered list of authors of this data publication", "anchor": "DataPublication.authors", "required": false, "inheritedFrom": null, "schemaNotes": [ "Authors should generally be assumed to be considered creators of the data; where this is is not true or insufficient, the contributors property can be used ot add or clarify who contributed to data creation." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/properties/2" } }, { "id": "DataPublication.recommendedCitation", "name": "recommendedCitation", "label": "recommendedCitation", "parentType": "DataPublication", "value": { "jsonType": "string", "display": "text" }, "description": [ "a recommended formatting of a citation to this data publication" ], "brief": "a recommended formatting of a citation to this data publication", "anchor": "DataPublication.recommendedCitation", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/properties/3" } }, { "id": "DataPublication.title", "name": "title", "label": "Title", "parentType": "DataPublication", "value": { "jsonType": "string", "display": "text" }, "description": [ "Human-readable, descriptive name of the resource" ], "brief": "Human-readable, descriptive name of the resource", "anchor": "Resource.title", "required": false, "inheritedFrom": { "type": "Resource", "property": "title", "anchor": "Resource.title" }, "schemaNotes": [ "Acronyms should be avoided" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/0" } }, { "id": "DataPublication.version", "name": "version", "label": "Version", "parentType": "DataPublication", "value": { "jsonType": "string", "display": "text" }, "description": [ "a string indicating the version of the release of this resource" ], "brief": "a string indicating the version of the release of this resource", "anchor": "Resource.version", "required": false, "inheritedFrom": { "type": "Resource", "property": "version", "anchor": "Resource.version" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/1" } }, { "id": "DataPublication.versionHistory", "name": "versionHistory", "label": "History", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of VersionRelease objects", "itemType": "VersionRelease" }, "description": [ "a list describing the release of different versions of this resource" ], "brief": "a list describing the release of different versions of this resource", "anchor": "Resource.versionHistory", "required": false, "inheritedFrom": { "type": "Resource", "property": "versionHistory", "anchor": "Resource.versionHistory" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/2" } }, { "id": "DataPublication.replaces", "name": "replaces", "label": "Replaces", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of (see JSON schema)s" }, "description": [ "a listing of other existing resources that are deprecated by this resource" ], "brief": "a listing of other existing resources that are deprecated by this resource", "anchor": "Resource.replaces", "required": false, "inheritedFrom": { "type": "Resource", "property": "replaces", "anchor": "Resource.replaces" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/3" } }, { "id": "DataPublication.isReplacedBy", "name": "isReplacedBy", "label": "Replaced by", "parentType": "DataPublication", "value": { "jsonType": "unknown", "display": "(see JSON schema)" }, "description": [ "another existing resources that should be considered a replacement for this resource" ], "brief": "another existing resources that should be considered a replacement for this resource", "anchor": "Resource.isReplacedBy", "required": false, "inheritedFrom": { "type": "Resource", "property": "isReplacedBy", "anchor": "Resource.isReplacedBy" }, "schemaNotes": [ "This typically refers to a newer version of this resource", "In the PDR system, this value is automatically generated given the overall state of the PDR's catalog" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/4" } }, { "id": "DataPublication.description", "name": "description", "label": "Description", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "Human-readable description (e.g., an abstract) of the resource" ], "brief": "Human-readable description (e.g., an abstract) of the resource", "anchor": "Resource.description", "required": false, "inheritedFrom": { "type": "Resource", "property": "description", "anchor": "Resource.description" }, "schemaNotes": [ "Each element in the array should be considered a separate paragraph" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/5" } }, { "id": "DataPublication.keyword", "name": "keyword", "label": "Tags", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users." ], "brief": "Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.", "anchor": "Resource.keyword", "required": false, "inheritedFrom": { "type": "Resource", "property": "keyword", "anchor": "Resource.keyword" }, "schemaNotes": [ "Surround each keyword with quotes. Separate keywords with commas. Avoid duplicate keywords in the same record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/6" } }, { "id": "DataPublication.topic", "name": "topic", "label": "topic", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this resource addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this resource addresses or speaks to", "anchor": "Resource.topic", "required": false, "inheritedFrom": { "type": "Resource", "property": "topic", "anchor": "Resource.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/7" } }, { "id": "DataPublication.modified", "name": "modified", "label": "modified", "parentType": "DataPublication", "value": { "jsonType": "object", "display": "ISO8601DateRange object", "objectType": "ISO8601DateRange" }, "description": [ "Most recent date on which the dataset was changed, updated or modified." ], "brief": "Most recent date on which the dataset was changed, updated or modified.", "anchor": "Resource.modified", "required": false, "inheritedFrom": { "type": "Resource", "property": "modified", "anchor": "Resource.modified" }, "schemaNotes": [ "Dates should be ISO 8601 of highest resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset. If there is a need to reflect that the dataset is continually updated, ISO 8601 formatting can account for this with repeating intervals. For instance, R/P1D for daily, R/P2W for every two weeks, and R/PT5M for every five minutes." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/8" } }, { "id": "DataPublication.issued", "name": "issued", "label": "Release Date", "parentType": "DataPublication", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "Date of formal issuance of the resource" ], "brief": "Date of formal issuance of the resource", "anchor": "Resource.issued", "required": false, "inheritedFrom": { "type": "Resource", "property": "issued", "anchor": "Resource.issued" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/9" } }, { "id": "DataPublication.publisher", "name": "publisher", "label": "publisher", "parentType": "DataPublication", "value": { "jsonType": "object", "display": "Organization object", "objectType": "Organization" }, "description": [ "The publishing entity and optionally their parent organization(s)." ], "brief": "The publishing entity and optionally their parent organization(s).", "anchor": "Resource.publisher", "required": false, "inheritedFrom": { "type": "Resource", "property": "publisher", "anchor": "Resource.publisher" }, "schemaNotes": [ "This is a container for a publisher object which groups together the fields: name and subOrganization. The subOrganization field can also contain a publisher object which allows one to describe an organization's hierarchy. Where greater specificity is desired, include as many levels of publisher as is useful, in ascending order, using the below format." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/10" } }, { "id": "DataPublication.contactPoint", "name": "contactPoint", "label": "contactPoint", "parentType": "DataPublication", "value": { "jsonType": "object", "display": "ContactInfo object", "objectType": "ContactInfo" }, "description": [ "Contact information for getting more information about this resource" ], "brief": "Contact information for getting more information about this resource", "anchor": "Resource.contactPoint", "required": false, "inheritedFrom": { "type": "Resource", "property": "contactPoint", "anchor": "Resource.contactPoint" }, "schemaNotes": [ "This should include at least a name and an email address", "The information can reflect either a person or a group (such as a help desk)" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/11" } }, { "id": "DataPublication.accessLevel", "name": "accessLevel", "label": "Public Access Level", "parentType": "DataPublication", "value": { "jsonType": "string", "display": "text" }, "description": [ "The degree to which this dataset could be made publicly-available, regardless of whether it has been made available" ], "brief": "The degree to which this dataset could be made publicly-available, regardless of whether it has been made available", "anchor": "Resource.accessLevel", "required": false, "inheritedFrom": { "type": "Resource", "property": "accessLevel", "anchor": "Resource.accessLevel" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/12" }, "allowedValues": [ { "value": "public", "description": "Data asset is or could be made publicly available to all without restrictions" }, { "value": "restricted public", "description": "Data asset is available under certain use restrictions" }, { "value": "non-public", "description": "Data asset is not available to members of the public" } ] }, { "id": "DataPublication.license", "name": "license", "label": "License", "parentType": "DataPublication", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "A pointer to the primary license or non-license (i.e. Public Domain) statement with which the dataset or API has been published" ], "brief": "A pointer to the primary license or non-license (i.e. Public Domain) statement with which the dataset or API has been published", "anchor": "Resource.license", "required": false, "inheritedFrom": { "type": "Resource", "property": "license", "anchor": "Resource.license" }, "schemaNotes": [ "Software and data developed primarily by federal employees must be considered in the public domain; software primarily developed by contract can be assigned a license, including an open source license.", "By default, NIST-produced data and software should point to http://www.nist.gov/data/license.cfm", "See Open Licenses (https://project-open-data.cio.gov/open-licenses/) for more information." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/13" } }, { "id": "DataPublication.rights", "name": "rights", "label": "Rights", "parentType": "DataPublication", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "information regarding access or restrictions based on privacy, security, or other policies" ], "brief": "information regarding access or restrictions based on privacy, security, or other policies", "anchor": "Resource.rights", "required": false, "inheritedFrom": { "type": "Resource", "property": "rights", "anchor": "Resource.rights" }, "schemaNotes": [ "This should also provide an explanation for the selected \"accessLevel\" including instructions for how to access a restricted file, if applicable, or explanation for why a \"non-public\" or \"restricted public\" data assetis not \"public,\" if applicable.", "Text must be 255 or fewer characters." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/14" } }, { "id": "DataPublication.components", "name": "components", "label": "components", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of Component objects", "itemType": "Component" }, "description": [ "a listing of the various component resources, tools, and distributions of this resource" ], "brief": "a listing of the various component resources, tools, and distributions of this resource", "anchor": "Resource.components", "required": false, "inheritedFrom": { "type": "Resource", "property": "components", "anchor": "Resource.components" }, "schemaNotes": [ "Records for the resources referenced in this list should specify this resource in its isPartOf field.", "The @type property will indicate which type of component it is. The first value in the @type list should be considered the primary or most important classification.", "If an item's @type includes dcat:Distribution, the item should be convertable to a distribution in the POD schema.", "The order should be considered meaningful (at least for components of the same type). The meaning or intention behind the order can depend on the type; however, generally, display of the components of a common type should preserve the order. For clarity then, it is recommended that items of the same primary type should be grouped together in the list." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/15" } }, { "id": "DataPublication.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "DataPublication", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the resource conforms to" ], "brief": "URI used to identify a standardized specification the resource conforms to", "anchor": "Resource.conformsTo", "required": false, "inheritedFrom": { "type": "Resource", "property": "conformsTo", "anchor": "Resource.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/16" } }, { "id": "DataPublication.isPartOf", "name": "isPartOf", "label": "Collection", "parentType": "DataPublication", "value": { "jsonType": "object", "display": "ResourceReference object", "objectType": "ResourceReference" }, "description": [ "The collection of which the dataset is a subset" ], "brief": "The collection of which the dataset is a subset", "anchor": "Resource.isPartOf", "required": false, "inheritedFrom": { "type": "Resource", "property": "isPartOf", "anchor": "Resource.isPartOf" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/17" } }, { "id": "DataPublication.language", "name": "language", "label": "Language", "parentType": "DataPublication", "value": { "jsonType": "array | null", "display": "list of text values", "itemType": "string" }, "description": [ "The primary language used in the dataset" ], "brief": "The primary language used in the dataset", "anchor": "Resource.language", "required": false, "inheritedFrom": { "type": "Resource", "property": "language", "anchor": "Resource.language" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/18" } }, { "id": "DataPublication.landingPage", "name": "landingPage", "label": "Homepage URL", "parentType": "DataPublication", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "a URL to a human-friendly web page that represents the home or gateway to the resources that are part of this dataset." ], "brief": "a URL to a human-friendly web page that represents the home or gateway to the resources that are part of this dataset.", "anchor": "Resource.landingPage", "required": false, "inheritedFrom": { "type": "Resource", "property": "landingPage", "anchor": "Resource.landingPage" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/19" } }, { "id": "DataPublication.references", "name": "references", "label": "Related Documents", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of BibliographicReference objects", "itemType": "BibliographicReference" }, "description": [ "Related documents such as technical information about a dataset, developer documentation, etc." ], "brief": "Related documents such as technical information about a dataset, developer documentation, etc.", "anchor": "Resource.references", "required": false, "inheritedFrom": { "type": "Resource", "property": "references", "anchor": "Resource.references" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/20" } }, { "id": "DataPublication.theme", "name": "theme", "label": "Category", "parentType": "DataPublication", "value": { "jsonType": "array | null", "display": "list of text values", "itemType": "string" }, "description": [ "Main thematic category of the dataset." ], "brief": "Main thematic category of the dataset.", "anchor": "Resource.theme", "required": false, "inheritedFrom": { "type": "Resource", "property": "theme", "anchor": "Resource.theme" }, "schemaNotes": [ "Could include ISO Topic Categories (http://www.isotopicmaps.org/)" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/21" } }, { "id": "DataPublication.@id", "name": "@id", "label": "@id", "parentType": "DataPublication", "value": { "jsonType": "string", "display": "text" }, "description": [ "A (primary) unique identifier for the resource" ], "brief": "A (primary) unique identifier for the resource", "anchor": "Resource.@id", "required": false, "inheritedFrom": { "type": "Resource", "property": "@id", "anchor": "Resource.@id" }, "schemaNotes": [ "It is expected that this field will contain a type of identifier that is of a uniform type across all resource descriptions in the system", "This identifier should, by default, resolve to the metadata record (or some rendering of it) rather than to the resource itself (e.g. via its landing page)." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/22" } }, { "id": "DataPublication.doi", "name": "doi", "label": "doi", "parentType": "DataPublication", "value": { "jsonType": "string", "display": "text" }, "description": [ "A Digital Object Identifier (DOI) in non-resolving form." ], "brief": "A Digital Object Identifier (DOI) in non-resolving form.", "anchor": "Resource.doi", "required": false, "inheritedFrom": { "type": "Resource", "property": "doi", "anchor": "Resource.doi" }, "schemaNotes": [ "The DOI value should not have the resolver URI base, but should have the form 'doi:NNNNN/XXXXXX'", "It is expected that this will primarily be Datacite DOIs" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/23" } }, { "id": "DataPublication.ediid", "name": "ediid", "label": "ediid", "parentType": "DataPublication", "value": { "jsonType": "string", "display": "text" }, "description": [ "the NIST EDI identifier assigned to the resource" ], "brief": "the NIST EDI identifier assigned to the resource", "anchor": "Resource.ediid", "required": false, "inheritedFrom": { "type": "Resource", "property": "ediid", "anchor": "Resource.ediid" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/24" } }, { "id": "DataPublication.abbrev", "name": "abbrev", "label": "abbrev", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "an abbreviated form of the resource's title" ], "brief": "an abbreviated form of the resource's title", "anchor": "Resource.abbrev", "required": false, "inheritedFrom": { "type": "Resource", "property": "abbrev", "anchor": "Resource.abbrev" }, "schemaNotes": [ "this can be used as a label for a compact display or text for a link to this resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/25" } }, { "id": "DataPublication.@type", "name": "@type", "label": "@type", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the linked-data class types for this resource" ], "brief": "the linked-data class types for this resource", "anchor": "Resource.@type", "required": false, "inheritedFrom": { "type": "Resource", "property": "@type", "anchor": "Resource.@type" }, "schemaNotes": [ "The value must always be given as an array, even when only one type is provided.", "Multiple values indicate that the Resource can be considered of multiple types", "If this resource is not to be considered a subtype of the nrd:Resource, its value should be 'nrd:Resource'." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/0/properties/26" } }, { "id": "DataPublication.accrualPeriodicity", "name": "accrualPeriodicity", "label": "Frequency", "parentType": "DataPublication", "value": { "jsonType": "fixed | null | string", "display": "fixed value: \"irregular\" or text" }, "description": [ "Frequency with which dataset is published." ], "brief": "Frequency with which dataset is published.", "anchor": "PublicDataResource.accrualPeriodicity", "required": false, "inheritedFrom": { "type": "PublicDataResource", "property": "accrualPeriodicity", "anchor": "PublicDataResource.accrualPeriodicity" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/1/properties/0" } }, { "id": "DataPublication.bureauCode", "name": "bureauCode", "label": "Bureau Code", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "an identifier provided by the OMB Circular A-11, Appendix C that identifies the originating federal agency" ], "brief": "an identifier provided by the OMB Circular A-11, Appendix C that identifies the originating federal agency", "anchor": "PublicDataResource.bureauCode", "required": false, "inheritedFrom": { "type": "PublicDataResource", "property": "bureauCode", "anchor": "PublicDataResource.bureauCode" }, "schemaNotes": [ "OMB Circular A-11, Appendix C is available via http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf", "A machine-readable listing of the defined codes is available via https://project-open-data.cio.gov/data/omb_bureau_codes.csv", "Codes have the format of 015:01" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/1/properties/1" } }, { "id": "DataPublication.programCode", "name": "programCode", "label": "Program Code", "parentType": "DataPublication", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "an identifier provided by the Federal Program Inventory that identifies the primary program related to this data asset" ], "brief": "an identifier provided by the Federal Program Inventory that identifies the primary program related to this data asset", "anchor": "PublicDataResource.programCode", "required": false, "inheritedFrom": { "type": "PublicDataResource", "property": "programCode", "anchor": "PublicDataResource.programCode" }, "schemaNotes": [ "A machine-readable listing of the defined codes is available via https://www.performance.gov/sites/default/files/files/FederalProgramInventory_FY13_MachineReadable_091613.xls", "Codes have the format of 015:001" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/1/properties/2" } }, { "id": "DataPublication.dataQuality", "name": "dataQuality", "label": "Data Quality", "parentType": "DataPublication", "value": { "jsonType": "boolean | null", "display": "boolean" }, "description": [ "Whether the dataset meets the agency's Information Quality Guidelines" ], "brief": "Whether the dataset meets the agency's Information Quality Guidelines", "anchor": "PublicDataResource.dataQuality", "required": false, "inheritedFrom": { "type": "PublicDataResource", "property": "dataQuality", "anchor": "PublicDataResource.dataQuality" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/1/properties/3" } }, { "id": "DataPublication.primaryITInvestmentUII", "name": "primaryITInvestmentUII", "label": "Primary IT Investment UII", "parentType": "DataPublication", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The IT Unique Investment Identifier (UII) that is associated with this dataset" ], "brief": "The IT Unique Investment Identifier (UII) that is associated with this dataset", "anchor": "PublicDataResource.primaryITInvestmentUII", "required": false, "inheritedFrom": { "type": "PublicDataResource", "property": "primaryITInvestmentUII", "anchor": "PublicDataResource.primaryITInvestmentUII" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/1/properties/4" } }, { "id": "DataPublication.systemOfRecords", "name": "systemOfRecords", "label": "System of Records", "parentType": "DataPublication", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The URL to the System of Records Notice related to this dataset if is so designated under the Privacy Act of 1974" ], "brief": "The URL to the System of Records Notice related to this dataset if is so designated under the Privacy Act of 1974", "anchor": "PublicDataResource.systemOfRecords", "required": false, "inheritedFrom": { "type": "PublicDataResource", "property": "systemOfRecords", "anchor": "PublicDataResource.systemOfRecords" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25/inheritedProperties/1/properties/5" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/25" } }, { "id": "Component", "name": "Component", "label": "Component", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "A description of one component of a resource. A component can be a downloadable file, a subcollection of files, an API, or search page.", "This Named Type represents a generic component; other Component types described later in this section represent specific kinds of components." ], "brief": "a component of a resource", "anchor": "Component", "usage": [ { "id": "list-type", "template": "as a value type for the {prop} list property of the {type} type", "data": { "prop": "components", "type": "Resource" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "IncludedResource" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "DownloadableFile" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "Subcollection" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "AccessPage" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "API" } } ], "inheritsFrom": [], "properties": [ { "id": "Component.@id", "name": "@id", "label": "@id", "parentType": "Component", "value": { "jsonType": "string", "display": "text" }, "description": [ "a relative identifier for the distribution It can be appended to its resource identifier to get a globally unique version of the identifier." ], "brief": "a relative identifier for the component.", "anchor": "Component.@id", "required": false, "inheritedFrom": null, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/7/properties/0" } }, { "id": "Component.@type", "name": "@type", "label": "@type", "parentType": "Component", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": null, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [ "This property is a list because it is possible for a component to be catorgorized as multiple types simultaneously", "An included value of nrd:Hidden indicates that the component is part of the NIST-internal management of the resource and is not expected to be useful to external users", "These values are intended to be compliant with use of @type property in the JSON-LD format." ], "examples": [ "\"nrdp:DataFile\"", "\"nrdp:Subcollection\"", "\"nrd:Hidden\"", "\"dcat:Distribution\"" ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/7/properties/1" } }, { "id": "Component.title", "name": "title", "label": "title", "parentType": "Component", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/7/properties/2" } }, { "id": "Component.description", "name": "description", "label": "description", "parentType": "Component", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/7/properties/3" } }, { "id": "Component.topic", "name": "topic", "label": "topic", "parentType": "Component", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "A tag or label taken from a pre-defined vocabulary for a thing or concept that this component addresses or speaks to" ], "brief": "A tag or label taken from a pre-defined vocabulary for a thing or concept that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/7/properties/4" } }, { "id": "Component.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "Component", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/7/properties/5" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/7" } }, { "id": "IncludedResource", "name": "IncludedResource", "label": "IncludedResource", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "A reference to another resource (which has its own record) that is a part of this resource" ], "brief": "A reference to another resource (which has its own record) that is a part of this resource", "anchor": "IncludedResource", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "components" } }, { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "isPartOf" } } ], "inheritsFrom": [ "Component", "ResourceReference" ], "properties": [ { "id": "IncludedResource.@id", "name": "@id", "label": "@id", "parentType": "IncludedResource", "value": { "jsonType": "unknown", "display": "(see JSON schema)" }, "description": [ "a relative identifier for this component" ], "brief": "a relative identifier for this component", "anchor": "IncludedResource.@id", "required": false, "inheritedFrom": null, "schemaNotes": [ "@id should be the ID for the included resource as a component of this resource; use the required proxyFor property to give the native ID of the included resource." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/properties/0" } }, { "id": "IncludedResource.resourceType", "name": "resourceType", "label": "resourceType", "parentType": "IncludedResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the linked-data class types for the included resource" ], "brief": "the linked-data class types for the included resource", "anchor": "IncludedResource.resourceType", "required": false, "inheritedFrom": null, "schemaNotes": [ "The @type should contain values that are subclasses of Component; resourceType is provided to list the Resource types for the included resource.", "Just like a Resource:@type, the value must always be given as an array, even when only one type is provided.", "Multiple values indicate that the Resource can be considered of multiple types", "If this resource is not to be considered a subtype of the nrd:Resource, its value should be 'nrd:Resource'." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/properties/1" } }, { "id": "IncludedResource.@id", "name": "@id", "label": "@id", "parentType": "IncludedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "a (relative) identifier for the distribution" ], "brief": "a (relative) identifier for the distribution", "anchor": "Component.@id", "required": false, "inheritedFrom": { "type": "Component", "property": "@id", "anchor": "Component.@id" }, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/0/properties/0" } }, { "id": "IncludedResource.@type", "name": "@type", "label": "@type", "parentType": "IncludedResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": { "type": "Component", "property": "@type", "anchor": "Component.@type" }, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/0/properties/1" } }, { "id": "IncludedResource.title", "name": "title", "label": "title", "parentType": "IncludedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": { "type": "Component", "property": "title", "anchor": "Component.title" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/0/properties/2" } }, { "id": "IncludedResource.description", "name": "description", "label": "description", "parentType": "IncludedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": { "type": "Component", "property": "description", "anchor": "Component.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/0/properties/3" } }, { "id": "IncludedResource.topic", "name": "topic", "label": "topic", "parentType": "IncludedResource", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this component addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": { "type": "Component", "property": "topic", "anchor": "Component.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/0/properties/4" } }, { "id": "IncludedResource.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "IncludedResource", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": { "type": "Component", "property": "conformsTo", "anchor": "Component.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/0/properties/5" } }, { "id": "IncludedResource.@id", "name": "@id", "label": "@id", "parentType": "IncludedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "an identifier for the reference" ], "brief": "an identifier for the reference", "anchor": "RelatedResource.@id", "required": false, "inheritedFrom": { "type": "ResourceReference", "property": "@id", "anchor": "ResourceReference.@id" }, "schemaNotes": [ "The most well-known PID used to identify the resource (see also notes for proxyFor", "This identifier can be a relative URL which can be used in special cases (See the notes for BibliographicReference:@type for when this ID should not refer to the referenced work).", "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/1/properties/0" } }, { "id": "IncludedResource.@type", "name": "@type", "label": "@type", "parentType": "IncludedResource", "value": { "jsonType": "array | null | string", "display": "text or list of text values", "itemType": "string" }, "description": [], "brief": "", "anchor": "RelatedResource.@type", "required": false, "inheritedFrom": { "type": "ResourceReference", "property": "@type", "anchor": "ResourceReference.@type" }, "schemaNotes": [ "The single string value option is provided for backward compatibility (and may be removed in future versions; see BibliographicReference). When this is used, the node represents a reference and not the thing being referenced; the @id contains a relative URI, representing this reference" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/1/properties/1" } }, { "id": "IncludedResource.title", "name": "title", "label": "title", "parentType": "IncludedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "the name of the resource being referenced" ], "brief": "the name of the resource being referenced", "anchor": "ResourceReference.title", "required": false, "inheritedFrom": { "type": "ResourceReference", "property": "title", "anchor": "ResourceReference.title" }, "schemaNotes": [ "This value is intended for display.", "This can be, but is not required to be, the same title given in the metadata record describing the resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/1/properties/2" } }, { "id": "IncludedResource.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "IncludedResource", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this resource" ], "brief": "a local identifier representing this resource", "anchor": "ResourceReference.proxyFor", "required": false, "inheritedFrom": { "type": "ResourceReference", "property": "proxyFor", "anchor": "ResourceReference.proxyFor" }, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the resource as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/1/properties/3" } }, { "id": "IncludedResource.resourceType", "name": "resourceType", "label": "resourceType", "parentType": "IncludedResource", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the linked-data class types for the referenced resource" ], "brief": "the linked-data class types for the referenced resource", "anchor": "ResourceReference.resourceType", "required": false, "inheritedFrom": { "type": "ResourceReference", "property": "resourceType", "anchor": "ResourceReference.resourceType" }, "schemaNotes": [ "The value must always be given as an array, even when only one type is provided.", "Multiple values indicate that the Resource can be considered of multiple types; it is recommended that the primary type (usually the most specific) should be given first.", "If this resource is not to be considered a subtype of the nrd:Resource, its value should be 'nrd:Resource'." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8/inheritedProperties/1/properties/4" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/8" } }, { "id": "DownloadableFile", "name": "DownloadableFile", "label": "DownloadableFile", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "a description of a downloadable, finite stream of data" ], "brief": "a description of a downloadable, finite stream of data", "anchor": "DownloadableFile", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "components" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "DataFile" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "ChecksumFile" } } ], "inheritsFrom": [ "Component" ], "properties": [ { "id": "DownloadableFile.filepath", "name": "filepath", "label": "filepath", "parentType": "DownloadableFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a name for the data file reflecting its hierarchical location in the data source collection" ], "brief": "a name for the data file reflecting its hierarchical location in the data source collection", "anchor": "DownloadableFile.filepath", "required": false, "inheritedFrom": null, "schemaNotes": [ "Forward slashes delimit the hierarchical names in the path", "If there are no slashes in this value, this file is assumed to be at the top of the file hierarchy", "The base name of this value (i.e. the last field in the path) can be used as the default filename to give to the file if downloaded.", "The component title may have the same value." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/properties/0" } }, { "id": "DownloadableFile.downloadURL", "name": "downloadURL", "label": "Download URL", "parentType": "DownloadableFile", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "URL providing direct access to a downloadable file of a dataset" ], "brief": "URL providing direct access to a downloadable file of a dataset", "anchor": "DownloadableFile.downloadURL", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/properties/1" } }, { "id": "DownloadableFile.mediaType", "name": "mediaType", "label": "Media Type", "parentType": "DownloadableFile", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The machine-readable file format (IANA Media Type or MIME Type) of the file\u2019s downloadURL" ], "brief": "The machine-readable file format (IANA Media Type or MIME Type) of the file\u2019s downloadURL", "anchor": "DownloadableFile.mediaType", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/properties/2" } }, { "id": "DownloadableFile.format", "name": "format", "label": "Format", "parentType": "DownloadableFile", "value": { "jsonType": "object", "display": "Format object", "objectType": "Format" }, "description": [ "A human-readable description of the file format of a distribution" ], "brief": "A human-readable description of the file format of a distribution", "anchor": "DownloadableFile.format", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/properties/3" } }, { "id": "DownloadableFile.checksum", "name": "checksum", "label": "Checksum", "parentType": "DownloadableFile", "value": { "jsonType": "object", "display": "Checksum object", "objectType": "Checksum" }, "description": [ "a checksum for the file" ], "brief": "a checksum for the file", "anchor": "DownloadableFile.checksum", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/properties/4" } }, { "id": "DownloadableFile.size", "name": "size", "label": "size", "parentType": "DownloadableFile", "value": { "jsonType": "integer", "display": "integer" }, "description": [ "the size of the file in bytes" ], "brief": "the size of the file in bytes", "anchor": "DownloadableFile.size", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/properties/5" } }, { "id": "DownloadableFile.@id", "name": "@id", "label": "@id", "parentType": "DownloadableFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a (relative) identifier for the distribution" ], "brief": "a (relative) identifier for the distribution", "anchor": "Component.@id", "required": false, "inheritedFrom": { "type": "Component", "property": "@id", "anchor": "Component.@id" }, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/inheritedProperties/0/properties/0" } }, { "id": "DownloadableFile.@type", "name": "@type", "label": "@type", "parentType": "DownloadableFile", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": { "type": "Component", "property": "@type", "anchor": "Component.@type" }, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/inheritedProperties/0/properties/1" } }, { "id": "DownloadableFile.title", "name": "title", "label": "title", "parentType": "DownloadableFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": { "type": "Component", "property": "title", "anchor": "Component.title" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/inheritedProperties/0/properties/2" } }, { "id": "DownloadableFile.description", "name": "description", "label": "description", "parentType": "DownloadableFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": { "type": "Component", "property": "description", "anchor": "Component.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/inheritedProperties/0/properties/3" } }, { "id": "DownloadableFile.topic", "name": "topic", "label": "topic", "parentType": "DownloadableFile", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this component addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": { "type": "Component", "property": "topic", "anchor": "Component.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/inheritedProperties/0/properties/4" } }, { "id": "DownloadableFile.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "DownloadableFile", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": { "type": "Component", "property": "conformsTo", "anchor": "Component.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16/inheritedProperties/0/properties/5" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/16" } }, { "id": "DataFile", "name": "DataFile", "label": "DataFile", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "a description of a downloadable file that was provided by the authors (as opposed to a system or checksum file produced by the publication system)." ], "brief": "a description of a downloadable file that was provided by the authors (as opposed to a system or checksum file produced by the publication system).", "anchor": "DataFile", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "components" } } ], "inheritsFrom": [ "DownloadableFile" ], "properties": [ { "id": "DataFile.describedBy", "name": "describedBy", "label": "Data Dictionary", "parentType": "DataFile", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URL to the data dictionary for the distribution found at the downloadURL" ], "brief": "URL to the data dictionary for the distribution found at the downloadURL", "anchor": "DataFile.describedBy", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/properties/0" } }, { "id": "DataFile.describedByType", "name": "describedByType", "label": "Data Dictionary Type", "parentType": "DataFile", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The machine-readable file format (IANA Media Type or MIME Type) of the file\u2019s describedBy URL" ], "brief": "The machine-readable file format (IANA Media Type or MIME Type) of the file\u2019s describedBy URL", "anchor": "DataFile.describedByType", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/properties/1" } }, { "id": "DataFile.@id", "name": "@id", "label": "@id", "parentType": "DataFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a (relative) identifier for the distribution" ], "brief": "a (relative) identifier for the distribution", "anchor": "Component.@id", "required": false, "inheritedFrom": { "type": "Component", "property": "@id", "anchor": "Component.@id" }, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/0/properties/0" } }, { "id": "DataFile.@type", "name": "@type", "label": "@type", "parentType": "DataFile", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": { "type": "Component", "property": "@type", "anchor": "Component.@type" }, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/0/properties/1" } }, { "id": "DataFile.title", "name": "title", "label": "title", "parentType": "DataFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": { "type": "Component", "property": "title", "anchor": "Component.title" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/0/properties/2" } }, { "id": "DataFile.description", "name": "description", "label": "description", "parentType": "DataFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": { "type": "Component", "property": "description", "anchor": "Component.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/0/properties/3" } }, { "id": "DataFile.topic", "name": "topic", "label": "topic", "parentType": "DataFile", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this component addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": { "type": "Component", "property": "topic", "anchor": "Component.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/0/properties/4" } }, { "id": "DataFile.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "DataFile", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": { "type": "Component", "property": "conformsTo", "anchor": "Component.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/0/properties/5" } }, { "id": "DataFile.filepath", "name": "filepath", "label": "filepath", "parentType": "DataFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a name for the data file reflecting its hierarchical location in the data source collection" ], "brief": "a name for the data file reflecting its hierarchical location in the data source collection", "anchor": "DownloadableFile.filepath", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "filepath", "anchor": "DownloadableFile.filepath" }, "schemaNotes": [ "Forward slashes delimit the hierarchical names in the path", "If there are no slashes in this value, this file is assumed to be at the top of the file hierarchy", "The base name of this value (i.e. the last field in the path) can be used as the default filename to give to the file if downloaded.", "The component title may have the same value." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/1/properties/0" } }, { "id": "DataFile.downloadURL", "name": "downloadURL", "label": "Download URL", "parentType": "DataFile", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "URL providing direct access to a downloadable file of a dataset" ], "brief": "URL providing direct access to a downloadable file of a dataset", "anchor": "DownloadableFile.downloadURL", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "downloadURL", "anchor": "DownloadableFile.downloadURL" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/1/properties/1" } }, { "id": "DataFile.mediaType", "name": "mediaType", "label": "Media Type", "parentType": "DataFile", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The machine-readable file format (IANA Media Type or MIME Type) of the file\u2019s downloadURL" ], "brief": "The machine-readable file format (IANA Media Type or MIME Type) of the file\u2019s downloadURL", "anchor": "DownloadableFile.mediaType", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "mediaType", "anchor": "DownloadableFile.mediaType" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/1/properties/2" } }, { "id": "DataFile.format", "name": "format", "label": "Format", "parentType": "DataFile", "value": { "jsonType": "object", "display": "Format object", "objectType": "Format" }, "description": [ "A human-readable description of the file format of a distribution" ], "brief": "A human-readable description of the file format of a distribution", "anchor": "DownloadableFile.format", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "format", "anchor": "DownloadableFile.format" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/1/properties/3" } }, { "id": "DataFile.checksum", "name": "checksum", "label": "Checksum", "parentType": "DataFile", "value": { "jsonType": "object", "display": "Checksum object", "objectType": "Checksum" }, "description": [ "a checksum for the file" ], "brief": "a checksum for the file", "anchor": "DownloadableFile.checksum", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "checksum", "anchor": "DownloadableFile.checksum" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/1/properties/4" } }, { "id": "DataFile.size", "name": "size", "label": "size", "parentType": "DataFile", "value": { "jsonType": "integer", "display": "integer" }, "description": [ "the size of the file in bytes" ], "brief": "the size of the file in bytes", "anchor": "DownloadableFile.size", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "size", "anchor": "DownloadableFile.size" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17/inheritedProperties/1/properties/5" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/17" } }, { "id": "ChecksumFile", "name": "ChecksumFile", "label": "ChecksumFile", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "a downloadable file that contains the checksum value for a DataFile." ], "brief": "a downloadable file that contains the checksum value for a DataFile.", "anchor": "ChecksumFile", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "components" } } ], "inheritsFrom": [ "DownloadableFile" ], "properties": [ { "id": "ChecksumFile.algorithm", "name": "algorithm", "label": "algorithm", "parentType": "ChecksumFile", "value": { "jsonType": "object", "display": "Topic object", "objectType": "Topic" }, "description": [ "the algorithm used to produce the checksum hash" ], "brief": "the algorithm used to produce the checksum hash", "anchor": "ChecksumFile.algorithm", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/properties/0" } }, { "id": "ChecksumFile.valid", "name": "valid", "label": "valid", "parentType": "ChecksumFile", "value": { "jsonType": "boolean", "display": "boolean" }, "description": [ "A flag, if True, indicating the the hash value contained in this ChecksumFile is confirmed to be correct for its associated data file." ], "brief": "A flag, if True, indicating the the hash value contained in this ChecksumFile is confirmed to be correct for its associated data file.", "anchor": "ChecksumFile.valid", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/properties/1" } }, { "id": "ChecksumFile.describes", "name": "describes", "label": "describes", "parentType": "ChecksumFile", "value": { "jsonType": "string", "display": "text (uri-reference)" }, "description": [], "brief": "", "anchor": "ChecksumFile.describes", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/properties/2" } }, { "id": "ChecksumFile.@id", "name": "@id", "label": "@id", "parentType": "ChecksumFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a (relative) identifier for the distribution" ], "brief": "a (relative) identifier for the distribution", "anchor": "Component.@id", "required": false, "inheritedFrom": { "type": "Component", "property": "@id", "anchor": "Component.@id" }, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/0/properties/0" } }, { "id": "ChecksumFile.@type", "name": "@type", "label": "@type", "parentType": "ChecksumFile", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": { "type": "Component", "property": "@type", "anchor": "Component.@type" }, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/0/properties/1" } }, { "id": "ChecksumFile.title", "name": "title", "label": "title", "parentType": "ChecksumFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": { "type": "Component", "property": "title", "anchor": "Component.title" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/0/properties/2" } }, { "id": "ChecksumFile.description", "name": "description", "label": "description", "parentType": "ChecksumFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": { "type": "Component", "property": "description", "anchor": "Component.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/0/properties/3" } }, { "id": "ChecksumFile.topic", "name": "topic", "label": "topic", "parentType": "ChecksumFile", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this component addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": { "type": "Component", "property": "topic", "anchor": "Component.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/0/properties/4" } }, { "id": "ChecksumFile.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "ChecksumFile", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": { "type": "Component", "property": "conformsTo", "anchor": "Component.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/0/properties/5" } }, { "id": "ChecksumFile.filepath", "name": "filepath", "label": "filepath", "parentType": "ChecksumFile", "value": { "jsonType": "string", "display": "text" }, "description": [ "a name for the data file reflecting its hierarchical location in the data source collection" ], "brief": "a name for the data file reflecting its hierarchical location in the data source collection", "anchor": "DownloadableFile.filepath", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "filepath", "anchor": "DownloadableFile.filepath" }, "schemaNotes": [ "Forward slashes delimit the hierarchical names in the path", "If there are no slashes in this value, this file is assumed to be at the top of the file hierarchy", "The base name of this value (i.e. the last field in the path) can be used as the default filename to give to the file if downloaded.", "The component title may have the same value." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/1/properties/0" } }, { "id": "ChecksumFile.downloadURL", "name": "downloadURL", "label": "Download URL", "parentType": "ChecksumFile", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "URL providing direct access to a downloadable file of a dataset" ], "brief": "URL providing direct access to a downloadable file of a dataset", "anchor": "DownloadableFile.downloadURL", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "downloadURL", "anchor": "DownloadableFile.downloadURL" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/1/properties/1" } }, { "id": "ChecksumFile.mediaType", "name": "mediaType", "label": "Media Type", "parentType": "ChecksumFile", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The machine-readable file format (IANA Media Type or MIME Type) of the file\u2019s downloadURL" ], "brief": "The machine-readable file format (IANA Media Type or MIME Type) of the file\u2019s downloadURL", "anchor": "DownloadableFile.mediaType", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "mediaType", "anchor": "DownloadableFile.mediaType" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/1/properties/2" } }, { "id": "ChecksumFile.format", "name": "format", "label": "Format", "parentType": "ChecksumFile", "value": { "jsonType": "object", "display": "Format object", "objectType": "Format" }, "description": [ "A human-readable description of the file format of a distribution" ], "brief": "A human-readable description of the file format of a distribution", "anchor": "DownloadableFile.format", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "format", "anchor": "DownloadableFile.format" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/1/properties/3" } }, { "id": "ChecksumFile.checksum", "name": "checksum", "label": "Checksum", "parentType": "ChecksumFile", "value": { "jsonType": "object", "display": "Checksum object", "objectType": "Checksum" }, "description": [ "a checksum for the file" ], "brief": "a checksum for the file", "anchor": "DownloadableFile.checksum", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "checksum", "anchor": "DownloadableFile.checksum" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/1/properties/4" } }, { "id": "ChecksumFile.size", "name": "size", "label": "size", "parentType": "ChecksumFile", "value": { "jsonType": "integer", "display": "integer" }, "description": [ "the size of the file in bytes" ], "brief": "the size of the file in bytes", "anchor": "DownloadableFile.size", "required": false, "inheritedFrom": { "type": "DownloadableFile", "property": "size", "anchor": "DownloadableFile.size" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18/inheritedProperties/1/properties/5" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/18" } }, { "id": "Subcollection", "name": "Subcollection", "label": "Subcollection", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "A grouping of components within a named subcollection of the resource" ], "brief": "A grouping of components within a named subcollection of the resource", "anchor": "Subcollection", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "components" } } ], "inheritsFrom": [ "Component" ], "properties": [ { "id": "Subcollection.filepath", "name": "filepath", "label": "filepath", "parentType": "Subcollection", "value": { "jsonType": "string", "display": "text" }, "description": [ "a name for the data file reflecting its hierarchical location in the data source collection" ], "brief": "a name for the data file reflecting its hierarchical location in the data source collection", "anchor": "Subcollection.filepath", "required": false, "inheritedFrom": null, "schemaNotes": [ "Forward slashes delimit the hierarchical names in the path", "If there are no slashes in this value, this file is assumed to be at the top of the file hierarchy", "The base name of this value (i.e. the last field in the path) can be used as the default filename to give to the file if downloaded.", "The component title may have the same value." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/properties/0" } }, { "id": "Subcollection.contains", "name": "contains", "label": "contains", "parentType": "Subcollection", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "a listing of resource components that are directly part of this subcollection" ], "brief": "a listing of resource components that are directly part of this subcollection", "anchor": "Subcollection.contains", "required": false, "inheritedFrom": null, "schemaNotes": [ "Each item is a URI identifier (possibly abbreviated)" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/properties/1" } }, { "id": "Subcollection.hasParent", "name": "hasParent", "label": "hasParent", "parentType": "Subcollection", "value": { "jsonType": "string", "display": "text" }, "description": [ "The identifier for the parent collection that contains this subcollection" ], "brief": "The identifier for the parent collection that contains this subcollection", "anchor": "Subcollection.hasParent", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/properties/2" } }, { "id": "Subcollection.@id", "name": "@id", "label": "@id", "parentType": "Subcollection", "value": { "jsonType": "string", "display": "text" }, "description": [ "a (relative) identifier for the distribution" ], "brief": "a (relative) identifier for the distribution", "anchor": "Component.@id", "required": false, "inheritedFrom": { "type": "Component", "property": "@id", "anchor": "Component.@id" }, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/inheritedProperties/0/properties/0" } }, { "id": "Subcollection.@type", "name": "@type", "label": "@type", "parentType": "Subcollection", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": { "type": "Component", "property": "@type", "anchor": "Component.@type" }, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/inheritedProperties/0/properties/1" } }, { "id": "Subcollection.title", "name": "title", "label": "title", "parentType": "Subcollection", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": { "type": "Component", "property": "title", "anchor": "Component.title" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/inheritedProperties/0/properties/2" } }, { "id": "Subcollection.description", "name": "description", "label": "description", "parentType": "Subcollection", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": { "type": "Component", "property": "description", "anchor": "Component.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/inheritedProperties/0/properties/3" } }, { "id": "Subcollection.topic", "name": "topic", "label": "topic", "parentType": "Subcollection", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this component addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": { "type": "Component", "property": "topic", "anchor": "Component.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/inheritedProperties/0/properties/4" } }, { "id": "Subcollection.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "Subcollection", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": { "type": "Component", "property": "conformsTo", "anchor": "Component.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20/inheritedProperties/0/properties/5" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/20" } }, { "id": "AccessPage", "name": "AccessPage", "label": "AccessPage", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "a web page that provides indirect access to the resource" ], "brief": "a web page that provides indirect access to the resource", "anchor": "AccessPage", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "components" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "SearchPage" } } ], "inheritsFrom": [ "Component" ], "properties": [ { "id": "AccessPage.accessURL", "name": "accessURL", "label": "accessURL", "parentType": "AccessPage", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the URL for accessing this indirect access to the resource" ], "brief": "the URL for accessing this indirect access to the resource", "anchor": "AccessPage.accessURL", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21/properties/0" } }, { "id": "AccessPage.format", "name": "format", "label": "Format", "parentType": "AccessPage", "value": { "jsonType": "object", "display": "Format object", "objectType": "Format" }, "description": [ "A human-readable description of the file format of a distribution" ], "brief": "A human-readable description of the file format of a distribution", "anchor": "AccessPage.format", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21/properties/1" } }, { "id": "AccessPage.@id", "name": "@id", "label": "@id", "parentType": "AccessPage", "value": { "jsonType": "string", "display": "text" }, "description": [ "a (relative) identifier for the distribution" ], "brief": "a (relative) identifier for the distribution", "anchor": "Component.@id", "required": false, "inheritedFrom": { "type": "Component", "property": "@id", "anchor": "Component.@id" }, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21/inheritedProperties/0/properties/0" } }, { "id": "AccessPage.@type", "name": "@type", "label": "@type", "parentType": "AccessPage", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": { "type": "Component", "property": "@type", "anchor": "Component.@type" }, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21/inheritedProperties/0/properties/1" } }, { "id": "AccessPage.title", "name": "title", "label": "title", "parentType": "AccessPage", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": { "type": "Component", "property": "title", "anchor": "Component.title" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21/inheritedProperties/0/properties/2" } }, { "id": "AccessPage.description", "name": "description", "label": "description", "parentType": "AccessPage", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": { "type": "Component", "property": "description", "anchor": "Component.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21/inheritedProperties/0/properties/3" } }, { "id": "AccessPage.topic", "name": "topic", "label": "topic", "parentType": "AccessPage", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this component addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": { "type": "Component", "property": "topic", "anchor": "Component.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21/inheritedProperties/0/properties/4" } }, { "id": "AccessPage.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "AccessPage", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": { "type": "Component", "property": "conformsTo", "anchor": "Component.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21/inheritedProperties/0/properties/5" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/21" } }, { "id": "SearchPage", "name": "SearchPage", "label": "SearchPage", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "a web page that can be used to search the contents of the resource" ], "brief": "a web page that can be used to search the contents of the resource", "anchor": "SearchPage", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "components" } } ], "inheritsFrom": [ "AccessPage" ], "properties": [ { "id": "SearchPage.@id", "name": "@id", "label": "@id", "parentType": "SearchPage", "value": { "jsonType": "string", "display": "text" }, "description": [ "a (relative) identifier for the distribution" ], "brief": "a (relative) identifier for the distribution", "anchor": "Component.@id", "required": false, "inheritedFrom": { "type": "Component", "property": "@id", "anchor": "Component.@id" }, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22/inheritedProperties/0/properties/0" } }, { "id": "SearchPage.@type", "name": "@type", "label": "@type", "parentType": "SearchPage", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": { "type": "Component", "property": "@type", "anchor": "Component.@type" }, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22/inheritedProperties/0/properties/1" } }, { "id": "SearchPage.title", "name": "title", "label": "title", "parentType": "SearchPage", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": { "type": "Component", "property": "title", "anchor": "Component.title" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22/inheritedProperties/0/properties/2" } }, { "id": "SearchPage.description", "name": "description", "label": "description", "parentType": "SearchPage", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": { "type": "Component", "property": "description", "anchor": "Component.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22/inheritedProperties/0/properties/3" } }, { "id": "SearchPage.topic", "name": "topic", "label": "topic", "parentType": "SearchPage", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this component addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": { "type": "Component", "property": "topic", "anchor": "Component.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22/inheritedProperties/0/properties/4" } }, { "id": "SearchPage.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "SearchPage", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": { "type": "Component", "property": "conformsTo", "anchor": "Component.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22/inheritedProperties/0/properties/5" } }, { "id": "SearchPage.accessURL", "name": "accessURL", "label": "accessURL", "parentType": "SearchPage", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the URL for accessing this indirect access to the resource" ], "brief": "the URL for accessing this indirect access to the resource", "anchor": "AccessPage.accessURL", "required": false, "inheritedFrom": { "type": "AccessPage", "property": "accessURL", "anchor": "AccessPage.accessURL" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22/inheritedProperties/1/properties/0" } }, { "id": "SearchPage.format", "name": "format", "label": "Format", "parentType": "SearchPage", "value": { "jsonType": "object", "display": "Format object", "objectType": "Format" }, "description": [ "A human-readable description of the file format of a distribution" ], "brief": "A human-readable description of the file format of a distribution", "anchor": "AccessPage.format", "required": false, "inheritedFrom": { "type": "AccessPage", "property": "format", "anchor": "AccessPage.format" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22/inheritedProperties/1/properties/1" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/22" } }, { "id": "API", "name": "API", "label": "API", "group": "Component", "valueType": "object", "displayType": "object", "description": [ "an application programming interface to the resource" ], "brief": "an application programming interface to the resource", "anchor": "API", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "components" } } ], "inheritsFrom": [ "Component" ], "properties": [ { "id": "API.accessURL", "name": "accessURL", "label": "accessURL", "parentType": "API", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the base URL for accessing the API.", "This URL may or may not be resolvable (consult the documentation at the describedBy URL). With some APIs, this base URL will return information for accessing the full capabilities of the service." ], "brief": "the base URL for accessing the API", "anchor": "API.accessURL", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/properties/0" } }, { "id": "API.describedBy", "name": "describedBy", "label": "API Description", "parentType": "API", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URL to a formal description or informal documentation of the API." ], "brief": "URL to a formal or informal description of the API", "anchor": "API.describedBy", "required": false, "inheritedFrom": null, "schemaNotes": [ "Use describedByType to help distinguish between formal and informal (i.e. human readable) descriptions." ], "readerNotes": [ "Use describedByType to help distinguish between formal and informal (i.e. human readable) descriptions: no describedByType value should indicate a human-readable document." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/properties/1" } }, { "id": "API.describedByType", "name": "describedByType", "label": "API Descriptions Type", "parentType": "API", "value": { "jsonType": "null | string", "display": "text" }, "description": [ "The machine-readable file format (IANA Media Type or MIME Type) of the API's describedBy URL." ], "brief": "The machine-readable file format (IANA Media Type or MIME Type) of the API's describedBy URL", "anchor": "API.describedByType", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [ "If no value is given for this property, it can be assumed that the document given by the describedBy URL is human-readable documentation for the API." ], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/properties/2" } }, { "id": "API.@id", "name": "@id", "label": "@id", "parentType": "API", "value": { "jsonType": "string", "display": "text" }, "description": [ "a (relative) identifier for the distribution" ], "brief": "a (relative) identifier for the distribution", "anchor": "Component.@id", "required": false, "inheritedFrom": { "type": "Component", "property": "@id", "anchor": "Component.@id" }, "schemaNotes": [ "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/inheritedProperties/0/properties/0" } }, { "id": "API.@type", "name": "@type", "label": "@type", "parentType": "API", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "the types of components that this component can be classified as" ], "brief": "the types of components that this component can be classified as", "anchor": "Component.@type", "required": false, "inheritedFrom": { "type": "Component", "property": "@type", "anchor": "Component.@type" }, "schemaNotes": [ "the first value should be considered its primary type. This is usually a subtype of Component." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/inheritedProperties/0/properties/1" } }, { "id": "API.title", "name": "title", "label": "title", "parentType": "API", "value": { "jsonType": "string", "display": "text" }, "description": [ "a descriptive title for the component" ], "brief": "a descriptive title for the component", "anchor": "Component.title", "required": false, "inheritedFrom": { "type": "Component", "property": "title", "anchor": "Component.title" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/inheritedProperties/0/properties/2" } }, { "id": "API.description", "name": "description", "label": "description", "parentType": "API", "value": { "jsonType": "string", "display": "text" }, "description": [ "a description of the nature and contents of the component, including the role it plays as part of the resource" ], "brief": "a description of the nature and contents of the component, including the role it plays as part of the resource", "anchor": "Component.description", "required": false, "inheritedFrom": { "type": "Component", "property": "description", "anchor": "Component.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/inheritedProperties/0/properties/3" } }, { "id": "API.topic", "name": "topic", "label": "topic", "parentType": "API", "value": { "jsonType": "array", "display": "list of Topic objects", "itemType": "Topic" }, "description": [ "Identified tags referring to things or concepts that this component addresses or speaks to" ], "brief": "Identified tags referring to things or concepts that this component addresses or speaks to", "anchor": "Component.topic", "required": false, "inheritedFrom": { "type": "Component", "property": "topic", "anchor": "Component.topic" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/inheritedProperties/0/properties/4" } }, { "id": "API.conformsTo", "name": "conformsTo", "label": "Standard", "parentType": "API", "value": { "jsonType": "null | string", "display": "text (URL)" }, "description": [ "URI used to identify a standardized specification the component conforms to" ], "brief": "URI used to identify a standardized specification the component conforms to", "anchor": "Component.conformsTo", "required": false, "inheritedFrom": { "type": "Component", "property": "conformsTo", "anchor": "Component.conformsTo" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23/inheritedProperties/0/properties/5" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/23" } }, { "id": "FlexibleDate", "name": "FlexibleDate", "label": "FlexibleDate", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a flexible format for a resource-related date" ], "brief": "a flexible format for a resource-related date", "anchor": "FlexibleDate", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "issued", "type": "Resource" } }, { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "issued", "type": "RelatedResource" } } ], "inheritsFrom": [], "properties": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/1" } }, { "id": "RelatedResource", "name": "RelatedResource", "label": "RelatedResource", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a descriptive reference to another resource that related to this one" ], "brief": "a descriptive reference to another resource", "anchor": "RelatedResource", "usage": [ { "id": "value-part", "template": "as a part of the value type for the {prop} property of the {type} type", "data": { "prop": "isReplacedBy", "type": "Resource" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "ResourceReference" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "VersionRelease" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "BibliographicReference" } } ], "inheritsFrom": [], "properties": [ { "id": "RelatedResource.@id", "name": "@id", "label": "@id", "parentType": "RelatedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "an identifier for the reference" ], "brief": "an identifier for the reference", "anchor": "RelatedResource.@id", "required": false, "inheritedFrom": null, "schemaNotes": [ "The most well-known PID used to identify the resource (see also notes for proxyFor", "This identifier can be a relative URL which can be used in special cases (See the notes for BibliographicReference:@type for when this ID should not refer to the referenced work).", "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2/properties/0" } }, { "id": "RelatedResource.@type", "name": "@type", "label": "@type", "parentType": "RelatedResource", "value": { "jsonType": "array | null | string", "display": "text or list of text values", "itemType": "string" }, "description": [], "brief": "", "anchor": "RelatedResource.@type", "required": false, "inheritedFrom": null, "schemaNotes": [ "The single string value option is provided for backward compatibility (and may be removed in future versions; see BibliographicReference). When this is used, the node represents a reference and not the thing being referenced; the @id contains a relative URI, representing this reference" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2/properties/1" } }, { "id": "RelatedResource.title", "name": "title", "label": "title", "parentType": "RelatedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "the name of the resource being referenced" ], "brief": "the name of the resource being referenced", "anchor": "RelatedResource.title", "required": false, "inheritedFrom": null, "schemaNotes": [ "This value is intended for display.", "This can be, but is not required to be, the same title given in the metadata record describing the resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2/properties/2" } }, { "id": "RelatedResource.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "RelatedResource", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this resource" ], "brief": "a local identifier representing this resource", "anchor": "RelatedResource.proxyFor", "required": false, "inheritedFrom": null, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the resource as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2/properties/3" } }, { "id": "RelatedResource.location", "name": "location", "label": "location", "parentType": "RelatedResource", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the URL for accessing the resource" ], "brief": "the URL for accessing the resource", "anchor": "RelatedResource.location", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2/properties/4" } }, { "id": "RelatedResource.label", "name": "label", "label": "label", "parentType": "RelatedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "a recommended label or title to display as the text for a link to the document" ], "brief": "a recommended label or title to display as the text for a link to the document", "anchor": "RelatedResource.label", "required": false, "inheritedFrom": null, "schemaNotes": [ "This is intended to be briefer than a citation. It should be short enough to use as tag to an entry in reference list as inserted into a document's text" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2/properties/5" } }, { "id": "RelatedResource.issued", "name": "issued", "label": "issued", "parentType": "RelatedResource", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "The date the referenced resource was issued" ], "brief": "The date the referenced resource was issued", "anchor": "RelatedResource.issued", "required": false, "inheritedFrom": null, "schemaNotes": [ "This is intended for determining relative newness--i.e. being newer or older than the referring resource." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2/properties/6" } }, { "id": "RelatedResource.description", "name": "description", "label": "description", "parentType": "RelatedResource", "value": { "jsonType": "string", "display": "text" }, "description": [ "a brief, human-readable description of what this reference refers to and/or why it is being referenced." ], "brief": "a brief, human-readable description of what this reference refers to and/or why it is being referenced.", "anchor": "RelatedResource.description", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2/properties/7" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/2" } }, { "id": "ResourceReference", "name": "ResourceReference", "label": "ResourceReference", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a reference to another resource that may have an associated ID" ], "brief": "a reference to another resource that may have an associated ID", "anchor": "ResourceReference", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "isPartOf", "type": "Resource" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "IncludedResource" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "Affiliation" } } ], "inheritsFrom": [ "RelatedResource" ], "properties": [ { "id": "ResourceReference.@id", "name": "@id", "label": "@id", "parentType": "ResourceReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "an identifier for the reference" ], "brief": "an identifier for the reference", "anchor": "RelatedResource.@id", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@id", "anchor": "RelatedResource.@id" }, "schemaNotes": [ "The most well-known PID used to identify the resource (see also notes for proxyFor", "This identifier can be a relative URL which can be used in special cases (See the notes for BibliographicReference:@type for when this ID should not refer to the referenced work).", "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3/inheritedProperties/0/properties/0" } }, { "id": "ResourceReference.@type", "name": "@type", "label": "@type", "parentType": "ResourceReference", "value": { "jsonType": "array | null | string", "display": "text or list of text values", "itemType": "string" }, "description": [], "brief": "", "anchor": "RelatedResource.@type", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@type", "anchor": "RelatedResource.@type" }, "schemaNotes": [ "The single string value option is provided for backward compatibility (and may be removed in future versions; see BibliographicReference). When this is used, the node represents a reference and not the thing being referenced; the @id contains a relative URI, representing this reference" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3/inheritedProperties/0/properties/1" } }, { "id": "ResourceReference.title", "name": "title", "label": "title", "parentType": "ResourceReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "the name of the resource being referenced" ], "brief": "the name of the resource being referenced", "anchor": "RelatedResource.title", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "title", "anchor": "RelatedResource.title" }, "schemaNotes": [ "This value is intended for display.", "This can be, but is not required to be, the same title given in the metadata record describing the resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3/inheritedProperties/0/properties/2" } }, { "id": "ResourceReference.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "ResourceReference", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this resource" ], "brief": "a local identifier representing this resource", "anchor": "RelatedResource.proxyFor", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "proxyFor", "anchor": "RelatedResource.proxyFor" }, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the resource as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3/inheritedProperties/0/properties/3" } }, { "id": "ResourceReference.location", "name": "location", "label": "location", "parentType": "ResourceReference", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the URL for accessing the resource" ], "brief": "the URL for accessing the resource", "anchor": "RelatedResource.location", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "location", "anchor": "RelatedResource.location" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3/inheritedProperties/0/properties/4" } }, { "id": "ResourceReference.label", "name": "label", "label": "label", "parentType": "ResourceReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a recommended label or title to display as the text for a link to the document" ], "brief": "a recommended label or title to display as the text for a link to the document", "anchor": "RelatedResource.label", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "label", "anchor": "RelatedResource.label" }, "schemaNotes": [ "This is intended to be briefer than a citation. It should be short enough to use as tag to an entry in reference list as inserted into a document's text" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3/inheritedProperties/0/properties/5" } }, { "id": "ResourceReference.issued", "name": "issued", "label": "issued", "parentType": "ResourceReference", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "The date the referenced resource was issued" ], "brief": "The date the referenced resource was issued", "anchor": "RelatedResource.issued", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "issued", "anchor": "RelatedResource.issued" }, "schemaNotes": [ "This is intended for determining relative newness--i.e. being newer or older than the referring resource." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3/inheritedProperties/0/properties/6" } }, { "id": "ResourceReference.description", "name": "description", "label": "description", "parentType": "ResourceReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a brief, human-readable description of what this reference refers to and/or why it is being referenced." ], "brief": "a brief, human-readable description of what this reference refers to and/or why it is being referenced.", "anchor": "RelatedResource.description", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "description", "anchor": "RelatedResource.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3/inheritedProperties/0/properties/7" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/3" } }, { "id": "VersionRelease", "name": "VersionRelease", "label": "VersionRelease", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "notes about a versioned release of the resource" ], "brief": "notes about a versioned release of the resource", "anchor": "VersionRelease", "usage": [ { "id": "list-type", "template": "as a value type for the {prop} list property of the {type} type", "data": { "prop": "versionHistory", "type": "Resource" } } ], "inheritsFrom": [ "RelatedResource" ], "properties": [ { "id": "VersionRelease.version", "name": "version", "label": "Version", "parentType": "VersionRelease", "value": { "jsonType": "string", "display": "text" }, "description": [ "a string indicating a version of the release of this resource" ], "brief": "a string indicating a version of the release of this resource", "anchor": "VersionRelease.version", "required": false, "inheritedFrom": null, "schemaNotes": [ "label could contain the same value" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/properties/0" } }, { "id": "VersionRelease.@id", "name": "@id", "label": "@id", "parentType": "VersionRelease", "value": { "jsonType": "string", "display": "text" }, "description": [ "an identifier for the reference" ], "brief": "an identifier for the reference", "anchor": "RelatedResource.@id", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@id", "anchor": "RelatedResource.@id" }, "schemaNotes": [ "The most well-known PID used to identify the resource (see also notes for proxyFor", "This identifier can be a relative URL which can be used in special cases (See the notes for BibliographicReference:@type for when this ID should not refer to the referenced work).", "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/inheritedProperties/0/properties/0" } }, { "id": "VersionRelease.@type", "name": "@type", "label": "@type", "parentType": "VersionRelease", "value": { "jsonType": "array | null | string", "display": "text or list of text values", "itemType": "string" }, "description": [], "brief": "", "anchor": "RelatedResource.@type", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@type", "anchor": "RelatedResource.@type" }, "schemaNotes": [ "The single string value option is provided for backward compatibility (and may be removed in future versions; see BibliographicReference). When this is used, the node represents a reference and not the thing being referenced; the @id contains a relative URI, representing this reference" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/inheritedProperties/0/properties/1" } }, { "id": "VersionRelease.title", "name": "title", "label": "title", "parentType": "VersionRelease", "value": { "jsonType": "string", "display": "text" }, "description": [ "the name of the resource being referenced" ], "brief": "the name of the resource being referenced", "anchor": "RelatedResource.title", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "title", "anchor": "RelatedResource.title" }, "schemaNotes": [ "This value is intended for display.", "This can be, but is not required to be, the same title given in the metadata record describing the resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/inheritedProperties/0/properties/2" } }, { "id": "VersionRelease.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "VersionRelease", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this resource" ], "brief": "a local identifier representing this resource", "anchor": "RelatedResource.proxyFor", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "proxyFor", "anchor": "RelatedResource.proxyFor" }, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the resource as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/inheritedProperties/0/properties/3" } }, { "id": "VersionRelease.location", "name": "location", "label": "location", "parentType": "VersionRelease", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the URL for accessing the resource" ], "brief": "the URL for accessing the resource", "anchor": "RelatedResource.location", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "location", "anchor": "RelatedResource.location" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/inheritedProperties/0/properties/4" } }, { "id": "VersionRelease.label", "name": "label", "label": "label", "parentType": "VersionRelease", "value": { "jsonType": "string", "display": "text" }, "description": [ "a recommended label or title to display as the text for a link to the document" ], "brief": "a recommended label or title to display as the text for a link to the document", "anchor": "RelatedResource.label", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "label", "anchor": "RelatedResource.label" }, "schemaNotes": [ "This is intended to be briefer than a citation. It should be short enough to use as tag to an entry in reference list as inserted into a document's text" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/inheritedProperties/0/properties/5" } }, { "id": "VersionRelease.issued", "name": "issued", "label": "issued", "parentType": "VersionRelease", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "The date the referenced resource was issued" ], "brief": "The date the referenced resource was issued", "anchor": "RelatedResource.issued", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "issued", "anchor": "RelatedResource.issued" }, "schemaNotes": [ "This is intended for determining relative newness--i.e. being newer or older than the referring resource." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/inheritedProperties/0/properties/6" } }, { "id": "VersionRelease.description", "name": "description", "label": "description", "parentType": "VersionRelease", "value": { "jsonType": "string", "display": "text" }, "description": [ "a brief, human-readable description of what this reference refers to and/or why it is being referenced." ], "brief": "a brief, human-readable description of what this reference refers to and/or why it is being referenced.", "anchor": "RelatedResource.description", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "description", "anchor": "RelatedResource.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4/inheritedProperties/0/properties/7" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/4" } }, { "id": "BibliographicReference", "name": "BibliographicReference", "label": "BibliographicReference", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a reference to a creative work that provides information or data that is important to this resource." ], "brief": "a reference to a creative work that provides information or data that is important to this resource.", "anchor": "BibliographicReference", "usage": [ { "id": "list-type", "template": "as a value type for the {prop} list property of the {type} type", "data": { "prop": "references", "type": "Resource" } }, { "id": "base-type", "template": "as the basis for extension type, {type}", "data": { "type": "DCiteReference" } } ], "inheritsFrom": [ "RelatedResource" ], "properties": [ { "id": "BibliographicReference.citation", "name": "citation", "label": "citation", "parentType": "BibliographicReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a full formated citation string for the reference, appropriate for inclusion in a bibliography" ], "brief": "a full formated citation string for the reference, appropriate for inclusion in a bibliography", "anchor": "BibliographicReference.citation", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/properties/0" } }, { "id": "BibliographicReference.refType", "name": "refType", "label": "refType", "parentType": "BibliographicReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "the type of relationship that this document has with the resource" ], "brief": "the type of relationship that this document has with the resource", "anchor": "BibliographicReference.refType", "required": false, "inheritedFrom": null, "schemaNotes": [ "This is equivalent to the Datacite relationType in that the term is a predicate that connects the resource as the subject to the referenced document as the object (e.g. resource IsDocumentedBy referenced-doc)", "The DCiteReference type sets DataCite terms as controlled vocabulary" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/properties/1" } }, { "id": "BibliographicReference.@id", "name": "@id", "label": "@id", "parentType": "BibliographicReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "an identifier for the reference" ], "brief": "an identifier for the reference", "anchor": "RelatedResource.@id", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@id", "anchor": "RelatedResource.@id" }, "schemaNotes": [ "The most well-known PID used to identify the resource (see also notes for proxyFor", "This identifier can be a relative URL which can be used in special cases (See the notes for BibliographicReference:@type for when this ID should not refer to the referenced work).", "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/inheritedProperties/0/properties/0" } }, { "id": "BibliographicReference.@type", "name": "@type", "label": "@type", "parentType": "BibliographicReference", "value": { "jsonType": "array | null | string", "display": "text or list of text values", "itemType": "string" }, "description": [], "brief": "", "anchor": "RelatedResource.@type", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@type", "anchor": "RelatedResource.@type" }, "schemaNotes": [ "The single string value option is provided for backward compatibility (and may be removed in future versions; see BibliographicReference). When this is used, the node represents a reference and not the thing being referenced; the @id contains a relative URI, representing this reference" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/inheritedProperties/0/properties/1" } }, { "id": "BibliographicReference.title", "name": "title", "label": "title", "parentType": "BibliographicReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "the name of the resource being referenced" ], "brief": "the name of the resource being referenced", "anchor": "RelatedResource.title", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "title", "anchor": "RelatedResource.title" }, "schemaNotes": [ "This value is intended for display.", "This can be, but is not required to be, the same title given in the metadata record describing the resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/inheritedProperties/0/properties/2" } }, { "id": "BibliographicReference.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "BibliographicReference", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this resource" ], "brief": "a local identifier representing this resource", "anchor": "RelatedResource.proxyFor", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "proxyFor", "anchor": "RelatedResource.proxyFor" }, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the resource as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/inheritedProperties/0/properties/3" } }, { "id": "BibliographicReference.location", "name": "location", "label": "location", "parentType": "BibliographicReference", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the URL for accessing the resource" ], "brief": "the URL for accessing the resource", "anchor": "RelatedResource.location", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "location", "anchor": "RelatedResource.location" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/inheritedProperties/0/properties/4" } }, { "id": "BibliographicReference.label", "name": "label", "label": "label", "parentType": "BibliographicReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a recommended label or title to display as the text for a link to the document" ], "brief": "a recommended label or title to display as the text for a link to the document", "anchor": "RelatedResource.label", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "label", "anchor": "RelatedResource.label" }, "schemaNotes": [ "This is intended to be briefer than a citation. It should be short enough to use as tag to an entry in reference list as inserted into a document's text" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/inheritedProperties/0/properties/5" } }, { "id": "BibliographicReference.issued", "name": "issued", "label": "issued", "parentType": "BibliographicReference", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "The date the referenced resource was issued" ], "brief": "The date the referenced resource was issued", "anchor": "RelatedResource.issued", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "issued", "anchor": "RelatedResource.issued" }, "schemaNotes": [ "This is intended for determining relative newness--i.e. being newer or older than the referring resource." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/inheritedProperties/0/properties/6" } }, { "id": "BibliographicReference.description", "name": "description", "label": "description", "parentType": "BibliographicReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a brief, human-readable description of what this reference refers to and/or why it is being referenced." ], "brief": "a brief, human-readable description of what this reference refers to and/or why it is being referenced.", "anchor": "RelatedResource.description", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "description", "anchor": "RelatedResource.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5/inheritedProperties/0/properties/7" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/5" } }, { "id": "DCiteReference", "name": "DCiteReference", "label": "DCiteReference", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a bibliographical reference with a controlled vocabulary for its reference type (refType)" ], "brief": "a bibliographical reference with a controlled vocabulary for its reference type (refType)", "anchor": "DCiteReference", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "references" } } ], "inheritsFrom": [ "BibliographicReference" ], "properties": [ { "id": "DCiteReference.refType", "name": "refType", "label": "refType", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a term indicating the nature of the relationship between this resource and the one being referenced" ], "brief": "a term indicating the nature of the relationship between this resource and the one being referenced", "anchor": "DCiteReference.refType", "required": false, "inheritedFrom": null, "schemaNotes": [ "Note that with this term, the subject of relationship is the resource described by this NERDm record and the object is the referenced resource given by the @id property in this node. Although this violates the JSON-LD semantics that properties in this node should describe what's given with the local @id--the referenced resource, in this case--it is more consistant with their use in the DataCite schema." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/properties/0" }, "allowedValues": [ { "value": "IsDocumentedBy", "description": "The referenced document provides documentation of this resource." }, { "value": "IsSupplementedTo", "description": "The referenced document is a supplement to this resource." }, { "value": "IsCitedBy", "description": "The referenced document cites the resource in some way." }, { "value": "Cites", "description": "This resource cites the referenced document." }, { "value": "IsReviewedBy", "description": "The referenced document reviews this resource." }, { "value": "IsReferencedBy", "description": "The resource is used as a source of information by the referenced document." }, { "value": "References", "description": "The referenced document is used as a source of information by the resource." }, { "value": "IsSourceOf", "description": "The resource is the source of upon which the referenced resource is based." }, { "value": "IsDerivedFrom", "description": "The referenced document is the source upon which the resource is based." }, { "value": "IsNewVersionOf", "description": "The referenced resource is a previous version of this resource." }, { "value": "IsPreviousVersionOf", "description": "The referenced resource is a newer version of this resource." }, { "value": "IsVariantOf", "description": "The referenced resource contains the content of this resource in a different form." } ] }, { "id": "DCiteReference.@id", "name": "@id", "label": "@id", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "an identifier for the reference" ], "brief": "an identifier for the reference", "anchor": "RelatedResource.@id", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@id", "anchor": "RelatedResource.@id" }, "schemaNotes": [ "The most well-known PID used to identify the resource (see also notes for proxyFor", "This identifier can be a relative URL which can be used in special cases (See the notes for BibliographicReference:@type for when this ID should not refer to the referenced work).", "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/0/properties/0" } }, { "id": "DCiteReference.@type", "name": "@type", "label": "@type", "parentType": "DCiteReference", "value": { "jsonType": "array | null | string", "display": "text or list of text values", "itemType": "string" }, "description": [], "brief": "", "anchor": "RelatedResource.@type", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@type", "anchor": "RelatedResource.@type" }, "schemaNotes": [ "The single string value option is provided for backward compatibility (and may be removed in future versions; see BibliographicReference). When this is used, the node represents a reference and not the thing being referenced; the @id contains a relative URI, representing this reference" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/0/properties/1" } }, { "id": "DCiteReference.title", "name": "title", "label": "title", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "the name of the resource being referenced" ], "brief": "the name of the resource being referenced", "anchor": "RelatedResource.title", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "title", "anchor": "RelatedResource.title" }, "schemaNotes": [ "This value is intended for display.", "This can be, but is not required to be, the same title given in the metadata record describing the resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/0/properties/2" } }, { "id": "DCiteReference.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this resource" ], "brief": "a local identifier representing this resource", "anchor": "RelatedResource.proxyFor", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "proxyFor", "anchor": "RelatedResource.proxyFor" }, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the resource as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/0/properties/3" } }, { "id": "DCiteReference.location", "name": "location", "label": "location", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the URL for accessing the resource" ], "brief": "the URL for accessing the resource", "anchor": "RelatedResource.location", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "location", "anchor": "RelatedResource.location" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/0/properties/4" } }, { "id": "DCiteReference.label", "name": "label", "label": "label", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a recommended label or title to display as the text for a link to the document" ], "brief": "a recommended label or title to display as the text for a link to the document", "anchor": "RelatedResource.label", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "label", "anchor": "RelatedResource.label" }, "schemaNotes": [ "This is intended to be briefer than a citation. It should be short enough to use as tag to an entry in reference list as inserted into a document's text" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/0/properties/5" } }, { "id": "DCiteReference.issued", "name": "issued", "label": "issued", "parentType": "DCiteReference", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "The date the referenced resource was issued" ], "brief": "The date the referenced resource was issued", "anchor": "RelatedResource.issued", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "issued", "anchor": "RelatedResource.issued" }, "schemaNotes": [ "This is intended for determining relative newness--i.e. being newer or older than the referring resource." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/0/properties/6" } }, { "id": "DCiteReference.description", "name": "description", "label": "description", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a brief, human-readable description of what this reference refers to and/or why it is being referenced." ], "brief": "a brief, human-readable description of what this reference refers to and/or why it is being referenced.", "anchor": "RelatedResource.description", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "description", "anchor": "RelatedResource.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/0/properties/7" } }, { "id": "DCiteReference.citation", "name": "citation", "label": "citation", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "a full formated citation string for the reference, appropriate for inclusion in a bibliography" ], "brief": "a full formated citation string for the reference, appropriate for inclusion in a bibliography", "anchor": "BibliographicReference.citation", "required": false, "inheritedFrom": { "type": "BibliographicReference", "property": "citation", "anchor": "BibliographicReference.citation" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/1/properties/0" } }, { "id": "DCiteReference.refType", "name": "refType", "label": "refType", "parentType": "DCiteReference", "value": { "jsonType": "string", "display": "text" }, "description": [ "the type of relationship that this document has with the resource" ], "brief": "the type of relationship that this document has with the resource", "anchor": "BibliographicReference.refType", "required": false, "inheritedFrom": { "type": "BibliographicReference", "property": "refType", "anchor": "BibliographicReference.refType" }, "schemaNotes": [ "This is equivalent to the Datacite relationType in that the term is a predicate that connects the resource as the subject to the referenced document as the object (e.g. resource IsDocumentedBy referenced-doc)", "The DCiteReference type sets DataCite terms as controlled vocabulary" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6/inheritedProperties/1/properties/1" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/6" } }, { "id": "ISO8601DateRange", "name": "ISO8601DateRange", "label": "ISO8601DateRange", "group": "Other", "valueType": "string", "displayType": "text", "description": [ "a single date-time, a date range, or a periodic time interval compliant with the ISO 8601 standard for date-times and intervals", "The format of the value is restricted to 3 forms. A single date has the form YYYY-MM-DDThh:mm:ss.sTZD, as in \"2017-03-24T03:45:33.1\"; note that any lowere precision version of this form is acceptable, such as \"2017-03-24\" or \"2017\".", "A date range is expressed with two single dates in the above form separated by a forward slash (/)--as, in \"2016-01/2016-12\"", "The third form from indicates a periodic interval, used to indicate that a resource is updated on a regular basis. Examples include \"R/P1D\" for daily, \"R5/P2W\" for 5 times, every 2 weeks. Consult the ISO 8601 standard for the detailed syntax." ], "brief": "a single date-time, date-time range, or a periodic time interval", "anchor": "ISO8601DateRange", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "modified", "type": "Resource" } } ], "inheritsFrom": [], "properties": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/9" } }, { "id": "Topic", "name": "Topic", "label": "Topic", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a container for an identified concept term or proper thing" ], "brief": "a container for an identified concept term or proper thing", "anchor": "Topic", "usage": [ { "id": "list-type", "template": "as a value type for the {prop} list property of the {type} type", "data": { "prop": "topic", "type": "Resource" } }, { "id": "list-type", "template": "as a value type for the {prop} list property of the {type} type", "data": { "prop": "topic", "type": "Component" } }, { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "algorithm", "type": "Checksum" } } ], "inheritsFrom": [], "properties": [ { "id": "Topic.@type", "name": "@type", "label": "@type", "parentType": "Topic", "value": { "jsonType": "string", "display": "text" }, "description": [ "a label indicating whether the value refers to a concept or a thing" ], "brief": "a label indicating whether the value refers to a concept or a thing", "anchor": "Topic.@type", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/10/properties/0" }, "allowedValues": [ { "value": "Concept", "description": "label indicating that the value refers to a concept (as in owl:Concept)" }, { "value": "Thing", "description": "label indicating that the value refers to a named person, place, or thing (as in skos:Thing)" } ] }, { "id": "Topic.scheme", "name": "scheme", "label": "scheme", "parentType": "Topic", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a URI that identifies the controlled vocabulary, registry, or identifier system that the value is defined in." ], "brief": "a URI that identifies the controlled vocabulary, registry, or identifier system that the value is defined in.", "anchor": "Topic.scheme", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/10/properties/1" } }, { "id": "Topic.@id", "name": "@id", "label": "@id", "parentType": "Topic", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the unique identifier identifying the concept or thing" ], "brief": "the unique identifier identifying the concept or thing", "anchor": "Topic.@id", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/10/properties/2" } }, { "id": "Topic.tag", "name": "tag", "label": "tag", "parentType": "Topic", "value": { "jsonType": "string", "display": "text" }, "description": [ "a short, display-able token that locally represents the concept or thing" ], "brief": "a short, display-able token that locally represents the concept or thing", "anchor": "Topic.tag", "required": false, "inheritedFrom": null, "schemaNotes": [ "As a token, it is intended that applications can search for this value and find all resources that are talking about the same thing. Thus, regardless of whether the @id field is provided, all references to the same concept or thing should use the same tag value." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/10/properties/3" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/10" } }, { "id": "Organization", "name": "Organization", "label": "Organization", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a named organization that may be part of a larger organization" ], "brief": "a named organization that may be part of a larger organization", "anchor": "Organization", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "publisher", "type": "Resource" } }, { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "subOrganizationOf", "type": "Organization" } } ], "inheritsFrom": [], "properties": [ { "id": "Organization.@type", "name": "@type", "label": "Metadata Context", "parentType": "Organization", "value": { "jsonType": "string", "display": "text" }, "description": [ "IRI for the JSON-LD data type. This should be org:Organization for each publisher" ], "brief": "IRI for the JSON-LD data type. This should be org:Organization for each publisher", "anchor": "Organization.@type", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/11/properties/0" } }, { "id": "Organization.name", "name": "name", "label": "Publisher Name", "parentType": "Organization", "value": { "jsonType": "string", "display": "text" }, "description": [ "The plain-text name of the organization" ], "brief": "The plain-text name of the organization", "anchor": "Organization.name", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/11/properties/1" } }, { "id": "Organization.subOrganizationOf", "name": "subOrganizationOf", "label": "subOrganizationOf", "parentType": "Organization", "value": { "jsonType": "object", "display": "Organization object", "objectType": "Organization" }, "description": [ "A parent organizational entity" ], "brief": "A parent organizational entity", "anchor": "Organization.subOrganizationOf", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/11/properties/2" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/11" } }, { "id": "ContactInfo", "name": "ContactInfo", "label": "ContactInfo", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "Information describing various ways to contact an entity" ], "brief": "Information describing various ways to contact an entity", "anchor": "ContactInfo", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "contactPoint", "type": "Resource" } } ], "inheritsFrom": [], "properties": [ { "id": "ContactInfo.@type", "name": "@type", "label": "@type", "parentType": "ContactInfo", "value": { "jsonType": "string", "display": "text" }, "description": [], "brief": "", "anchor": "ContactInfo.@type", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/12/properties/0" } }, { "id": "ContactInfo.fn", "name": "fn", "label": "Contact Name", "parentType": "ContactInfo", "value": { "jsonType": "string", "display": "text" }, "description": [ "full name of the contact person, role, or organization" ], "brief": "full name of the contact person, role, or organization", "anchor": "ContactInfo.fn", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/12/properties/1" } }, { "id": "ContactInfo.hasEmail", "name": "hasEmail", "label": "Email", "parentType": "ContactInfo", "value": { "jsonType": "string", "display": "text" }, "description": [ "The email address of the resource contact" ], "brief": "The email address of the resource contact", "anchor": "ContactInfo.hasEmail", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/12/properties/2" } }, { "id": "ContactInfo.postalAddress", "name": "postalAddress", "label": "postalAddress", "parentType": "ContactInfo", "value": { "jsonType": "object", "display": "PostalAddress object", "objectType": "PostalAddress" }, "description": [ "the contact mailing address" ], "brief": "the contact mailing address", "anchor": "ContactInfo.postalAddress", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/12/properties/3" } }, { "id": "ContactInfo.phoneNumber", "name": "phoneNumber", "label": "phoneNumber", "parentType": "ContactInfo", "value": { "jsonType": "string", "display": "text" }, "description": [ "the contact telephone number" ], "brief": "the contact telephone number", "anchor": "ContactInfo.phoneNumber", "required": false, "inheritedFrom": null, "schemaNotes": [ "Complete international dialing codes should be given, e.g. '+1-410-338-1234'" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/12/properties/4" } }, { "id": "ContactInfo.timezone", "name": "timezone", "label": "timezone", "parentType": "ContactInfo", "value": { "jsonType": "string", "display": "text" }, "description": [ "the time zone where the contact typically operates" ], "brief": "the time zone where the contact typically operates", "anchor": "ContactInfo.timezone", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/12/properties/5" } }, { "id": "ContactInfo.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "ContactInfo", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this person" ], "brief": "a local identifier representing this person", "anchor": "ContactInfo.proxyFor", "required": false, "inheritedFrom": null, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the person as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/12/properties/6" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/12" } }, { "id": "PostalAddress", "name": "PostalAddress", "label": "PostalAddress", "group": "Other", "valueType": "array", "displayType": "list of text values", "description": [ "a line-delimited listing of a postal address" ], "brief": "a line-delimited listing of a postal address", "anchor": "PostalAddress", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "postalAddress", "type": "ContactInfo" } } ], "inheritsFrom": [], "properties": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/13" } }, { "id": "Identifier", "name": "Identifier", "label": "Identifier", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a complete description of an identifier, including the scheme that it adheres to" ], "brief": "a complete description of an identifier, including the scheme that it adheres to", "anchor": "Identifier", "usage": [], "inheritsFrom": [], "properties": [ { "id": "Identifier.scheme", "name": "scheme", "label": "scheme", "parentType": "Identifier", "value": { "jsonType": "string", "display": "text" }, "description": [ "a label indicating the system that the identifier adheres to" ], "brief": "a label indicating the system that the identifier adheres to", "anchor": "Identifier.scheme", "required": false, "inheritedFrom": null, "schemaNotes": [ "this label may imply a particular resolver to use" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/14/properties/0" } }, { "id": "Identifier.value", "name": "value", "label": "value", "parentType": "Identifier", "value": { "jsonType": "string", "display": "text" }, "description": [ "the value of the identifier" ], "brief": "the value of the identifier", "anchor": "Identifier.value", "required": false, "inheritedFrom": null, "schemaNotes": [ "if no scheme is provided, a URI form of the identifier should be given" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/14/properties/1" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/14" } }, { "id": "Checksum", "name": "Checksum", "label": "Checksum", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a checksum with its algorithm noted" ], "brief": "a checksum with its algorithm noted", "anchor": "Checksum", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "checksum", "type": "DownloadableFile" } } ], "inheritsFrom": [], "properties": [ { "id": "Checksum.algorithm", "name": "algorithm", "label": "algorithm", "parentType": "Checksum", "value": { "jsonType": "object", "display": "Topic object", "objectType": "Topic" }, "description": [ "the algorithm used to produce the checksum hash" ], "brief": "the algorithm used to produce the checksum hash", "anchor": "Checksum.algorithm", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/19/properties/0" } }, { "id": "Checksum.hash", "name": "hash", "label": "hash", "parentType": "Checksum", "value": { "jsonType": "string", "display": "text" }, "description": [ "the checksum value" ], "brief": "the checksum value", "anchor": "Checksum.hash", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/19/properties/1" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/19" } }, { "id": "Format", "name": "Format", "label": "Format", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a description of a file format that a file employs" ], "brief": "a description of a file format that a file employs", "anchor": "Format", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "format", "type": "DownloadableFile" } }, { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "format", "type": "AccessPage" } } ], "inheritsFrom": [], "properties": [ { "id": "Format.description", "name": "description", "label": "description", "parentType": "Format", "value": { "jsonType": "string", "display": "text" }, "description": [ "a human-readable description of the format" ], "brief": "a human-readable description of the format", "anchor": "Format.description", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/24/properties/0" } }, { "id": "Format.scheme", "name": "scheme", "label": "scheme", "parentType": "Format", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a URI that identifies the format type registry or identification system that the value is defined in." ], "brief": "a URI that identifies the format type registry or identification system that the value is defined in.", "anchor": "Format.scheme", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/24/properties/1" } }, { "id": "Format.@id", "name": "@id", "label": "@id", "parentType": "Format", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the unique identifier for the format" ], "brief": "the unique identifier for the format", "anchor": "Format.@id", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/24/properties/2" } }, { "id": "Format.tag", "name": "tag", "label": "tag", "parentType": "Format", "value": { "jsonType": "string", "display": "text" }, "description": [ "a short, display-able token or abbreviation for the format" ], "brief": "a short, display-able token or abbreviation for the format", "anchor": "Format.tag", "required": false, "inheritedFrom": null, "schemaNotes": [ "As a token, it is intended that applications can search for this value and find all files having the same format. Thus, regardless of whether the @id field is provided, all references to the same format should use the same tag value." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/24/properties/3" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/24" } }, { "id": "Person", "name": "Person", "label": "Person", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "an identification a Person contributing to the publication of a resource" ], "brief": "an identification a Person contributing to the publication of a resource", "anchor": "Person", "usage": [ { "id": "list-type", "template": "as a value type for the {prop} list property of the {type} type", "data": { "prop": "authors", "type": "DataPublication" } } ], "inheritsFrom": [], "properties": [ { "id": "Person.@type", "name": "@type", "label": "@type", "parentType": "Person", "value": { "jsonType": "string", "display": "text" }, "description": [ "the class indicating that this is a Person" ], "brief": "the class indicating that this is a Person", "anchor": "Person.@type", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26/properties/0" } }, { "id": "Person.fn", "name": "fn", "label": "fn", "parentType": "Person", "value": { "jsonType": "string", "display": "text" }, "description": [ "the author's full name in the preferred format" ], "brief": "the author's full name in the preferred format", "anchor": "Person.fn", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26/properties/1" } }, { "id": "Person.givenName", "name": "givenName", "label": "givenName", "parentType": "Person", "value": { "jsonType": "string", "display": "text" }, "description": [ "the author's given name" ], "brief": "the author's given name", "anchor": "Person.givenName", "required": false, "inheritedFrom": null, "schemaNotes": [ "Often referred to in English-speaking conventions as the first name" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26/properties/2" } }, { "id": "Person.familyName", "name": "familyName", "label": "familyName", "parentType": "Person", "value": { "jsonType": "string", "display": "text" }, "description": [ "the author's family name" ], "brief": "the author's family name", "anchor": "Person.familyName", "required": false, "inheritedFrom": null, "schemaNotes": [ "Often referred to in English-speaking conventions as the last name" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26/properties/3" } }, { "id": "Person.middleName", "name": "middleName", "label": "middleName", "parentType": "Person", "value": { "jsonType": "string", "display": "text" }, "description": [ "the author's middle names or initials" ], "brief": "the author's middle names or initials", "anchor": "Person.middleName", "required": false, "inheritedFrom": null, "schemaNotes": [ "Often referred to in English-speaking conventions as the first name" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26/properties/4" } }, { "id": "Person.orcid", "name": "orcid", "label": "orcid", "parentType": "Person", "value": { "jsonType": "object", "display": "ORCIDpath object", "objectType": "ORCIDpath" }, "description": [ "the author's ORCID" ], "brief": "the author's ORCID", "anchor": "Person.orcid", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26/properties/5" } }, { "id": "Person.affiliation", "name": "affiliation", "label": "affiliation", "parentType": "Person", "value": { "jsonType": "array", "display": "list of Affiliation objects", "itemType": "Affiliation" }, "description": [ "The institution the person was affiliated with at the time of publication" ], "brief": "The institution the person was affiliated with at the time of publication", "anchor": "Person.affiliation", "required": false, "inheritedFrom": null, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26/properties/6" } }, { "id": "Person.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "Person", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this person" ], "brief": "a local identifier representing this person", "anchor": "Person.proxyFor", "required": false, "inheritedFrom": null, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the person as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26/properties/7" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/26" } }, { "id": "ORCIDpath", "name": "ORCIDpath", "label": "ORCIDpath", "group": "Other", "valueType": "string", "displayType": "text", "description": [ "the format of the path portion of an ORCID identifier (i.e. without the preceding resolver URL base)" ], "brief": "the format of the path portion of an ORCID identifier (i.e. without the preceding resolver URL base)", "anchor": "ORCIDpath", "usage": [ { "id": "value-type", "template": "as a value type for the {prop} property in the {type} type", "data": { "prop": "orcid", "type": "Person" } } ], "inheritsFrom": [], "properties": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/27" } }, { "id": "Affiliation", "name": "Affiliation", "label": "Affiliation", "group": "Other", "valueType": "object", "displayType": "object", "description": [ "a description of an organization that a person is a member of" ], "brief": "a description of an organization that a person is a member of", "anchor": "Affiliation", "usage": [ { "id": "polymorph-type", "template": "as an allowed value type in the {prop} property in the {type} type", "data": { "type": "Resource", "prop": "isPartOf" } }, { "id": "list-type", "template": "as a value type for the {prop} list property of the {type} type", "data": { "prop": "affiliation", "type": "Person" } } ], "inheritsFrom": [ "ResourceReference" ], "properties": [ { "id": "Affiliation.subunits", "name": "subunits", "label": "subunits", "parentType": "Affiliation", "value": { "jsonType": "array", "display": "list of text values", "itemType": "string" }, "description": [ "sub-units of the main organization the that the person is a member of" ], "brief": "sub-units of the main organization the that the person is a member of", "anchor": "Affiliation.subunits", "required": false, "inheritedFrom": null, "schemaNotes": [ "The order of the array elements should be treated as significant. Typically (though not required), each element will reflect a more specific unit contained in unit nameed in the previous element." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/properties/0" } }, { "id": "Affiliation.@id", "name": "@id", "label": "@id", "parentType": "Affiliation", "value": { "jsonType": "string", "display": "text" }, "description": [ "an identifier for the reference" ], "brief": "an identifier for the reference", "anchor": "RelatedResource.@id", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@id", "anchor": "RelatedResource.@id" }, "schemaNotes": [ "The most well-known PID used to identify the resource (see also notes for proxyFor", "This identifier can be a relative URL which can be used in special cases (See the notes for BibliographicReference:@type for when this ID should not refer to the referenced work).", "Though not required by this schema, providing an identifier for a component is critical for merging information from different sources.", "A relative identifier requires that @base be set to the Resource identifier in the @context." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/inheritedProperties/0/properties/0" } }, { "id": "Affiliation.@type", "name": "@type", "label": "@type", "parentType": "Affiliation", "value": { "jsonType": "array | null | string", "display": "text or list of text values", "itemType": "string" }, "description": [], "brief": "", "anchor": "RelatedResource.@type", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "@type", "anchor": "RelatedResource.@type" }, "schemaNotes": [ "The single string value option is provided for backward compatibility (and may be removed in future versions; see BibliographicReference). When this is used, the node represents a reference and not the thing being referenced; the @id contains a relative URI, representing this reference" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/inheritedProperties/0/properties/1" } }, { "id": "Affiliation.title", "name": "title", "label": "title", "parentType": "Affiliation", "value": { "jsonType": "string", "display": "text" }, "description": [ "the name of the resource being referenced" ], "brief": "the name of the resource being referenced", "anchor": "RelatedResource.title", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "title", "anchor": "RelatedResource.title" }, "schemaNotes": [ "This value is intended for display.", "This can be, but is not required to be, the same title given in the metadata record describing the resource" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/inheritedProperties/0/properties/2" } }, { "id": "Affiliation.proxyFor", "name": "proxyFor", "label": "proxyFor", "parentType": "Affiliation", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "a local identifier representing this resource" ], "brief": "a local identifier representing this resource", "anchor": "RelatedResource.proxyFor", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "proxyFor", "anchor": "RelatedResource.proxyFor" }, "schemaNotes": [ "This identifier is expected to point to an up-to-date description of the resource as known to the local system. The properties associated with that identifier may be different those given in the current record." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/inheritedProperties/0/properties/3" } }, { "id": "Affiliation.location", "name": "location", "label": "location", "parentType": "Affiliation", "value": { "jsonType": "string", "display": "text (URL)" }, "description": [ "the URL for accessing the resource" ], "brief": "the URL for accessing the resource", "anchor": "RelatedResource.location", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "location", "anchor": "RelatedResource.location" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/inheritedProperties/0/properties/4" } }, { "id": "Affiliation.label", "name": "label", "label": "label", "parentType": "Affiliation", "value": { "jsonType": "string", "display": "text" }, "description": [ "a recommended label or title to display as the text for a link to the document" ], "brief": "a recommended label or title to display as the text for a link to the document", "anchor": "RelatedResource.label", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "label", "anchor": "RelatedResource.label" }, "schemaNotes": [ "This is intended to be briefer than a citation. It should be short enough to use as tag to an entry in reference list as inserted into a document's text" ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/inheritedProperties/0/properties/5" } }, { "id": "Affiliation.issued", "name": "issued", "label": "issued", "parentType": "Affiliation", "value": { "jsonType": "object", "display": "FlexibleDate object", "objectType": "FlexibleDate" }, "description": [ "The date the referenced resource was issued" ], "brief": "The date the referenced resource was issued", "anchor": "RelatedResource.issued", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "issued", "anchor": "RelatedResource.issued" }, "schemaNotes": [ "This is intended for determining relative newness--i.e. being newer or older than the referring resource." ], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/inheritedProperties/0/properties/6" } }, { "id": "Affiliation.description", "name": "description", "label": "description", "parentType": "Affiliation", "value": { "jsonType": "string", "display": "text" }, "description": [ "a brief, human-readable description of what this reference refers to and/or why it is being referenced." ], "brief": "a brief, human-readable description of what this reference refers to and/or why it is being referenced.", "anchor": "RelatedResource.description", "required": false, "inheritedFrom": { "type": "RelatedResource", "property": "description", "anchor": "RelatedResource.description" }, "schemaNotes": [], "readerNotes": [], "examples": [], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28/inheritedProperties/0/properties/7" } } ], "source": { "path": "etc/help/nerdm-view.json", "jsonPointer": "/types/28" } } ], "toc": [ { "id": "toc-schema-reference", "label": "Schema Reference", "anchor": "schema-reference", "level": 1, "children": [ { "id": "toc-group-Resource", "label": "Resource", "anchor": "group-Resource", "level": 2, "children": [ { "id": "toc-type-Resource", "label": "Resource", "anchor": "Resource", "level": 3 }, { "id": "toc-type-PublicDataResource", "label": "PublicDataResource", "anchor": "PublicDataResource", "level": 3 }, { "id": "toc-type-DataPublication", "label": "DataPublication", "anchor": "DataPublication", "level": 3 } ] }, { "id": "toc-group-Component", "label": "Component", "anchor": "group-Component", "level": 2, "children": [ { "id": "toc-type-Component", "label": "Component", "anchor": "Component", "level": 3 }, { "id": "toc-type-IncludedResource", "label": "IncludedResource", "anchor": "IncludedResource", "level": 3 }, { "id": "toc-type-DownloadableFile", "label": "DownloadableFile", "anchor": "DownloadableFile", "level": 3 }, { "id": "toc-type-DataFile", "label": "DataFile", "anchor": "DataFile", "level": 3 }, { "id": "toc-type-ChecksumFile", "label": "ChecksumFile", "anchor": "ChecksumFile", "level": 3 }, { "id": "toc-type-Subcollection", "label": "Subcollection", "anchor": "Subcollection", "level": 3 }, { "id": "toc-type-AccessPage", "label": "AccessPage", "anchor": "AccessPage", "level": 3 }, { "id": "toc-type-SearchPage", "label": "SearchPage", "anchor": "SearchPage", "level": 3 }, { "id": "toc-type-API", "label": "API", "anchor": "API", "level": 3 } ] }, { "id": "toc-group-Other", "label": "Other", "anchor": "group-Other", "level": 2, "children": [ { "id": "toc-type-FlexibleDate", "label": "FlexibleDate", "anchor": "FlexibleDate", "level": 3 }, { "id": "toc-type-RelatedResource", "label": "RelatedResource", "anchor": "RelatedResource", "level": 3 }, { "id": "toc-type-ResourceReference", "label": "ResourceReference", "anchor": "ResourceReference", "level": 3 }, { "id": "toc-type-VersionRelease", "label": "VersionRelease", "anchor": "VersionRelease", "level": 3 }, { "id": "toc-type-BibliographicReference", "label": "BibliographicReference", "anchor": "BibliographicReference", "level": 3 }, { "id": "toc-type-DCiteReference", "label": "DCiteReference", "anchor": "DCiteReference", "level": 3 }, { "id": "toc-type-ISO8601DateRange", "label": "ISO8601DateRange", "anchor": "ISO8601DateRange", "level": 3 }, { "id": "toc-type-Topic", "label": "Topic", "anchor": "Topic", "level": 3 }, { "id": "toc-type-Organization", "label": "Organization", "anchor": "Organization", "level": 3 }, { "id": "toc-type-ContactInfo", "label": "ContactInfo", "anchor": "ContactInfo", "level": 3 }, { "id": "toc-type-PostalAddress", "label": "PostalAddress", "anchor": "PostalAddress", "level": 3 }, { "id": "toc-type-Identifier", "label": "Identifier", "anchor": "Identifier", "level": 3 }, { "id": "toc-type-Checksum", "label": "Checksum", "anchor": "Checksum", "level": 3 }, { "id": "toc-type-Format", "label": "Format", "anchor": "Format", "level": 3 }, { "id": "toc-type-Person", "label": "Person", "anchor": "Person", "level": 3 }, { "id": "toc-type-ORCIDpath", "label": "ORCIDpath", "anchor": "ORCIDpath", "level": 3 }, { "id": "toc-type-Affiliation", "label": "Affiliation", "anchor": "Affiliation", "level": 3 } ] } ] } ], "glossary": [] }