hep
A record in the Literature collection
Properties: $schema, _bucket, _collections, _desy_bookkeeping, _export_to, _files, _private_notes, abstracts, accelerator_experiments, acquisition_source, arxiv_eprints, authors, book_series, citeable, collaborations, control_number, copyright, core, corporate_author, curated, deleted, deleted_records, document_type, documents, dois, editions, energy_ranges, external_system_identifiers, figures, funding_info, imprints, inspire_categories, isbns, keywords, languages, legacy_creation_date, legacy_version, license, new_record, number_of_pages, persistent_identifiers, preprint_date, public_notes, publication_info, publication_type, record_affiliations, refereed, references, related_records, report_numbers, rpp, self, texkeys, thesis_info, title_translations, titles, urls, withdrawn
$schema
type: | string |
format: | uri |
minLength: | 1 |
_bucket
Used by invenio-records-files to store information about the
bucket attached to this record.
Note
This field is maintained by invenio-records-files and should
not be edited manually.
_collections
Collections to which this record belongs
MARC: | 980__a (HEP maps to Literature ) |
Regular Literature records have collection Literature
only.
The other collections are used by different groups to manage
records using the Inspire infrastructure, but which do not belong
to the Inspire literature collection. If a record belongs to one
of these collections but not Literature
, it is not shown in the
standard search results.
Every element of _collections is:
Allowed values:
- BABAR Analysis Documents
- BABAR Internal BAIS
- BABAR Internal Notes
- CDF Internal Notes
- CDF Notes
- CDS Hidden
- D0 Internal Notes
- D0 Preliminary Notes
- Fermilab
- H1 Internal Notes
- H1 Preliminary Notes
- HAL Hidden
- HEP Hidden
- HERMES Internal Notes
- LArSoft Internal Notes
- LArSoft Notes
- Literature
- SLAC
- ZEUS Internal Notes
- ZEUS Preliminary Notes
_desy_bookkeeping
DESY keywording information
Used by DESY to store information about the keyword-assignment
process.
Every element of _desy_bookkeeping is:
Properties: date, expert, identifier, status
date
MARC: | 595_Dd |
type: | string |
minLength: | 1 |
expert
MARC: | 595_Da |
type: | string |
minLength: | 1 |
identifier
MARC: | 035__z when 035__9 is DESY |
type: | string |
minLength: | 1 |
status
MARC: | 595_Ds |
type: | string |
minLength: | 1 |
_export_to
Flags determining to which foreign databases this record should be
automatically exported. Setting one of the keys to true
means
that the record must be exported to the corresponding system,
setting it to false
means that it must not be exported.
Properties: CDS, HAL
HAL
Controls automatic export to HAL, the French national
repository.
_files
invenio-records-files metadata
Used by invenio-records-files to store information about the
files attached to this record.
Note
This field is maintained by invenio-records-files and should
not be edited manually.
Every element of _files is:
_private_notes
List of private notes
MARC: | 595 , 595_H (when
source is HAL ) |
These notes are only visible to privileged users, not regular
users.
Every element of _private_notes is:
abstracts
List of abstracts
The first abstract is the preferred one, to be displayed in
priority.
Every element of abstracts is:
accelerator_experiments
List of related accelerators/experiments
Every element of accelerator_experiments is:
Properties: accelerator, curated_relation, experiment, institution, legacy_name, record
accelerator
If present, institution should contain the
institution where this accelerator is located.
curated_relation
type: | boolean |
default: | False |
experiment
If present, institution should contain the
institution where this experiment is located and
accelerator may contain the accelerator that this
experiment is using (if appropriate).
institution
Institution hosting the experiment
legacy_name
Identifier of the experiment on legacy
This field is used when migrating from legacy instead
of separate institution, accelerator and
experiment. In the future, it will be deprecated and
the other fields will be used instead.
example: | CERN-LHC-CMS |
type: | string |
minLength: | 1 |
arxiv_eprints
Every element of arxiv_eprints is:
arXiv metadata
Contains metadata of an arXiv eprint contained in this record.
Note
This metadata is copied over from arXiv and should not be
edited manually.
type: | object |
Required: | value |
Properties: categories, value
categories
arXiv categories of the eprint
MARC: | first category in 037__c with 9:arXiv ,
all categories in 65017a with 2:arXiv |
The first category in the list has a special meaning:
it is the primary category of the eprint on arXiv.
Every element of categories is:
value
arXiv eprint identifier
MARC: | 037__a with 9:arXiv |
example: | math/0307245 |
example: | 1701.01431 |
type: | string |
pattern: | ^\d{4}.\d{4 , 5}|[\w.]+(-[\w.]+)?/\d+$ |
minLength: | 1 |
authors
Authors
Besides authors, also contains editors and supervisors (see
inspire_roles).
Every element of authors is:
Properties: affiliations, affiliations_identifiers, alternative_names, credit_roles, curated_relation, emails, full_name, ids, inspire_roles, raw_affiliations, record, signature_block, uuid
affiliations
Every element of affiliations is:
type: | object |
Required: | value |
Properties: curated_relation, record, value
value
ICN of affiliation
Currently, the old
legacy_ICN
is used here. In the future, this will
change and become the new
ICN.
affiliations_identifiers
List of identifiers of this institution on external systems.
Every element of affiliations_identifiers is:
May satisfy any of the following definitions:
GRID identifier
Properties: schema, value
schema
MARC: | first part of 100/700/701__t before the : |
type: | string |
minLength: | 1 |
Allowed values:
value
MARC: | last part of 100/700/701__t after the : |
type: | string |
pattern: | ^grid\.\d+\.\w+$ |
minLength: | 1 |
ROR identifier
Properties: schema, value
schema
MARC: | first part of 100/700/701__t before the : |
type: | string |
minLength: | 1 |
Allowed values:
value
MARC: | last part of 100/700/701__t after the : |
type: | string |
pattern: | ^https://ror\.org/0\w{6}\d{2}$ |
minLength: | 1 |
alternative_names
Every element of alternative_names is:
MARC: | 100/700/701__q |
example: | 楼 立洋 |
example: | Smith, Joe John |
type: | string |
minLength: | 1 |
credit_roles
Every element of credit_roles is:
CRedit role of author
Role of the author according to the Contributor
Roles Taxonomy (CRediT)
Allowed values:
- Conceptualization
- Data curation
- Formal analysis
- Funding acquisition
- Investigation
- Methodology
- Project administration
- Resources
- Software
- Supervision
- Validation
- Visualization
- Writing - original draft
- Writing - review & editing
curated_relation
type: | boolean |
default: | False |
emails
MARC: | 100/700/701__m |
type: | array |
minItems: | 1 |
Every element of emails is:
type: | string |
format: | email |
minLength: | 1 |
full_name
Author name
Author name in Latin alphabet (may contain diacritics).
Should be of the form ‘family names, first names’, and,
except for a possible reordering, be exactly as on the
paper.
example: | Smith Davis, John F.K. |
type: | string |
pattern: | ^[^ , ]+( , [^ , ]+)?( , ?[^ , ]+)?$ |
minLength: | 1 |
ids
Identifiers of the author
MARC: | 100/700/701__i/j |
type: | array |
minItems: | 1 |
Every element of ids is:
inspire_roles
Every element of inspire_roles is:
supervisor
MARC: | 701 is used for supervisor metadata. |
This person is a thesis supervisor. Should be
used together with the thesis
document_type.
editor
-
This person is an editor of the conference
proceedings. Should be used together with the
proceedings
document_type.
type: | string |
default: | author |
minLength: | 1 |
Allowed values:
raw_affiliations
List of full affiliations, as written on the paper.
Every element of raw_affiliations is:
signature_block
Phonetic representation of the name, needed for author
disambiguation. This field should not be edited
manually.
uuid
UUID
Used by the BEARD author disambiguation tool. This
field should not be edited manually.
type: | string |
pattern: | ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ |
minLength: | 1 |
book_series
List of book series in which this record has been published.
Note
This field should only be present if book
, thesis
or
proceedings
are among
document_type.
Every element of book_series is:
Note
If the book series has a Journal record,
hep.json#/properties/publication_info should be used
instead.
type: | object |
Required: | title |
Properties: title, volume
title
Title of the book series
MARC: | 490__a |
type: | string |
minLength: | 1 |
volume
Volume of the book in the series
MARC: | 490__v |
type: | string |
minLength: | 1 |
citeable
MARC: | true corresponds to 980__a:Citeable . |
The main effect of setting this field to true
is that the
recoord is taken into account in the citation summary. The need
for this field arises because of limitations in the automatic
recognition of cited papers in references: a record is flagged as
citeable only if the common way to cite this record can be reliably
recognized. Currently, a record is automatically flagged as
citeable if it has
Besides, a record may be manually flagged as citeable by a curator
if a user tracks and reports citations to that record.
Whether this record should be considered as citeable
collaborations
List of collaborations
type: | array |
minItems: | 1 |
Required: | value |
Every element of collaborations is:
type: | object |
Required: | value |
Properties: record, value
value
Collaboration name
Collaboration name as it appears on the paper (with the
Collaboration
suffix dropped).
example: | ATLAS instead of ATLAS Collaboration |
example: | Particle Data Group |
type: | string |
minLength: | 1 |
control_number
ID of current record
Read-only field. Also called record ID
or recid
.
copyright
List of copyrights to documents in this record
MARC: | 542 |
type: | array |
minItems: | 1 |
Every element of copyright is:
Properties: holder, material, statement, url, year
holder
Copyright holder
MARC: | 542__d |
example: | American Physical Society |
type: | string |
minLength: | 1 |
statement
Copyright notice
See Wikipedia for
explanations.
Alernatively to this string, a URL to the copyright
notice may be provided in url.
example: | © The Author(s) 2015. Published by Oxford
University Press on behalf of the Physical Society
of Japan. |
type: | string |
minLength: | 1 |
url
Copyright notice URL
type: | string |
format: | uri |
minLength: | 1 |
year
MARC: | 542__g |
type: | integer |
minimum: | 1000 |
maximum: | 2050 |
core
Whether this record is CORE
Inspire ingests metadata and creates records for many documents.
Some of them are relevant for High-Energy Physics, wheareas others
might be only tangentially related. In the first case, the record
is said to be CORE, whereas in the second case it is non-core.
CORE records are manually curated to ensure their metadata are up
to Inspire’s quality standards, but non-core records only receive
automatic treatment.
Note
If this field is not present or set to false
, the record is
considered as non-core. The latter is useful to override
automatic core assignments based on other properties of the
record.
corporate_author
Every element of corporate_author is:
List of corporate authors
In case the document has not been signed by a real author, but
only mentions the name of an organization.
example: | CERN |
type: | string |
minLength: | 1 |
curated
MARC: | 500__a containing *Temporary entry*, *Temporary
record* or *Brief entry* correspond to false, otherwise it
is true. |
Whether this record has been curated by a human, to ensure the
quality standards of Inspire. Records having the core flag
are all curated eventually, whereas non-core records are
not systematically curated.
deleted
Whether this record has been deleted
MARC: | 980__a/c:deleted |
type: | boolean |
deleted_records
List of records that were deleted because they were replaced by
this one. This typically happens when merging two records: one of
them gets enriched with the information of the other one, which is
then superfluous and gets deleted.
For the opposite concept, see new_record.
Every element of deleted_records is:
document_type
MARC: | 980__a , with corresponding values. |
Types of document this record represents.
Note
As a record aggregates information from multiple sources, it
can have multiple document types simultaneously.
article
- An article, whether it is published or only a preprint. In the
first case, publication_info contains information about the
journal in which it was published.
book
A monograph that does not fit into any other
document_type. The editions, imprints,
isbns and book_series fields may contain specific
metadata about this book.
Note
A proceeding
or a thesis
is not considered as a book
.
book chapter
- A chapter in a book. The field publication_info contains
information about the book of which this record is a chapter.
conference paper
- A paper that part of a conference proceedings. The field
publication_info contain information about the
conference proceedings. In particular,
cnum contains the identifier
of the conference.
note
- A note, not meant for publication.
proceedings
Proceedings of a conference. The
cnum field contains the
identfier of the conference. If published in a journal,
publication_info also contains the journal information.
If published as a book, the editions, imprints,
isbns and book_series fields may contain specific
metadata about this book.
Note
This is not considered as a book
.
report
- A report.
thesis
A thesis. The thesis_info field contains additional
information about the thesis. If published as a book, the
editions, imprints, isbns and
book_series fields may contain specific metadata about
this book.
Note
This is not considered as a book
.
Every element of document_type is:
documents
List of documents attached to the record
MARC: | 8564 (if the URL points to the inspire server) |
type: | array |
minItems: | 1 |
Every element of documents is:
Properties: description, filename, fulltext, hidden, key, material, original_url, source, url
description
Describes how this document relates to the document that
this record represents.
:example: table of contents
filename
Filename
Proper name of the file
fulltext
Whether this document contains the fulltext
hidden
Whether this document is hidden
This is true
if a document is attached to the
record for automatic extraction of metadata, but
Inspire is not allowed to make it publicly available.
key
Key to the corresponding file, which must match the key
in _files.
original_url
Original URL of the document
type: | string |
format: | uri |
minLength: | 1 |
url
Relative URL to the file containing the document. Its
form is /files/bucket/key
. It can temprorarily be
the url to download the document from, until actually
downloaded.
type: | string |
format: | uri-reference |
pattern: | ^(https?://|/api/files/).* |
minLength: | 1 |
dois
List of DOIs
Every element of dois is:
type: | object |
Required: | value |
Properties: material, source, value
value
DOI
MARC: | 0247_a |
example: | 10.1023/A:1026654312961 |
type: | string |
pattern: | ^10\.\d+(\.\d+)?/\S+$ |
minLength: | 1 |
editions
List of book editions
MARC: | 250__a |
type: | array |
minItems: | 1 |
Every element of editions is:
energy_ranges
MARC: | 695__e:n corresponds to the n -th range in the enum,
e.g. 695__e:2 is 3-10 Gev`. |
Ranges of energies the record refers to. The ranges are inclusive
on the right.
example: | 100-300 GeV means that 100 GeV < Energy ≤ 300
GeV . |
type: | array |
minItems: | 1 |
Every element of energy_ranges is:
Allowed values:
- 0-3 GeV
- 3-10 GeV
- 10-30 GeV
- 30-100 GeV
- 100-300 GeV
- 300-1000 GeV
- 1-10 TeV
- > 10 TeV
external_system_identifiers
List of identifiers of this document on external systems.
Every element of external_system_identifiers is:
Properties: schema, value
schema
Identifies the external system, and allows to interpret
unambiguously the value.
example: | ADS |
type: | string |
pattern: | ^\w+$ |
minLength: | 1 |
value
External identifier
Identifies the record in the external system specified
by schema.
example: | 1999IJTP...38.1113M |
type: | string |
pattern: | ^\S+$ |
minLength: | 1 |
funding_info
Funding information
Information about the sources of funding for the research performed
in this record.
Every element of funding_info is:
Properties: agency, grant_number, project_number
agency
Funding agency
MARC: | 536__a |
type: | string |
minLength: | 1 |
grant_number
Grant number
MARC: | 536__c |
type: | string |
minLength: | 1 |
project_number
Project number
MARC: | 536__f |
type: | string |
minLength: | 1 |
imprints
List of imprints
Every element of imprints is:
When/where/by whom this record was published.
Properties: date, place, publisher
date
Date of publication
MARC: | 260__c |
type: | string |
format: | date |
minLength: | 1 |
place
Place of publication
Note
This field is populated if this record has been
published in a book, i.e. it makes sense if book
,
thesis
or proceedings
are among
document_type.
example: | Paris |
type: | string |
minLength: | 1 |
publisher
MARC: | 260__b |
example: | Springer |
type: | string |
minLength: | 1 |
inspire_categories
List of Inspire categories
Every element of inspire_categories is:
isbns
List of ISBNs
MARC: | 020 |
type: | array |
minItems: | 1 |
Every element of isbns is:
type: | object |
Required: | value |
Properties: medium, value
medium
Physical medium to which this ISBN refers
MARC: | 020__b |
type: | string |
minLength: | 1 |
Allowed values:
- hardcover
- online
- print
- softcover
value
MARC: | 020__a |
example: | 0201021153 |
type: | string |
pattern: | ^\d*[0-9X]$ |
minLength: | 1 |
keywords
List of keywords
MARC: | 084 , 6531 and 695 (corresponding to different
schema) |
Keywords give information about the specific contents of the
record, much more precisely than inspire_categories.
Every element of keywords is:
type: | object |
Required: | value |
Properties: schema, source, value
value
A keyword
MARC: | 084/6531/695__a (depending on schema) |
It belongs to the vocabulary specified by schema.
example: | black hole: mass (for schema =
INSPIRE ) |
example: | 29.27.Fh (for schema = PACS ) |
example: | G033M (for schema = PDG ) |
type: | string |
minLength: | 1 |
languages
List of languages of the document
Note
If this field is not present, the language of the document is assumed to be English.
Every element of languages is:
legacy_creation_date
Date of record creation on legacy
Only present if the record already existed on legacy Inspire.
type: | string |
format: | date |
minLength: | 1 |
legacy_version
Last record update
Used to indicate the version of the record on legacy.
license
List of licenses
MARC: | 540 |
type: | array |
minItems: | 1 |
Every element of license is:
Properties: imposing, license, material, url
imposing
Organization/person imposing the license
MARC: | 540__b |
example: | arXiv |
type: | string |
minLength: | 1 |
license
License statement
Either the short name of the license or the full
license statement.
example: | CC-BY-4.0 |
type: | string |
minLength: | 1 |
url
URL of the license
URL where the full license statement may be found, if
only a short name is provided in license
.
type: | string |
format: | uri |
minLength: | 1 |
new_record
Record replacing this one
Contains a reference to the record replacing the current one, if it
is marked as deleted.
number_of_pages
Number of pages of the document
MARC: | 300 |
type: | integer |
minimum: | 1 |
persistent_identifiers
List of persistent identifiers
MARC: | 0247 |
type: | array |
minItems: | 1 |
Every element of persistent_identifiers is:
Properties: material, schema, source, value
schema
Type of identifier
Currently, the following identifiers are recognized:
Note
DOIs should be put into dois, not here.
Although ISBNs can also be mapped to a URN (by
prepending urn:isbn:
to the ISBN), they should
be put in the isbns field instead.
Allowed values:
value
Persistent identifier
This value gets interpreted as an identfier of the type
specified by schema.
example: | 10138/168995 (when schema = HDL ) |
example: | urn:nbn:de:hebis:77-diss-1000009520 (when
schema = URN ) |
type: | string |
pattern: | ^\S+$ |
minLength: | 1 |
preprint_date
Preprint release date
Note
This is only for preprints. For the publication date of
published documents, see imprints.
type: | string |
format: | date |
minLength: | 1 |
public_notes
List of public notes
Any notes about the document that do not fit into another field.
For arXiv eprints, also contains the contents of the comment field
on arXiv.
Note
These notes are publicly visible. For notes not shown to
regular users, see _private_notes.
Every element of public_notes is:
publication_info
List of information on publication
MARC: | 773 |
type: | array |
minItems: | 1 |
Every element of publication_info is:
Properties: artid, cnum, conf_acronym, conference_record, curated_relation, hidden, journal_issue, journal_record, journal_title, journal_volume, material, page_end, page_start, parent_isbn, parent_record, parent_report_number, pubinfo_freetext, year
artid
Article ID
MARC: | 773__c (when it contains an ID instead of
starting page or page range). |
For journals which issue IDs for articles instead of
(or in complement to) continuous numbers within a
volume.
Note
On legacy, this was treated as a starting page.
cnum
When conference` paper` or ``proceedings
is among
document_type, contains the
CNUM of the corresponding conference.
conf_acronym
Conference acronym
MARC: | 773__q |
type: | string |
minLength: | 1 |
conference_record
record of the conference
hidden
Whether this publication_info should be hidden
MARC: | If true , this comes comes from 7731 instead
of 773 . |
This is useful when:
- there are variants in the way this publication is cited,
- an error was present, has been fixed, but should be preserved
- in order to find the record.
journal_issue
MARC: | 773__n |
type: | string |
minLength: | 1 |
journal_record
Record of the corresponding Journal
journal_title
Journal title abbreviated as in the corresponding entry
in the Journals collection.
example: | Phys.Rev. |
type: | string |
minLength: | 1 |
journal_volume
MARC: | 773__v |
type: | string |
minLength: | 1 |
page_end
Last page of document
MARC: | last page in 773__c (if present) |
type: | string |
minLength: | 1 |
page_start
First page of document
MARC: | first page in 773__c (if not an artid) |
type: | string |
minLength: | 1 |
parent_isbn
ISBN of the book of which this document is a part.
type: | string |
pattern: | ^\d*[0-9X]$ |
minLength: | 1 |
parent_report_number
Report number of the document of which this record is a
part. This applies e.g. for large reports containing
several chapters that have been split into individual
records.
pubinfo_freetext
Unstructured text describing the publication
information.
Note
This field is used when provided with unstructured
publication information, e.g. from arXiv. If known,
the other fields should be used instead.
year
Publication year
MARC: | 773__y |
type: | integer |
minimum: | 1000 |
maximum: | 2050 |
publication_type
Every element of publication_type is:
Allowed values:
- introductory
- lectures
- manual
- review
record_affiliations
Affiliations not associated to authors
Because of technical limitations, for some older records the
affiliations were associated globally to the record instead of its
individual authors (using the
affiliations field).
Note
This field is present for legacy records and should not be used
for new records.
Every element of record_affiliations is:
type: | object |
Required: | value |
Properties: curated_relation, record, value
value
ICN of affiliation
Currently, the old
legacy_ICN
is used here. In the future, this will
change and become the new
ICN.
refereed
Whether the record has been peer reviewed
MARC: | true corresponds to 980__a:published |
This asserts that the document is considered as peer reviewed. This
assessment might differ from the journal’s claim to do peer review.
As a consequence, most conference papers are not considered as
refereed.
references
List of references
MARC: | 999C5 |
type: | array |
minItems: | 1 |
Every element of references is:
Properties: curated_relation, legacy_curated, raw_refs, record, reference
legacy_curated
MARC: | 999C59:CURATOR corresponds to True |
Whether the reference has been modified be a curator to
correct errors in reference extraction from the
document.
raw_refs
List of raw references
These references are unparsed and as they appear in the
document.
Every element of raw_refs is:
Properties: schema, source, value
schema
Content type of the raw reference
example: | text |
example: | Elsevier XML |
type: | string |
minLength: | 1 |
value
Content of the raw reference
report_numbers
List of report numbers assigned to the record
MARC: | 037 |
example: | DESY-17-036 |
type: | array |
minItems: | 1 |
Every element of report_numbers is:
type: | object |
Required: | value |
Properties: hidden, source, value
hidden
MARC: | if true , the value is in 037__z
instead of 037__a . |
Whether this report number should be hidden from the
display. This is appropriate for:
- a report number that appears on the document but is
not the one officially assigned;
- a report number that has been assigned by one of the
authors’ institutions, but is not displayed on the
document (typically for large collaborations).
rpp
MARC: | 210__a:RPP corresponds to true |
Whether this record is (part of) the Review of Particle Physics
texkeys
List of TeX keys
MARC: | 035 with 9:SPIRESTeX or 9:INSPIRETeX |
These keys are used to cite this record using TeX/LaTeX/BibTex. The
first one is the valid one being shown in the TeX display formats,
the others are the obsolete ones which are kept in order to
identify this record by those texkeys.
Every element of texkeys is:
thesis_info
Information on a thesis (degree, date, university)
Properties: date, defense_date, degree_type, institutions
date
Publication date of the thesis
type: | string |
format: | date |
minLength: | 1 |
defense_date
Date of the thesis defense. On legacy, this was put in the
note field as ‘presented on …’.
type: | string |
format: | date |
minLength: | 1 |
institutions
List of institutions issuing the degree.
Every element of institutions is:
Properties: curated_relation, name, record
title_translations
Translations of the titles in a language that is not the language
of the document (see languages).
Usually, this is contains an English translation of the title of a
non-English paper, but sometimes a native language if the paper is
in English but the title has been translated.
Every element of title_translations is:
Properties: language, source, subtitle, title
titles
There can be several because the preprint title often differs from
the published version. The title should be kept as on the document
and in the same language as the document (see languages).
Translations go into title_translations.
List of titles
Every element of titles is:
urls
URLs to external resources related to this record.
Every element of urls is:
withdrawn
MARC: | true corresponds to 980__a:withdrawn |
Whether the paper has been withdrawn (mainly occurs for arXiv
preprints). It shouldn’t appear in author profiles.