Record representing a single publication.
tid
Timestamp-based ID
Properties
authors
array
of
ref
#author
Optional
Co-authors. The record owner is always an implicit author.
maxLength: 50 itemscreatedAt
string
datetime
Required
Client-declared timestamp when this record was originally created.
description
string
Optional
Description or abstract.
maxLength: 50000 bytesmaxGraphemes: 5000 graphemesdoi
string
Optional
Digital Object Identifier, bare rather than as a URL: "10.1234/example", not "https://doi.org/10.1234/example". A DOI identifies the work itself, so it is what two records describing one publication can be matched on. Carrying it inside `url` makes it a link and stops it being an identifier.
maxLength: 2560 bytesmaxGraphemes: 256 graphemesisPrimary
boolean
Optional
Whether this is the user's primary publication, surfaced in profile Highlights. Any entry may be primary.
publishedAt
string
Optional
Publication date in YYYY-MM or YYYY-MM-DD format.
publisher
string
Optional
Publisher, journal, or venue name.
maxLength: 2560 bytesmaxGraphemes: 256 graphemesrelatedIdentifiers
array
of
ref
id.sifa.defs#relatedIdentifier
Optional
Other versions or forms of this work, such as the published version of a preprint. A consumer can show linked versions as one publication.
maxLength: 20 itemssameAs
ref
id.sifa.defs#externalRecordRef
Optional
The same publication as recorded on another person's profile. Set when you keep your own entry for work someone else has also recorded, so consumers can tell the two describe one thing rather than showing it twice. Each side stays its own record: the other person cannot edit yours, and yours does not change theirs. Resolve by AT-URI, since they will keep editing their copy.
subtitle
string
Optional
Publication subtitle. Carries the distinguishing part of a title that sources such as Crossref and ORCID store separately from the main title -- for example the volume/part designation and descriptive clause of a multi-part paper series ("III. Using cluster masses to create a cleaned catalogue"). Absent for publications with no subtitle.
maxLength: 2000 bytesmaxGraphemes: 200 graphemestitle
string
Required
Publication title.
maxLength: 2000 bytesminLength: 1 bytesmaxGraphemes: 200 graphemestype
string
Optional
Resource type. Open set: the known values are ORCID's work-type vocabulary, which is what Sifa already ingests and stores unmapped, so a synced work round-trips without a translation table. A value outside the set is kept as written rather than rejected, because a publication that reached Sifa from somewhere other than ORCID need not fit ORCID's list.
maxLength: 640 bytesmaxGraphemes: 64 graphemesjournal-article, conference-paper, conference-abstract, conference-poster, book, book-chapter, book-review, edited-book, dissertation, preprint, dataset, report, review, patent, software, working-paper, artistic-performance, lecture-speech, online-resource, newspaper-article, research-technique, standards-and-policy, technical-standard, registered-copyright, translation, dictionary-entry, encyclopedia-entry, supervised-student-publication, annotation, test, spin-off-company, disclosure, license, trademark, design, otherurl
string
uri
Optional
URL to the publication.
View raw schema
{
"description": "Record representing a single publication.",
"key": "tid",
"record": {
"properties": {
"authors": {
"description": "Co-authors. The record owner is always an implicit author.",
"items": {
"ref": "#author",
"type": "ref"
},
"maxLength": 50,
"type": "array",
"x-skos:exactMatch": [
"bibo:authorList",
"schema:author"
],
"x-skos:note": "bibo:authorList is an ordered rdf:List and preserves author order, which schema:author does not guarantee."
},
"createdAt": {
"description": "Client-declared timestamp when this record was originally created.",
"format": "datetime",
"type": "string"
},
"description": {
"description": "Description or abstract.",
"maxGraphemes": 5000,
"maxLength": 50000,
"type": "string",
"x-skos:exactMatch": [
"bibo:abstract",
"schema:abstract"
]
},
"doi": {
"description": "Digital Object Identifier, bare rather than as a URL: \"10.1234/example\", not \"https://doi.org/10.1234/example\". A DOI identifies the work itself, so it is what two records describing one publication can be matched on. Carrying it inside `url` makes it a link and stops it being an identifier.",
"maxGraphemes": 256,
"maxLength": 2560,
"type": "string",
"x-skos:exactMatch": [
"bibo:doi",
"prism:doi"
],
"x-skos:note": "schema:identifier with a PropertyValue of propertyID 'doi' is the JSON-LD serialization; bibo:doi is the direct term."
},
"isPrimary": {
"description": "Whether this is the user's primary publication, surfaced in profile Highlights. Any entry may be primary.",
"type": "boolean"
},
"publishedAt": {
"description": "Publication date in YYYY-MM or YYYY-MM-DD format.",
"type": "string",
"x-skos:exactMatch": [
"dcterms:issued",
"schema:datePublished"
]
},
"publisher": {
"description": "Publisher, journal, or venue name.",
"maxGraphemes": 256,
"maxLength": 2560,
"type": "string",
"x-skos:exactMatch": [
"dcterms:publisher",
"schema:publisher"
]
},
"relatedIdentifiers": {
"description": "Other versions or forms of this work, such as the published version of a preprint. A consumer can show linked versions as one publication.",
"items": {
"ref": "id.sifa.defs#relatedIdentifier",
"type": "ref"
},
"maxLength": 20,
"type": "array",
"x-skos:closeMatch": [
"dcterms:relation"
]
},
"sameAs": {
"description": "The same publication as recorded on another person's profile. Set when you keep your own entry for work someone else has also recorded, so consumers can tell the two describe one thing rather than showing it twice. Each side stays its own record: the other person cannot edit yours, and yours does not change theirs. Resolve by AT-URI, since they will keep editing their copy.",
"ref": "id.sifa.defs#externalRecordRef",
"type": "ref"
},
"subtitle": {
"description": "Publication subtitle. Carries the distinguishing part of a title that sources such as Crossref and ORCID store separately from the main title -- for example the volume/part designation and descriptive clause of a multi-part paper series (\"III. Using cluster masses to create a cleaned catalogue\"). Absent for publications with no subtitle.",
"maxGraphemes": 200,
"maxLength": 2000,
"type": "string",
"x-skos:closeMatch": [
"schema:alternativeHeadline"
]
},
"title": {
"description": "Publication title.",
"maxGraphemes": 200,
"maxLength": 2000,
"minLength": 1,
"type": "string",
"x-skos:exactMatch": [
"dcterms:title",
"schema:name"
]
},
"type": {
"description": "Resource type. Open set: the known values are ORCID's work-type vocabulary, which is what Sifa already ingests and stores unmapped, so a synced work round-trips without a translation table. A value outside the set is kept as written rather than rejected, because a publication that reached Sifa from somewhere other than ORCID need not fit ORCID's list.",
"knownValues": [
"journal-article",
"conference-paper",
"conference-abstract",
"conference-poster",
"book",
"book-chapter",
"book-review",
"edited-book",
"dissertation",
"preprint",
"dataset",
"report",
"review",
"patent",
"software",
"working-paper",
"artistic-performance",
"lecture-speech",
"online-resource",
"newspaper-article",
"research-technique",
"standards-and-policy",
"technical-standard",
"registered-copyright",
"translation",
"dictionary-entry",
"encyclopedia-entry",
"supervised-student-publication",
"annotation",
"test",
"spin-off-company",
"disclosure",
"license",
"trademark",
"design",
"other"
],
"maxGraphemes": 64,
"maxLength": 640,
"type": "string",
"x-skos:closeMatch": [
"dcterms:type",
"schema:additionalType"
],
"x-skos:note": "COAR Resource Types is the anchor a consumer should map to. The values here are ORCID's because that is the vocabulary the data arrives in; deviating from the id.sifa.defs token convention is deliberate, since the vocabulary is ORCID's rather than Sifa's."
},
"url": {
"description": "URL to the publication.",
"format": "uri",
"type": "string",
"x-skos:exactMatch": [
"bibo:uri",
"schema:url"
]
}
},
"required": [
"title",
"createdAt"
],
"type": "object"
},
"type": "record",
"x-skos:broadMatch": [
"bibo:Document",
"schema:CreativeWork"
],
"x-skos:note": "Refine to bibo:AcademicArticle, bibo:Book, bibo:Report or bibo:Thesis when a resource type is known. COAR is the value anchor."
}