.. _hep.json#/: hep === .. container:: title A record in the Literature collection :type: ``object`` :Required: :ref:`hep.json#/properties/document_type`, :ref:`hep.json#/properties/titles`, :ref:`hep.json#/properties/_collections` **Properties:** :ref:`hep.json#/properties/$schema`, :ref:`hep.json#/properties/_bucket`, :ref:`hep.json#/properties/_collections`, :ref:`hep.json#/properties/_desy_bookkeeping`, :ref:`hep.json#/properties/_export_to`, :ref:`hep.json#/properties/_files`, :ref:`hep.json#/properties/_private_notes`, :ref:`hep.json#/properties/abstracts`, :ref:`hep.json#/properties/accelerator_experiments`, :ref:`hep.json#/properties/acquisition_source`, :ref:`hep.json#/properties/arxiv_eprints`, :ref:`hep.json#/properties/authors`, :ref:`hep.json#/properties/book_series`, :ref:`hep.json#/properties/citeable`, :ref:`hep.json#/properties/collaborations`, :ref:`hep.json#/properties/control_number`, :ref:`hep.json#/properties/copyright`, :ref:`hep.json#/properties/core`, :ref:`hep.json#/properties/corporate_author`, :ref:`hep.json#/properties/curated`, :ref:`hep.json#/properties/deleted`, :ref:`hep.json#/properties/deleted_records`, :ref:`hep.json#/properties/document_type`, :ref:`hep.json#/properties/documents`, :ref:`hep.json#/properties/dois`, :ref:`hep.json#/properties/editions`, :ref:`hep.json#/properties/energy_ranges`, :ref:`hep.json#/properties/external_system_identifiers`, :ref:`hep.json#/properties/figures`, :ref:`hep.json#/properties/funding_info`, :ref:`hep.json#/properties/imprints`, :ref:`hep.json#/properties/inspire_categories`, :ref:`hep.json#/properties/isbns`, :ref:`hep.json#/properties/keywords`, :ref:`hep.json#/properties/languages`, :ref:`hep.json#/properties/legacy_creation_date`, :ref:`hep.json#/properties/legacy_version`, :ref:`hep.json#/properties/license`, :ref:`hep.json#/properties/new_record`, :ref:`hep.json#/properties/number_of_pages`, :ref:`hep.json#/properties/persistent_identifiers`, :ref:`hep.json#/properties/preprint_date`, :ref:`hep.json#/properties/public_notes`, :ref:`hep.json#/properties/publication_info`, :ref:`hep.json#/properties/publication_type`, :ref:`hep.json#/properties/record_affiliations`, :ref:`hep.json#/properties/refereed`, :ref:`hep.json#/properties/references`, :ref:`hep.json#/properties/related_records`, :ref:`hep.json#/properties/report_numbers`, :ref:`hep.json#/properties/rpp`, :ref:`hep.json#/properties/self`, :ref:`hep.json#/properties/texkeys`, :ref:`hep.json#/properties/thesis_info`, :ref:`hep.json#/properties/title_translations`, :ref:`hep.json#/properties/titles`, :ref:`hep.json#/properties/urls`, :ref:`hep.json#/properties/withdrawn` .. _hep.json#/properties/$schema: $schema +++++++ :type: ``string`` :format: ``uri`` :minLength: ``1`` .. _hep.json#/properties/_bucket: _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. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/_collections: _collections ++++++++++++ .. container:: title 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. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **_collections** is: :type: ``string`` :minLength: ``1`` **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 .. _hep.json#/properties/_desy_bookkeeping: _desy_bookkeeping +++++++++++++++++ .. container:: title DESY keywording information :MARC: ``595_D``, ``035__9:DESY`` Used by DESY to store information about the keyword-assignment process. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **_desy_bookkeeping** is: :type: ``object`` **Properties:** :ref:`hep.json#/properties/_desy_bookkeeping/items/properties/date`, :ref:`hep.json#/properties/_desy_bookkeeping/items/properties/expert`, :ref:`hep.json#/properties/_desy_bookkeeping/items/properties/identifier`, :ref:`hep.json#/properties/_desy_bookkeeping/items/properties/status` .. _hep.json#/properties/_desy_bookkeeping/items/properties/date: date #### :MARC: ``595_Dd`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/_desy_bookkeeping/items/properties/expert: expert ###### :MARC: ``595_Da`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/_desy_bookkeeping/items/properties/identifier: identifier ########## :MARC: ``035__z`` when ``035__9`` is ``DESY`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/_desy_bookkeeping/items/properties/status: status ###### :MARC: ``595_Ds`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/_export_to: _export_to ++++++++++ :MARC: ``595__c`` 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. :type: ``object`` **Properties:** :ref:`hep.json#/properties/_export_to/properties/CDS`, :ref:`hep.json#/properties/_export_to/properties/HAL` .. _hep.json#/properties/_export_to/properties/CDS: CDS ### Controls automatic export to the `CERN Document Server `_. :type: ``boolean`` .. _hep.json#/properties/_export_to/properties/HAL: HAL ### Controls automatic export to `HAL `_, the French national repository. :type: ``boolean`` .. _hep.json#/properties/_files: _files ++++++ .. container:: title `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. :type: ``array`` :minItems: ``0`` .. container:: sub-title Every element of **_files** is: :Reference: :ref:`records-files.json#/` .. _hep.json#/properties/_private_notes: _private_notes ++++++++++++++ .. container:: title List of private notes :MARC: ``595``, ``595_H`` (when :ref:`sourced_value.json#/properties/source` is ``HAL``) These notes are only visible to privileged users, not regular users. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **_private_notes** is: :Reference: :ref:`sourced_value.json#/` .. _hep.json#/properties/abstracts: abstracts +++++++++ .. container:: title List of abstracts :MARC: ``520`` The first abstract is the preferred one, to be displayed in priority. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **abstracts** is: :Reference: :ref:`sourced_value.json#/` .. _hep.json#/properties/accelerator_experiments: accelerator_experiments +++++++++++++++++++++++ .. container:: title List of related accelerators/experiments :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **accelerator_experiments** is: :type: ``object`` **Properties:** :ref:`hep.json#/properties/accelerator_experiments/items/properties/accelerator`, :ref:`hep.json#/properties/accelerator_experiments/items/properties/curated_relation`, :ref:`hep.json#/properties/accelerator_experiments/items/properties/experiment`, :ref:`hep.json#/properties/accelerator_experiments/items/properties/institution`, :ref:`hep.json#/properties/accelerator_experiments/items/properties/legacy_name`, :ref:`hep.json#/properties/accelerator_experiments/items/properties/record` .. _hep.json#/properties/accelerator_experiments/items/properties/accelerator: accelerator ########### :MARC: ``693__a`` If present, :ref:`hep.json#/properties/accelerator_experiments/items/properties/institution` should contain the institution where this accelerator is located. .. note:: Currently not used, see :ref:`hep.json#/properties/accelerator_experiments/items/properties/legacy_name`. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/accelerator_experiments/items/properties/curated_relation: curated_relation ################ :type: ``boolean`` :default: ``False`` .. _hep.json#/properties/accelerator_experiments/items/properties/experiment: experiment ########## :MARC: not present. If present, :ref:`hep.json#/properties/accelerator_experiments/items/properties/institution` should contain the institution where this experiment is located and :ref:`hep.json#/properties/accelerator_experiments/items/properties/accelerator` may contain the accelerator that this experiment is using (if appropriate). .. note:: Currently not used, see :ref:`hep.json#/properties/accelerator_experiments/items/properties/legacy_name`. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/accelerator_experiments/items/properties/institution: institution ########### .. container:: title Institution hosting the experiment :MARC: not present. .. note:: Currently not used, see :ref:`hep.json#/properties/accelerator_experiments/items/properties/legacy_name`. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/accelerator_experiments/items/properties/legacy_name: legacy_name ########### .. container:: title Identifier of the experiment on legacy :MARC: ``693__e`` This field is used when migrating from legacy instead of separate :ref:`hep.json#/properties/accelerator_experiments/items/properties/institution`, :ref:`hep.json#/properties/accelerator_experiments/items/properties/accelerator` and :ref:`hep.json#/properties/accelerator_experiments/items/properties/experiment`. In the future, it will be deprecated and the other fields will be used instead. :example: ``CERN-LHC-CMS`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/accelerator_experiments/items/properties/record: record ###### :Reference: :ref:`experiment.json#/` .. _hep.json#/properties/acquisition_source: acquisition_source ++++++++++++++++++ :Reference: :ref:`acquisition_source.json#/` .. _hep.json#/properties/arxiv_eprints: arxiv_eprints +++++++++++++ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **arxiv_eprints** is: .. container:: title 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: :ref:`hep.json#/properties/arxiv_eprints/items/properties/value` **Properties:** :ref:`hep.json#/properties/arxiv_eprints/items/properties/categories`, :ref:`hep.json#/properties/arxiv_eprints/items/properties/value` .. _hep.json#/properties/arxiv_eprints/items/properties/categories: categories ########## .. container:: title 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. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **categories** is: :Reference: :ref:`arxiv_categories.json#/` .. _hep.json#/properties/arxiv_eprints/items/properties/value: value ##### .. container:: title 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`` .. _hep.json#/properties/authors: authors +++++++ .. container:: title Authors :MARC: ``100``, ``700`` and ``701`` Besides authors, also contains editors and supervisors (see :ref:`hep.json#/properties/authors/items/properties/inspire_roles`). :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **authors** is: :type: ``object`` :Required: :ref:`hep.json#/properties/authors/items/properties/full_name` **Properties:** :ref:`hep.json#/properties/authors/items/properties/affiliations`, :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers`, :ref:`hep.json#/properties/authors/items/properties/alternative_names`, :ref:`hep.json#/properties/authors/items/properties/credit_roles`, :ref:`hep.json#/properties/authors/items/properties/curated_relation`, :ref:`hep.json#/properties/authors/items/properties/emails`, :ref:`hep.json#/properties/authors/items/properties/full_name`, :ref:`hep.json#/properties/authors/items/properties/ids`, :ref:`hep.json#/properties/authors/items/properties/inspire_roles`, :ref:`hep.json#/properties/authors/items/properties/raw_affiliations`, :ref:`hep.json#/properties/authors/items/properties/record`, :ref:`hep.json#/properties/authors/items/properties/signature_block`, :ref:`hep.json#/properties/authors/items/properties/uuid` .. _hep.json#/properties/authors/items/properties/affiliations: affiliations ############ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **affiliations** is: :type: ``object`` :Required: :ref:`hep.json#/properties/authors/items/properties/affiliations/items/properties/value` **Properties:** :ref:`hep.json#/properties/authors/items/properties/affiliations/items/properties/curated_relation`, :ref:`hep.json#/properties/authors/items/properties/affiliations/items/properties/record`, :ref:`hep.json#/properties/authors/items/properties/affiliations/items/properties/value` .. _hep.json#/properties/authors/items/properties/affiliations/items/properties/curated_relation: curated_relation >>>>>>>>>>>>>>>> :type: ``boolean`` .. _hep.json#/properties/authors/items/properties/affiliations/items/properties/record: record >>>>>> :Reference: :ref:`institution.json#/` .. _hep.json#/properties/authors/items/properties/affiliations/items/properties/value: value >>>>> .. container:: title ICN of affiliation :MARC: ``100/700/701__u`` Currently, the old :ref:`institutions.json#/properties/legacy_ICN` is used here. In the future, this will change and become the new :ref:`institutions.json#/properties/ICN`. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/authors/items/properties/affiliations_identifiers: affiliations_identifiers ######################## :MARC: ``100/700/701__t`` List of identifiers of this institution on external systems. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **affiliations_identifiers** is: May satisfy *any* of the following definitions: .. _hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/0: GRID identifier >>>>>>>>>>>>>>> :type: ``object`` .. _hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/0/title: :Required: :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/0/properties/schema`, :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/0/properties/value` **Properties:** :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/0/properties/schema`, :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/0/properties/value` .. _hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/0/properties/schema: schema ...... :MARC: first part of ``100/700/701__t`` before the : :type: ``string`` :minLength: ``1`` **Allowed values:** - GRID .. _hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/0/properties/value: value ..... :MARC: last part of ``100/700/701__t`` after the : :type: ``string`` :pattern: ``^grid\.\d+\.\w+$`` :minLength: ``1`` .. _hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/1: ROR identifier >>>>>>>>>>>>>> :type: ``object`` .. _hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/1/title: :Required: :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/1/properties/schema`, :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/1/properties/value` **Properties:** :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/1/properties/schema`, :ref:`hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/1/properties/value` .. _hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/1/properties/schema: schema ...... :MARC: first part of ``100/700/701__t`` before the : :type: ``string`` :minLength: ``1`` **Allowed values:** - ROR .. _hep.json#/properties/authors/items/properties/affiliations_identifiers/items/anyOf/1/properties/value: value ..... :MARC: last part of ``100/700/701__t`` after the : :type: ``string`` :pattern: ``^https://ror\.org/0\w{6}\d{2}$`` :minLength: ``1`` .. _hep.json#/properties/authors/items/properties/alternative_names: alternative_names ################# :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **alternative_names** is: :MARC: ``100/700/701__q`` :example: ``楼 立洋`` :example: ``Smith, Joe John`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/authors/items/properties/credit_roles: credit_roles ############ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **credit_roles** is: .. container:: title CRedit role of author :MARC: not present. Role of the author according to the `Contributor Roles Taxonomy (CRediT) `_ :type: ``string`` :minLength: ``1`` **Allowed values:** - Conceptualization - Data curation - Formal analysis - Funding acquisition - Investigation - Methodology - Project administration - Resources - Software - Supervision - Validation - Visualization - Writing - original draft - Writing - review & editing .. _hep.json#/properties/authors/items/properties/curated_relation: curated_relation ################ :type: ``boolean`` :default: ``False`` .. _hep.json#/properties/authors/items/properties/emails: emails ###### :MARC: ``100/700/701__m`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **emails** is: :type: ``string`` :format: ``email`` :minLength: ``1`` .. _hep.json#/properties/authors/items/properties/full_name: full_name ######### .. container:: title Author name :MARC: ``100/700/701__a`` 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`` .. _hep.json#/properties/authors/items/properties/ids: ids ### .. container:: title Identifiers of the author :MARC: ``100/700/701__i/j`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **ids** is: :Reference: :ref:`id.json#/` .. _hep.json#/properties/authors/items/properties/inspire_roles: inspire_roles ############# :type: ``array`` :minItems: ``1`` .. container:: sub-title 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`` :ref:`hep.json#/properties/document_type`. ``editor`` :MARC: ``100/700__e:ed.`` This person is an editor of the conference proceedings. Should be used together with the ``proceedings`` :ref:`hep.json#/properties/document_type`. :type: ``string`` :default: ``author`` :minLength: ``1`` **Allowed values:** - author - supervisor - editor .. _hep.json#/properties/authors/items/properties/raw_affiliations: raw_affiliations ################ :MARC: ``100/700/701__v`` List of full affiliations, as written on the paper. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **raw_affiliations** is: :Reference: :ref:`sourced_value.json#/` .. _hep.json#/properties/authors/items/properties/record: record ###### :Reference: :ref:`author.json#/` .. _hep.json#/properties/authors/items/properties/signature_block: signature_block ############### Phonetic representation of the name, needed for author disambiguation. This field should not be edited manually. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/authors/items/properties/uuid: uuid #### .. container:: title 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`` .. _hep.json#/properties/book_series: book_series +++++++++++ :MARC: ``490`` 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 :ref:`hep.json#/properties/document_type`. :type: ``array`` :minItems: ``1`` .. container:: sub-title 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: :ref:`hep.json#/properties/book_series/items/properties/title` **Properties:** :ref:`hep.json#/properties/book_series/items/properties/title`, :ref:`hep.json#/properties/book_series/items/properties/volume` .. _hep.json#/properties/book_series/items/properties/title: title ##### .. container:: title Title of the book series :MARC: ``490__a`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/book_series/items/properties/volume: volume ###### .. container:: title Volume of the book in the series :MARC: ``490__v`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/citeable: 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 - sufficient information in :ref:`hep.json#/properties/publication_info`: :ref:`hep.json#/properties/publication_info/items/properties/journal_title`, :ref:`hep.json#/properties/publication_info/items/properties/journal_volume` and (:ref:`hep.json#/properties/publication_info/items/properties/artid` or :ref:`hep.json#/properties/publication_info/items/properties/page_start`), *or* - an :ref:`hep.json#/properties/arxiv_eprints` field. Besides, a record may be manually flagged as citeable by a curator if a user tracks and reports citations to that record. :type: ``boolean`` .. container:: title Whether this record should be considered as citeable .. _hep.json#/properties/collaborations: collaborations ++++++++++++++ .. container:: title List of collaborations :type: ``array`` :minItems: ``1`` :Required: :ref:`hep.json#/properties/collaborations/items/properties/value` .. container:: sub-title Every element of **collaborations** is: :type: ``object`` :Required: :ref:`hep.json#/properties/collaborations/items/properties/value` **Properties:** :ref:`hep.json#/properties/collaborations/items/properties/record`, :ref:`hep.json#/properties/collaborations/items/properties/value` .. _hep.json#/properties/collaborations/items/properties/record: record ###### :Reference: :ref:`experiment.json#/` .. _hep.json#/properties/collaborations/items/properties/value: value ##### .. container:: title Collaboration name :MARC: ``710__g`` 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`` .. _hep.json#/properties/control_number: control_number ++++++++++++++ .. container:: title ID of current record :MARC: ``001`` Read-only field. Also called ``record ID`` or ``recid``. :type: ``integer`` .. _hep.json#/properties/copyright: copyright +++++++++ .. container:: title List of copyrights to documents in this record :MARC: ``542`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **copyright** is: :type: ``object`` **Properties:** :ref:`hep.json#/properties/copyright/items/properties/holder`, :ref:`hep.json#/properties/copyright/items/properties/material`, :ref:`hep.json#/properties/copyright/items/properties/statement`, :ref:`hep.json#/properties/copyright/items/properties/url`, :ref:`hep.json#/properties/copyright/items/properties/year` .. _hep.json#/properties/copyright/items/properties/holder: holder ###### .. container:: title Copyright holder :MARC: ``542__d`` :example: ``American Physical Society`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/copyright/items/properties/material: material ######## :MARC: ``542__e`` :Reference: :ref:`material.json#/` .. _hep.json#/properties/copyright/items/properties/statement: statement ######### .. container:: title Copyright notice :MARC: ``542__f`` See `Wikipedia `_ for explanations. Alernatively to this string, a URL to the copyright notice may be provided in :ref:`hep.json#/properties/copyright/items/properties/url`. :example: ``© The Author(s) 2015. Published by Oxford University Press on behalf of the Physical Society of Japan.`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/copyright/items/properties/url: url ### .. container:: title Copyright notice URL :type: ``string`` :format: ``uri`` :minLength: ``1`` .. _hep.json#/properties/copyright/items/properties/year: year #### :MARC: ``542__g`` :type: ``integer`` :minimum: ``1000`` :maximum: ``2050`` .. _hep.json#/properties/core: core ++++ .. container:: title 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. :type: ``boolean`` .. _hep.json#/properties/corporate_author: corporate_author ++++++++++++++++ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **corporate_author** is: .. container:: title List of corporate authors :MARC: ``110__a`` 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`` .. _hep.json#/properties/curated: 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 :ref:`hep.json#/properties/core` flag are all curated eventually, whereas non-core records are not systematically curated. :type: ``boolean`` .. _hep.json#/properties/deleted: deleted +++++++ .. container:: title Whether this record has been deleted :MARC: ``980__a/c:deleted`` :type: ``boolean`` .. _hep.json#/properties/deleted_records: deleted_records +++++++++++++++ :MARC: ``981__a`` 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 :ref:`hep.json#/properties/new_record`. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **deleted_records** is: :Reference: :ref:`literature.json#/` .. _hep.json#/properties/document_type: 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, :ref:`hep.json#/properties/publication_info` contains information about the journal in which it was published. ``book`` A monograph that does not fit into any other :ref:`hep.json#/properties/document_type`. The :ref:`hep.json#/properties/editions`, :ref:`hep.json#/properties/imprints`, :ref:`hep.json#/properties/isbns` and :ref:`hep.json#/properties/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 :ref:`hep.json#/properties/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 :ref:`hep.json#/properties/publication_info` contain information about the conference proceedings. In particular, :ref:`hep.json#/properties/publication_info/items/properties/cnum` contains the identifier of the conference. ``note`` A note, not meant for publication. ``proceedings`` Proceedings of a conference. The :ref:`hep.json#/properties/publication_info/items/properties/cnum` field contains the identfier of the conference. If published in a journal, :ref:`hep.json#/properties/publication_info` also contains the journal information. If published as a book, the :ref:`hep.json#/properties/editions`, :ref:`hep.json#/properties/imprints`, :ref:`hep.json#/properties/isbns` and :ref:`hep.json#/properties/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 :ref:`hep.json#/properties/thesis_info` field contains additional information about the thesis. If published as a book, the :ref:`hep.json#/properties/editions`, :ref:`hep.json#/properties/imprints`, :ref:`hep.json#/properties/isbns` and :ref:`hep.json#/properties/book_series` fields may contain specific metadata about this book. .. note:: This is not considered as a ``book``. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **document_type** is: :Reference: :ref:`document_type.json#/` .. _hep.json#/properties/documents: documents +++++++++ .. container:: title List of documents attached to the record :MARC: ``8564`` (if the URL points to the inspire server) :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **documents** is: :type: ``object`` :Required: :ref:`hep.json#/properties/documents/items/properties/key`, :ref:`hep.json#/properties/documents/items/properties/url` **Properties:** :ref:`hep.json#/properties/documents/items/properties/description`, :ref:`hep.json#/properties/documents/items/properties/filename`, :ref:`hep.json#/properties/documents/items/properties/fulltext`, :ref:`hep.json#/properties/documents/items/properties/hidden`, :ref:`hep.json#/properties/documents/items/properties/key`, :ref:`hep.json#/properties/documents/items/properties/material`, :ref:`hep.json#/properties/documents/items/properties/original_url`, :ref:`hep.json#/properties/documents/items/properties/source`, :ref:`hep.json#/properties/documents/items/properties/url` .. _hep.json#/properties/documents/items/properties/description: description ########### :MARC: ``8564_y`` Describes how this document relates to the document that this record represents. :example: ``table of contents`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/documents/items/properties/filename: filename ######## .. container:: title Filename Proper name of the file :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/documents/items/properties/fulltext: fulltext ######## .. container:: title Whether this document contains the fulltext :type: ``boolean`` .. _hep.json#/properties/documents/items/properties/hidden: hidden ###### .. container:: title 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. :type: ``boolean`` .. _hep.json#/properties/documents/items/properties/key: key ### Key to the corresponding file, which must match the ``key`` in :ref:`hep.json#/properties/_files`. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/documents/items/properties/material: material ######## :Reference: :ref:`material.json#/` .. _hep.json#/properties/documents/items/properties/original_url: original_url ############ .. container:: title Original URL of the document :type: ``string`` :format: ``uri`` :minLength: ``1`` .. _hep.json#/properties/documents/items/properties/source: source ###### :Reference: :ref:`source.json#/` .. _hep.json#/properties/documents/items/properties/url: url ### :MARC: ``8564_u`` 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`` .. _hep.json#/properties/dois: dois ++++ .. container:: title List of DOIs :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **dois** is: :type: ``object`` :Required: :ref:`hep.json#/properties/dois/items/properties/value` **Properties:** :ref:`hep.json#/properties/dois/items/properties/material`, :ref:`hep.json#/properties/dois/items/properties/source`, :ref:`hep.json#/properties/dois/items/properties/value` .. _hep.json#/properties/dois/items/properties/material: material ######## :MARC: ``0247_q`` :Reference: :ref:`material.json#/` .. _hep.json#/properties/dois/items/properties/source: source ###### :MARC: ``0247_9`` :Reference: :ref:`source.json#/` .. _hep.json#/properties/dois/items/properties/value: value ##### .. container:: title DOI :MARC: ``0247_a`` :example: ``10.1023/A:1026654312961`` :type: ``string`` :pattern: ``^10\.\d+(\.\d+)?/\S+$`` :minLength: ``1`` .. _hep.json#/properties/editions: editions ++++++++ .. container:: title List of book editions :MARC: ``250__a`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **editions** is: :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/energy_ranges: 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`` .. container:: sub-title Every element of **energy_ranges** is: :type: ``string`` :minLength: ``1`` **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 .. _hep.json#/properties/external_system_identifiers: external_system_identifiers +++++++++++++++++++++++++++ :MARC: ``035`` List of identifiers of this document on external systems. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **external_system_identifiers** is: :type: ``object`` :Required: :ref:`hep.json#/properties/external_system_identifiers/items/properties/schema`, :ref:`hep.json#/properties/external_system_identifiers/items/properties/value` **Properties:** :ref:`hep.json#/properties/external_system_identifiers/items/properties/schema`, :ref:`hep.json#/properties/external_system_identifiers/items/properties/value` .. _hep.json#/properties/external_system_identifiers/items/properties/schema: schema ###### :MARC: ``035__9`` Identifies the external system, and allows to interpret unambiguously the :ref:`hep.json#/properties/external_system_identifiers/items/properties/value`. :example: ``ADS`` :type: ``string`` :pattern: ``^\w+$`` :minLength: ``1`` .. _hep.json#/properties/external_system_identifiers/items/properties/value: value ##### .. container:: title External identifier :MARC: ``035__a`` Identifies the record in the external system specified by :ref:`hep.json#/properties/external_system_identifiers/items/properties/schema`. :example: ``1999IJTP...38.1113M`` :type: ``string`` :pattern: ``^\S+$`` :minLength: ``1`` .. _hep.json#/properties/figures: figures +++++++ .. container:: title List of figures attached to the record .. note:: The order in which the figures appear in this list is the same as in the fulltext. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **figures** is: :type: ``object`` :Required: :ref:`hep.json#/properties/figures/items/properties/key`, :ref:`hep.json#/properties/figures/items/properties/url` **Properties:** :ref:`hep.json#/properties/figures/items/properties/caption`, :ref:`hep.json#/properties/figures/items/properties/filename`, :ref:`hep.json#/properties/figures/items/properties/key`, :ref:`hep.json#/properties/figures/items/properties/label`, :ref:`hep.json#/properties/figures/items/properties/material`, :ref:`hep.json#/properties/figures/items/properties/original_url`, :ref:`hep.json#/properties/figures/items/properties/source`, :ref:`hep.json#/properties/figures/items/properties/url` .. _hep.json#/properties/figures/items/properties/caption: caption ####### :MARC: ``8564_y`` (without the five-digit counter) :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/figures/items/properties/filename: filename ######## .. container:: title Filename Proper name of the file :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/figures/items/properties/key: key ### Key to the corresponding file, which matches a ``key`` in :ref:`hep.json#/properties/_files`. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/figures/items/properties/label: label ##### Label used to refer to this figure in the document. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/figures/items/properties/material: material ######## :MARC: not present (figures were extracted only from arXiv preprints) :Reference: :ref:`material.json#/` .. _hep.json#/properties/figures/items/properties/original_url: original_url ############ .. container:: title Original URL of the document :type: ``string`` :format: ``uri`` :minLength: ``1`` .. _hep.json#/properties/figures/items/properties/source: source ###### :Reference: :ref:`source.json#/` .. _hep.json#/properties/figures/items/properties/url: url ### :MARC: ``8564_u`` Relative URL to the file containing the figure. Its form is ``/files/bucket/key``. :type: ``string`` :format: ``uri-reference`` :pattern: ``^(https?://|/api/files/).*`` :minLength: ``1`` .. _hep.json#/properties/funding_info: funding_info ++++++++++++ .. container:: title Funding information :MARC: ``536`` Information about the sources of funding for the research performed in this record. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **funding_info** is: :type: ``object`` **Properties:** :ref:`hep.json#/properties/funding_info/items/properties/agency`, :ref:`hep.json#/properties/funding_info/items/properties/grant_number`, :ref:`hep.json#/properties/funding_info/items/properties/project_number` .. _hep.json#/properties/funding_info/items/properties/agency: agency ###### .. container:: title Funding agency :MARC: ``536__a`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/funding_info/items/properties/grant_number: grant_number ############ .. container:: title Grant number :MARC: ``536__c`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/funding_info/items/properties/project_number: project_number ############## .. container:: title Project number :MARC: ``536__f`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/imprints: imprints ++++++++ .. container:: title List of imprints :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **imprints** is: :MARC: ``260`` When/where/by whom this record was published. :type: ``object`` **Properties:** :ref:`hep.json#/properties/imprints/items/properties/date`, :ref:`hep.json#/properties/imprints/items/properties/place`, :ref:`hep.json#/properties/imprints/items/properties/publisher` .. _hep.json#/properties/imprints/items/properties/date: date #### .. container:: title Date of publication :MARC: ``260__c`` :type: ``string`` :format: ``date`` :minLength: ``1`` .. _hep.json#/properties/imprints/items/properties/place: place ##### .. container:: title Place of publication :MARC: ``260__a`` .. 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 :ref:`hep.json#/properties/document_type`. :example: ``Paris`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/imprints/items/properties/publisher: publisher ######### :MARC: ``260__b`` :example: ``Springer`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/inspire_categories: inspire_categories ++++++++++++++++++ .. container:: title List of Inspire categories :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **inspire_categories** is: :Reference: :ref:`inspire_field.json#/` .. _hep.json#/properties/isbns: isbns +++++ .. container:: title List of ISBNs :MARC: ``020`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **isbns** is: :type: ``object`` :Required: :ref:`hep.json#/properties/isbns/items/properties/value` **Properties:** :ref:`hep.json#/properties/isbns/items/properties/medium`, :ref:`hep.json#/properties/isbns/items/properties/value` .. _hep.json#/properties/isbns/items/properties/medium: medium ###### .. container:: title Physical medium to which this ISBN refers :MARC: ``020__b`` :type: ``string`` :minLength: ``1`` **Allowed values:** - hardcover - online - print - softcover .. _hep.json#/properties/isbns/items/properties/value: value ##### :MARC: ``020__a`` :example: ``0201021153`` :type: ``string`` :pattern: ``^\d*[0-9X]$`` :minLength: ``1`` .. _hep.json#/properties/keywords: keywords ++++++++ .. container:: title List of keywords :MARC: ``084``, ``6531`` and ``695`` (corresponding to different :ref:`hep.json#/properties/keywords/items/properties/schema`) Keywords give information about the specific contents of the record, much more precisely than :ref:`hep.json#/properties/inspire_categories`. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **keywords** is: :type: ``object`` :Required: :ref:`hep.json#/properties/keywords/items/properties/value` **Properties:** :ref:`hep.json#/properties/keywords/items/properties/schema`, :ref:`hep.json#/properties/keywords/items/properties/source`, :ref:`hep.json#/properties/keywords/items/properties/value` .. _hep.json#/properties/keywords/items/properties/schema: schema ###### .. container:: title Keyword vocabulary Describes to which vocabulary the keyword in :ref:`hep.json#/properties/keywords/items/properties/value` belongs. ``INIS`` :MARC: ``695__2:INIS`` The keyword is part of the `International Nuclear Information System (INIS) `_ vocabulary. ``INSPIRE`` :MARC: ``695__2:INSPIRE`` The keyword has been assigned by Inspire, and belongs to its vocabulary. ``JACOW`` :MARC: ``6531_2:JACOW`` The keyword is part of the `Joint Accelerator Conference Website (JACoW) vocabulary `_. ``PACS`` :MARC: ``084__2:PACS`` The keyword is a number from the `Physics and Astronomy Classification Scheme (PACS) `_. ``PDG`` :MARC: ``084__2:PDG`` The keyword is a `PDG Indentifier `_. .. note:: If not present, the keyword is a free-form keyword, not necessarily part of any vocabulary. :type: ``string`` :minLength: ``1`` **Allowed values:** - INIS - INSPIRE - JACOW - PACS - PDG .. _hep.json#/properties/keywords/items/properties/source: source ###### :Reference: :ref:`source.json#/` .. _hep.json#/properties/keywords/items/properties/value: value ##### .. container:: title A keyword :MARC: ``084/6531/695__a`` (depending on :ref:`hep.json#/properties/keywords/items/properties/schema`) It belongs to the vocabulary specified by :ref:`hep.json#/properties/keywords/items/properties/schema`. :example: ``black hole: mass`` (for :ref:`hep.json#/properties/keywords/items/properties/schema` = ``INSPIRE``) :example: ``29.27.Fh`` (for :ref:`hep.json#/properties/keywords/items/properties/schema` = ``PACS``) :example: ``G033M`` (for :ref:`hep.json#/properties/keywords/items/properties/schema` = ``PDG``) :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/languages: languages +++++++++ .. container:: title List of languages of the document :MARC: ``041__a`` .. note:: If this field is not present, the language of the document is assumed to be English. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **languages** is: :Reference: :ref:`language_code.json#/` .. _hep.json#/properties/legacy_creation_date: legacy_creation_date ++++++++++++++++++++ .. container:: title Date of record creation on legacy :MARC: ``961__x`` Only present if the record already existed on legacy Inspire. :type: ``string`` :format: ``date`` :minLength: ``1`` .. _hep.json#/properties/legacy_version: legacy_version ++++++++++++++ .. container:: title Last record update :MARC: ``005`` Used to indicate the version of the record on legacy. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/license: license +++++++ .. container:: title List of licenses :MARC: ``540`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **license** is: :type: ``object`` **Properties:** :ref:`hep.json#/properties/license/items/properties/imposing`, :ref:`hep.json#/properties/license/items/properties/license`, :ref:`hep.json#/properties/license/items/properties/material`, :ref:`hep.json#/properties/license/items/properties/url` .. _hep.json#/properties/license/items/properties/imposing: imposing ######## .. container:: title Organization/person imposing the license :MARC: ``540__b`` :example: ``arXiv`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/license/items/properties/license: license ####### .. container:: title License statement :MARC: ``540__a`` Either the short name of the license or the full license statement. :example: ``CC-BY-4.0`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/license/items/properties/material: material ######## :MARC: ``540__3`` :Reference: :ref:`material.json#/` .. _hep.json#/properties/license/items/properties/url: url ### .. container:: title URL of the license :MARC: ``540__u`` URL where the full license statement may be found, if only a short name is provided in ``license``. :type: ``string`` :format: ``uri`` :minLength: ``1`` .. _hep.json#/properties/new_record: new_record ++++++++++ .. container:: title Record replacing this one :MARC: ``970__d`` Contains a reference to the record replacing the current one, if it is marked as :ref:`hep.json#/properties/deleted`. :Reference: :ref:`literature.json#/` .. _hep.json#/properties/number_of_pages: number_of_pages +++++++++++++++ .. container:: title Number of pages of the document :MARC: ``300`` :type: ``integer`` :minimum: ``1`` .. _hep.json#/properties/persistent_identifiers: persistent_identifiers ++++++++++++++++++++++ .. container:: title List of persistent identifiers :MARC: ``0247`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **persistent_identifiers** is: :type: ``object`` :Required: :ref:`hep.json#/properties/persistent_identifiers/items/properties/schema`, :ref:`hep.json#/properties/persistent_identifiers/items/properties/value` **Properties:** :ref:`hep.json#/properties/persistent_identifiers/items/properties/material`, :ref:`hep.json#/properties/persistent_identifiers/items/properties/schema`, :ref:`hep.json#/properties/persistent_identifiers/items/properties/source`, :ref:`hep.json#/properties/persistent_identifiers/items/properties/value` .. _hep.json#/properties/persistent_identifiers/items/properties/material: material ######## :Reference: :ref:`material.json#/` .. _hep.json#/properties/persistent_identifiers/items/properties/schema: schema ###### .. container:: title Type of identifier :MARC: ``0247_2`` Currently, the following identifiers are recognized: * `HDL `_ * `URN `_ .. note:: DOIs should be put into :ref:`hep.json#/properties/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 :ref:`hep.json#/properties/isbns` field instead. :type: ``string`` :minLength: ``1`` **Allowed values:** - HDL - URN .. _hep.json#/properties/persistent_identifiers/items/properties/source: source ###### :Reference: :ref:`source.json#/` .. _hep.json#/properties/persistent_identifiers/items/properties/value: value ##### .. container:: title Persistent identifier :MARC: ``0247_a`` This value gets interpreted as an identfier of the type specified by :ref:`hep.json#/properties/persistent_identifiers/items/properties/schema`. :example: ``10138/168995`` (when :ref:`hep.json#/properties/persistent_identifiers/items/properties/schema` = ``HDL``) :example: ``urn:nbn:de:hebis:77-diss-1000009520`` (when :ref:`hep.json#/properties/persistent_identifiers/items/properties/schema` = ``URN``) :type: ``string`` :pattern: ``^\S+$`` :minLength: ``1`` .. _hep.json#/properties/preprint_date: preprint_date +++++++++++++ .. container:: title Preprint release date :MARC: ``269__c`` .. note:: This is only for preprints. For the publication date of published documents, see :ref:`hep.json#/properties/imprints`. :type: ``string`` :format: ``date`` :minLength: ``1`` .. _hep.json#/properties/public_notes: public_notes ++++++++++++ .. container:: title List of public notes :MARC: ``500`` 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 :ref:`hep.json#/properties/_private_notes`. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **public_notes** is: :Reference: :ref:`sourced_value.json#/` .. _hep.json#/properties/publication_info: publication_info ++++++++++++++++ .. container:: title List of information on publication :MARC: ``773`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **publication_info** is: :type: ``object`` **Properties:** :ref:`hep.json#/properties/publication_info/items/properties/artid`, :ref:`hep.json#/properties/publication_info/items/properties/cnum`, :ref:`hep.json#/properties/publication_info/items/properties/conf_acronym`, :ref:`hep.json#/properties/publication_info/items/properties/conference_record`, :ref:`hep.json#/properties/publication_info/items/properties/curated_relation`, :ref:`hep.json#/properties/publication_info/items/properties/hidden`, :ref:`hep.json#/properties/publication_info/items/properties/journal_issue`, :ref:`hep.json#/properties/publication_info/items/properties/journal_record`, :ref:`hep.json#/properties/publication_info/items/properties/journal_title`, :ref:`hep.json#/properties/publication_info/items/properties/journal_volume`, :ref:`hep.json#/properties/publication_info/items/properties/material`, :ref:`hep.json#/properties/publication_info/items/properties/page_end`, :ref:`hep.json#/properties/publication_info/items/properties/page_start`, :ref:`hep.json#/properties/publication_info/items/properties/parent_isbn`, :ref:`hep.json#/properties/publication_info/items/properties/parent_record`, :ref:`hep.json#/properties/publication_info/items/properties/parent_report_number`, :ref:`hep.json#/properties/publication_info/items/properties/pubinfo_freetext`, :ref:`hep.json#/properties/publication_info/items/properties/year` .. _hep.json#/properties/publication_info/items/properties/artid: artid ##### .. container:: title 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. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/cnum: cnum #### :MARC: ``773__w`` When ``conference` paper` or ``proceedings`` is among :ref:`hep.json#/properties/document_type`, contains the CNUM of the corresponding conference. :Reference: :ref:`cnum.json#/` .. _hep.json#/properties/publication_info/items/properties/conf_acronym: conf_acronym ############ .. container:: title Conference acronym :MARC: ``773__q`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/conference_record: conference_record ################# .. container:: title record of the conference :Reference: :ref:`conference.json#/` .. _hep.json#/properties/publication_info/items/properties/curated_relation: curated_relation ################ :type: ``boolean`` .. _hep.json#/properties/publication_info/items/properties/hidden: hidden ###### .. container:: title 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. :type: ``boolean`` .. _hep.json#/properties/publication_info/items/properties/journal_issue: journal_issue ############# :MARC: ``773__n`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/journal_record: journal_record ############## Record of the corresponding Journal :Reference: :ref:`journal.json#/` .. _hep.json#/properties/publication_info/items/properties/journal_title: journal_title ############# :MARC: ``773__p`` Journal title abbreviated as in the corresponding entry in the Journals collection. :example: ``Phys.Rev.`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/journal_volume: journal_volume ############## :MARC: ``773__v`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/material: material ######## :MARC: ``773__m`` :Reference: :ref:`material.json#/` .. _hep.json#/properties/publication_info/items/properties/page_end: page_end ######## .. container:: title Last page of document :MARC: last page in ``773__c`` (if present) :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/page_start: page_start ########## .. container:: title First page of document :MARC: first page in ``773__c`` (if not an :ref:`hep.json#/properties/publication_info/items/properties/artid`) :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/parent_isbn: parent_isbn ########### :MARC: ``773__z`` ISBN of the book of which this document is a part. :type: ``string`` :pattern: ``^\d*[0-9X]$`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/parent_record: parent_record ############# :Reference: :ref:`literature.json#/` .. _hep.json#/properties/publication_info/items/properties/parent_report_number: parent_report_number #################### :MARC: ``773__r`` 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. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/pubinfo_freetext: pubinfo_freetext ################ :MARC: ``773__x`` 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. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/publication_info/items/properties/year: year #### .. container:: title Publication year :MARC: ``773__y`` :type: ``integer`` :minimum: ``1000`` :maximum: ``2050`` .. _hep.json#/properties/publication_type: publication_type ++++++++++++++++ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **publication_type** is: :type: ``string`` :minLength: ``1`` **Allowed values:** - introductory - lectures - manual - review .. _hep.json#/properties/record_affiliations: record_affiliations +++++++++++++++++++ .. container:: title Affiliations not associated to authors :MARC: ``902`` Because of technical limitations, for some older records the affiliations were associated globally to the record instead of its individual authors (using the :ref:`hep.json#/properties/authors/items/properties/affiliations` field). .. note:: This field is present for legacy records and should not be used for new records. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **record_affiliations** is: :type: ``object`` :Required: :ref:`hep.json#/properties/record_affiliations/items/properties/value` **Properties:** :ref:`hep.json#/properties/record_affiliations/items/properties/curated_relation`, :ref:`hep.json#/properties/record_affiliations/items/properties/record`, :ref:`hep.json#/properties/record_affiliations/items/properties/value` .. _hep.json#/properties/record_affiliations/items/properties/curated_relation: curated_relation ################ :type: ``boolean`` .. _hep.json#/properties/record_affiliations/items/properties/record: record ###### :Reference: :ref:`institution.json#/` .. _hep.json#/properties/record_affiliations/items/properties/value: value ##### .. container:: title ICN of affiliation :MARC: ``902__a`` Currently, the old :ref:`institutions.json#/properties/legacy_ICN` is used here. In the future, this will change and become the new :ref:`institutions.json#/properties/ICN`. :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/refereed: refereed ++++++++ .. container:: title 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. :type: ``boolean`` .. _hep.json#/properties/references: references ++++++++++ .. container:: title List of references :MARC: ``999C5`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **references** is: :type: ``object`` **Properties:** :ref:`hep.json#/properties/references/items/properties/curated_relation`, :ref:`hep.json#/properties/references/items/properties/legacy_curated`, :ref:`hep.json#/properties/references/items/properties/raw_refs`, :ref:`hep.json#/properties/references/items/properties/record`, :ref:`hep.json#/properties/references/items/properties/reference` .. _hep.json#/properties/references/items/properties/curated_relation: curated_relation ################ :type: ``boolean`` .. _hep.json#/properties/references/items/properties/legacy_curated: 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. :type: ``boolean`` .. _hep.json#/properties/references/items/properties/raw_refs: raw_refs ######## .. container:: title List of raw references :MARC: ``999C5x`` These references are unparsed and as they appear in the document. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **raw_refs** is: :type: ``object`` :Required: :ref:`hep.json#/properties/references/items/properties/raw_refs/items/properties/value`, :ref:`hep.json#/properties/references/items/properties/raw_refs/items/properties/schema` **Properties:** :ref:`hep.json#/properties/references/items/properties/raw_refs/items/properties/schema`, :ref:`hep.json#/properties/references/items/properties/raw_refs/items/properties/source`, :ref:`hep.json#/properties/references/items/properties/raw_refs/items/properties/value` .. _hep.json#/properties/references/items/properties/raw_refs/items/properties/schema: schema >>>>>> .. container:: title Content type of the raw reference :example: ``text`` :example: ``Elsevier XML`` :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/references/items/properties/raw_refs/items/properties/source: source >>>>>> :Reference: :ref:`source.json#/` .. _hep.json#/properties/references/items/properties/raw_refs/items/properties/value: value >>>>> .. container:: title Content of the raw reference :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/references/items/properties/record: record ###### :MARC: ``999C50`` :Reference: :ref:`citeable.json#/` .. _hep.json#/properties/references/items/properties/reference: reference ######### :Reference: :ref:`reference.json#/` .. _hep.json#/properties/related_records: related_records +++++++++++++++ .. container:: title List of related records :MARC: ``78002``, ``78502``, ``78708`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **related_records** is: :Reference: :ref:`related_record.json#/` .. _hep.json#/properties/report_numbers: report_numbers ++++++++++++++ .. container:: title List of report numbers assigned to the record :MARC: ``037`` :example: ``DESY-17-036`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **report_numbers** is: :type: ``object`` :Required: :ref:`hep.json#/properties/report_numbers/items/properties/value` **Properties:** :ref:`hep.json#/properties/report_numbers/items/properties/hidden`, :ref:`hep.json#/properties/report_numbers/items/properties/source`, :ref:`hep.json#/properties/report_numbers/items/properties/value` .. _hep.json#/properties/report_numbers/items/properties/hidden: hidden ###### :MARC: if ``true``, the :ref:`hep.json#/properties/report_numbers/items/properties/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). :type: ``boolean`` .. _hep.json#/properties/report_numbers/items/properties/source: source ###### :Reference: :ref:`source.json#/` .. _hep.json#/properties/report_numbers/items/properties/value: value ##### :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/rpp: rpp +++ :MARC: ``210__a:RPP`` corresponds to ``true`` Whether this record is (part of) the Review of Particle Physics :type: ``boolean`` .. _hep.json#/properties/self: self ++++ :Reference: :ref:`literature.json#/` .. _hep.json#/properties/texkeys: texkeys +++++++ .. container:: title 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. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **texkeys** is: :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/thesis_info: thesis_info +++++++++++ :MARC: ``502`` Information on a thesis (degree, date, university) :type: ``object`` **Properties:** :ref:`hep.json#/properties/thesis_info/properties/date`, :ref:`hep.json#/properties/thesis_info/properties/defense_date`, :ref:`hep.json#/properties/thesis_info/properties/degree_type`, :ref:`hep.json#/properties/thesis_info/properties/institutions` .. _hep.json#/properties/thesis_info/properties/date: date #### :MARC: ``502__d`` Publication date of the thesis :type: ``string`` :format: ``date`` :minLength: ``1`` .. _hep.json#/properties/thesis_info/properties/defense_date: defense_date ############ :MARC: ``500__a`` Date of the thesis defense. On legacy, this was put in the note field as 'presented on ...'. :type: ``string`` :format: ``date`` :minLength: ``1`` .. _hep.json#/properties/thesis_info/properties/degree_type: degree_type ########### :MARC: ``502__b`` :Reference: :ref:`degree_type.json#/` .. _hep.json#/properties/thesis_info/properties/institutions: institutions ############ :MARC: ``502__c`` List of institutions issuing the degree. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **institutions** is: :type: ``object`` **Properties:** :ref:`hep.json#/properties/thesis_info/properties/institutions/items/properties/curated_relation`, :ref:`hep.json#/properties/thesis_info/properties/institutions/items/properties/name`, :ref:`hep.json#/properties/thesis_info/properties/institutions/items/properties/record` .. _hep.json#/properties/thesis_info/properties/institutions/items/properties/curated_relation: curated_relation >>>>>>>>>>>>>>>> :type: ``boolean`` .. _hep.json#/properties/thesis_info/properties/institutions/items/properties/name: name >>>> :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/thesis_info/properties/institutions/items/properties/record: record >>>>>> :Reference: :ref:`institution.json#/` .. _hep.json#/properties/title_translations: title_translations ++++++++++++++++++ :MARC: ``242`` Translations of the titles in a language that is not the language of the document (see :ref:`hep.json#/properties/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. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **title_translations** is: :type: ``object`` :Required: :ref:`hep.json#/properties/title_translations/items/properties/language`, :ref:`hep.json#/properties/title_translations/items/properties/title` **Properties:** :ref:`hep.json#/properties/title_translations/items/properties/language`, :ref:`hep.json#/properties/title_translations/items/properties/source`, :ref:`hep.json#/properties/title_translations/items/properties/subtitle`, :ref:`hep.json#/properties/title_translations/items/properties/title` .. _hep.json#/properties/title_translations/items/properties/language: language ######## :Reference: :ref:`language_code.json#/` .. _hep.json#/properties/title_translations/items/properties/source: source ###### :Reference: :ref:`source.json#/` .. _hep.json#/properties/title_translations/items/properties/subtitle: subtitle ######## :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/title_translations/items/properties/title: title ##### :type: ``string`` :minLength: ``1`` .. _hep.json#/properties/titles: titles ++++++ :MARC: ``245`` 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 :ref:`hep.json#/properties/languages`). Translations go into :ref:`hep.json#/properties/title_translations`. :type: ``array`` :minItems: ``1`` .. container:: title List of titles .. container:: sub-title Every element of **titles** is: :Reference: :ref:`title.json#/` .. _hep.json#/properties/urls: urls ++++ :MARC: ``8564`` URLs to external resources related to this record. .. note:: Links to internal resources are found in :ref:`hep.json#/properties/figures` or :ref:`hep.json#/properties/documents`. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **urls** is: :Reference: :ref:`url.json#/` .. _hep.json#/properties/withdrawn: 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. :type: ``boolean``