reference¶

A reference to a cited document

This is structurally very similar to a Literature record, with unnecessary fields removed. For more information about the meaning of the different fields, see the corresponding field in hep.

type:	`object`

Properties: arxiv_eprint, authors, book_series, collaborations, document_type, dois, external_system_identifiers, imprint, isbn, label, misc, persistent_identifiers, publication_info, report_numbers, texkey, title, urls

arxiv_eprint¶

arXiv eprint number

MARC:	`999C5r` with `arXiv:` prefix
example:	`1703.07274`
type:	`string`
pattern:	`^\d{4}.\d{4`, `5}\|[\w.]+(-[\w.]+)?/\d+$`
minLength:	`1`

authors¶

List of authors

MARC:	`999C5h` contains a comma-separated string with all authors, in `first_name last_name` order.
type:	`array`
minItems:	`1`

Every element of authors is:

type:	`object`

Properties: full_name, inspire_role

full_name¶

Should be of the same form as full_name.

example:	`Smith, John G.D.`
type:	`string`
minLength:	`1`

inspire_role¶

MARC:	`999C5e` for `editor`
type:	`string`
minLength:	`1`

Allowed values:

author
supervisor
editor

book_series¶

type:	`object`

Properties: title, volume

title¶

type:	`string`
minLength:	`1`

volume¶

type:	`string`
minLength:	`1`

collaborations¶

type:	`array`
minItems:	`1`

Every element of collaborations is:

MARC:	`999C5c`
type:	`string`
minLength:	`1`

document_type¶

MARC:	conceptually similar to `999C5d`, but allowed values differ.
Reference:	document_type

dois¶

type:	`array`
minItems:	`1`

Every element of dois is:

MARC:	`999C5a` with prefix `doi:`
type:	`string`
pattern:	`^10\.\d+(\.\d+)?/.+$`
minLength:	`1`

external_system_identifiers¶

MARC:	`999C5u` (as url)

List of identifiers of this document on external systems.

type:	`array`
minItems:	`1`

Every element of external_system_identifiers is:

type:	`object`
Required:	schema, value

Properties: schema, value

schema¶

MARC:	`999C5u` (as url)
type:	`string`
pattern:	`^\w+$`
minLength:	`1`

value¶

External identifier

MARC:	`999C5u` (as url)
type:	`string`
pattern:	`^\S+$`
minLength:	`1`

imprint¶

type:	`object`

Properties: date, place, publisher

date¶

type:	`string`
format:	`date`
minLength:	`1`

place¶

type:	`string`
minLength:	`1`

publisher¶

MARC:	`999C5p`
type:	`string`
minLength:	`1`

isbn¶

MARC:	`999C5i`

ISBN if the cited document is a book.

Note

If the cited document is a book chapter, use parent_isbn instead.

type:	`string`
pattern:	`^\d*[0-9X]$`
minLength:	`1`

label¶

MARC:	`999C5o`

Label used to refer to the reference in the main text, and put in front of the reference in the reference list. Often, this is a number, found in square brackets. These brackets (or parentheses), if present, should not be put here.

example:	`42`
example:	`Jones1995c`
type:	`string`
minLength:	`1`

misc¶

MARC:	`999C5m`

Unrecognized information from the reference.

type:	`array`
minItems:	`1`

Every element of misc is:

type:	`string`
minLength:	`1`

persistent_identifiers¶

MARC:	`999C5a` (with prefix `hdl:` or `urn:`)
type:	`array`
minItems:	`1`

Every element of persistent_identifiers is:

type:	`object`

Properties: schema, value

schema¶

type:	`string`
minLength:	`1`

Allowed values:

HDL
URN

value¶

type:	`string`
minLength:	`1`

publication_info¶

type:	`object`

Properties: artid, cnum, journal_issue, journal_record, journal_title, journal_volume, material, page_end, page_start, parent_isbn, parent_report_number, parent_title, year

artid¶

MARC:	last part of `999C5s` (if not a page)
type:	`string`
minLength:	`1`

cnum¶

MARC:	`999C5b`
Reference:	cnum

journal_issue¶

MARC:	`999C5n`
type:	`string`
minLength:	`1`

journal_record¶

Reference:	journal

journal_title¶

MARC:	first part of `999C5s`
type:	`string`
minLength:	`1`

journal_volume¶

MARC:	second part of `999C5s`
type:	`string`
minLength:	`1`

material¶

Reference:	material

page_end¶

MARC:	Last part of `999C5s` (if page-range)
type:	`string`
minLength:	`1`

page_start¶

MARC:	Last part of `999C5s` (if not article ID)
type:	`string`
minLength:	`1`

parent_isbn¶

MARC:	`999C5i`, but not distinguished from the isbn of the cited document.

If the cited document is a book chapter, this is the ISBN of the book.

type:	`string`
pattern:	`^\d*[0-9X]$`
minLength:	`1`

parent_report_number¶

MARC:	`999C5r` but not distinguished from the cited document report_numbers.
type:	`string`
minLength:	`1`

parent_title¶

MARC:	`999C5q`

Title of the parent document, e.g. title of the book if the cited document is a book chapter.

type:	`string`
minLength:	`1`

year¶

MARC:	`999C5y`
type:	`integer`
minimum:	`1000`
maximum:	`2050`

report_numbers¶

MARC:	`999C5r`

Note

If the cited document is only part of a report, use parent_report_number instead.

type:	`array`
minItems:	`1`

Every element of report_numbers is:

type:	`string`
minLength:	`1`

texkey¶

MARC:	`999C5k`

Key that was used for this citation in the document. This may be extracted if the document is a PDF generated from a LaTeX, and possibly coincides with the one of the texkeys assigned to the cited document by Inspire and made visible in the TeX export formats.

example:	`Maldacena:1997re`
type:	`string`
minLength:	`1`

title¶

Reference:	title
MARC:	`999C5t`

urls¶

type:	`array`
minItems:	`1`

Every element of urls is:

URL of related document

MARC:	`999C5u`
type:	`object`
Required:	value

Properties: description, value

description¶

type:	`string`
minLength:	`1`

value¶

type:	`string`
minLength:	`1`