{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/university-of-bath/main/json-schema/university-of-bath-researchoutput-schema.json", "title": "University of Bath Pure API ResearchOutput", "description": "Research output exists in many variations, from written to non-textual form. Templates are available for a range of these variations.", "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type", "typeDiscriminator" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "uuid": { "type": "string", "description": "UUID, this is the primary identity of the entity", "format": "uuid", "readOnly": true }, "createdBy": { "type": "string", "description": "Username of creator", "readOnly": true }, "createdDate": { "type": "string", "description": "Date and time of creation", "format": "date-time", "readOnly": true }, "modifiedBy": { "type": "string", "description": "Username of the user that performed a modification", "readOnly": true }, "modifiedDate": { "type": "string", "description": "Date and time of last modification", "format": "date-time", "readOnly": true }, "portalUrl": { "type": "string", "description": "URL of the content on the Pure Portal", "readOnly": true }, "prettyUrlIdentifiers": { "type": "array", "description": "All pretty URLs", "readOnly": true, "items": { "type": "string", "description": "All pretty URLs", "readOnly": true } }, "previousUuids": { "type": "array", "description": "UUIDs of other content items which have been merged into this content item (or similar)", "readOnly": true, "items": { "type": "string", "description": "UUIDs of other content items which have been merged into this content item (or similar)", "readOnly": true } }, "version": { "type": "string", "description": "Used to guard against conflicting updates. For new content this is null, and for existing content the current value. The property should never be modified by a client, except in the rare case where the client wants to perform an update irrespective of if other clients have made updates in the meantime, also known as a \"dirty write\". A dirty write is performed by not including the property value or setting the property to null", "nullable": true }, "title": { "$ref": "#/$defs/FormattedString" }, "subTitle": { "$ref": "#/$defs/FormattedString" }, "type": { "$ref": "#/$defs/ClassificationRef" }, "category": { "$ref": "#/$defs/ClassificationRef" }, "peerReview": { "type": "boolean", "description": "Indicates whether the research output is peer reviewed or not. Query the /research-outputs/allowed-peer-review-configurations endpoint for allowed values.", "nullable": true }, "internationalPeerReview": { "type": "boolean", "description": "Indicates whether the research output is internationally peer reviewed or not. Query the /research-outputs/allowed-peer-review-configurations endpoint for allowed values.", "nullable": true }, "publicationStatuses": { "type": "array", "description": "Manage the research output's different statuses and dates these were reached.", "items": { "$ref": "#/$defs/PublicationStatus" } }, "language": { "$ref": "#/$defs/ClassificationRef" }, "translatedTitle": { "$ref": "#/$defs/FormattedLocalizedString" }, "translatedSubTitle": { "$ref": "#/$defs/FormattedLocalizedString" }, "contributors": { "type": "array", "description": "Contributors and their affiliations", "items": { "$ref": "#/$defs/AbstractContributorAssociation" } }, "organizations": { "type": "array", "description": "A collection of organizational unit affiliations.", "nullable": true, "items": { "$ref": "#/$defs/OrganizationRef" } }, "externalOrganizations": { "type": "array", "description": "A collection of external organization affiliations.", "nullable": true, "items": { "$ref": "#/$defs/ExternalOrganizationRef" } }, "totalNumberOfContributors": { "type": "integer", "description": "The total number of authors from author collaborations.", "format": "int32", "nullable": true }, "managingOrganization": { "$ref": "#/$defs/OrganizationRef" }, "submissionYear": { "type": "integer", "description": "The submission year of the research output.", "format": "int32", "nullable": true }, "mainResearchArea": { "$ref": "#/$defs/ClassificationRef" }, "electronicVersions": { "type": "array", "description": "Electronic versions of this research output.", "nullable": true, "items": { "$ref": "#/$defs/ElectronicVersion" } }, "additionalFiles": { "type": "array", "description": "Additional files related to this research output.", "nullable": true, "items": { "$ref": "#/$defs/AdditionalFileElectronicVersion" } }, "links": { "type": "array", "description": "Additional links associated with this research output.", "nullable": true, "items": { "$ref": "#/$defs/Link" } }, "articleProcessingCharge": { "$ref": "#/$defs/ArticleProcessingCharge" }, "keywordGroups": { "type": "array", "description": "Groups of keywords associated with the research output.", "nullable": true, "items": { "$ref": "#/$defs/KeywordGroup" } }, "bibliographicalNote": { "$ref": "#/$defs/LocalizedString" }, "descriptions": { "type": "array", "description": "A list of descriptions for this research output. Query the relevant /research-outputs/allowed-*-description-types endpoint for allowed types.", "nullable": true, "items": { "$ref": "#/$defs/ClassifiedFormattedLocalizedValue" } }, "visibility": { "$ref": "#/$defs/Visibility" }, "workflow": { "$ref": "#/$defs/Workflow" }, "identifiers": { "type": "array", "description": "Identifiers related to the research output.", "nullable": true, "items": { "$ref": "#/$defs/Identifier" } }, "activities": { "type": "array", "description": "Activities related to the research output,", "nullable": true, "items": { "$ref": "#/$defs/ActivityRef" } }, "equipment": { "type": "array", "description": "Equipment related to the research output.", "nullable": true, "items": { "$ref": "#/$defs/EquipmentRef" } }, "projects": { "type": "array", "description": "Projects related to the research output.", "nullable": true, "items": { "$ref": "#/$defs/ProjectAwardableAssociation" } }, "researchOutputs": { "type": "array", "description": "Other related research outputs.", "nullable": true, "items": { "$ref": "#/$defs/ResearchOutputAssociation" } }, "customDefinedFields": { "$ref": "#/$defs/CustomDefinedFields" }, "images": { "type": "array", "description": "Image files with a maximum file size of 1MB", "nullable": true, "items": { "$ref": "#/$defs/ImageFile" } }, "fundingText": { "$ref": "#/$defs/LocalizedString" }, "fundingDetails": { "type": "array", "description": "The funding details for the research output", "nullable": true, "items": { "$ref": "#/$defs/FundingDetails" } }, "systemName": { "type": "string", "description": "The content system name", "readOnly": true }, "abstract": { "$ref": "#/$defs/FormattedLocalizedString" }, "typeDiscriminator": { "type": "string" } }, "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "BookAnthology": "#/components/schemas/BookAnthology", "ContributionToBookAnthology": "#/components/schemas/ContributionToBookAnthology", "ContributionToConference": "#/components/schemas/ContributionToConference", "ContributionToJournal": "#/components/schemas/ContributionToJournal", "ContributionToMemorandum": "#/components/schemas/ContributionToMemorandum", "ContributionToPeriodical": "#/components/schemas/ContributionToPeriodical", "Memorandum": "#/components/schemas/Memorandum", "NonTextual": "#/components/schemas/NonTextual", "OtherContribution": "#/components/schemas/OtherContribution", "Patent": "#/components/schemas/Patent", "Thesis": "#/components/schemas/Thesis", "WorkingPaper": "#/components/schemas/WorkingPaper" } }, "$defs": { "AbstractContributorAssociation": { "required": [ "typeDiscriminator" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "externalOrganizations": { "type": "array", "description": "A collection of external organization affiliations.", "nullable": true, "items": { "$ref": "#/$defs/ExternalOrganizationRef" } }, "typeDiscriminator": { "type": "string" } }, "description": "An association between research output and a person that has contributed to it", "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "InternalContributorAssociation": "#/components/schemas/InternalContributorAssociation", "ExternalContributorAssociation": "#/components/schemas/ExternalContributorAssociation", "AuthorCollaborationContributorAssociation": "#/components/schemas/AuthorCollaborationContributorAssociation" } } }, "AccessDefinitionRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an access definition", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ActivityRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an activity", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "AdditionalFileElectronicVersion": { "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "accessType": { "$ref": "#/$defs/ClassificationRef" }, "embargoPeriod": { "$ref": "#/$defs/DateRange" }, "licenseType": { "$ref": "#/$defs/ClassificationRef" }, "userDefinedLicense": { "type": "string", "description": "License defined by the user.", "nullable": true }, "visibleOnPortalDate": { "type": "string", "description": "Date where this document is/will be visible on the portal.", "format": "date", "readOnly": true }, "creator": { "type": "string", "description": "Username of creator.", "readOnly": true }, "created": { "type": "string", "description": "Date and time of creation.", "format": "date-time", "readOnly": true }, "title": { "type": "string", "description": "The title of the file.", "nullable": true }, "file": { "$ref": "#/$defs/ElectronicVersionFile" } }, "description": "An additional file related to a research output." }, "Anzsrc2008FieldOfResearchRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a Anzsrc2008FieldOfResearch", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Anzsrc2020FieldOfResearchRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a Anzsrc2020FieldOfResearch", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Anzsrc2020SocioEconomicObjectiveRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a Anzsrc2020SocioEconomicObjective", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Anzsrc2020TypeOfActivityRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a Anzsrc2020TypeOfActivity", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ApplicationClusterRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an application cluster", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ApplicationRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an application", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ArticleProcessingCharge": { "type": "object", "properties": { "paid": { "type": "boolean", "description": "This value is true if the processing charge has been paid, false if not and null/not presentif unknown or not noted on content." }, "amountInCurrency": { "$ref": "#/$defs/CurrencyAmount" }, "amount": { "$ref": "#/$defs/SystemCurrencyAmount" } }, "description": "Holds information on the article processing charge" }, "AuthorCollaborationContributorAssociation": { "required": [ "authorCollaboration" ], "type": "object", "description": "An author collaboration contributor associated with the content.", "allOf": [ { "$ref": "#/$defs/AbstractContributorAssociation" }, { "type": "object", "properties": { "authorCollaboration": { "$ref": "#/$defs/AuthorCollaborationRef" } } } ] }, "AuthorCollaborationRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an author collaboration", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "AwardClusterRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an award cluster", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "AwardRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an award", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "BookAnthology": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "Books, reports and anthologies/collected works where the author(s) are responsible for the entire work.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "commissioningBody": { "$ref": "#/$defs/ExternalOrganizationRef" }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true }, "volume": { "type": "string", "description": "The volume that the research output was published in.", "nullable": true }, "publicationSeries": { "type": "array", "description": "The publication series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/PublicationSeries" } }, "placeOfPublication": { "type": "string", "description": "The place of publication.", "nullable": true }, "edition": { "type": "string", "description": "The edition that the production was published in.", "nullable": true }, "printISBNs": { "type": "array", "description": "The ISBN number for the printed versions of the production.", "nullable": true, "items": { "type": "string" } }, "electronicISBNs": { "type": "array", "description": "The ISBN number for the electronic versions of the production.", "nullable": true, "items": { "type": "string" } }, "publisher": { "$ref": "#/$defs/PublisherRef" }, "bookSeries": { "type": "array", "description": "The book series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/BookSeriesJournalAssociation" } }, "event": { "$ref": "#/$defs/EventRef" } } } ] }, "BookSeriesJournalAssociation": { "required": [ "journal" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "title": { "$ref": "#/$defs/JournalTitleRef" }, "issn": { "$ref": "#/$defs/ISSNRef" }, "journal": { "$ref": "#/$defs/JournalRef" }, "no": { "type": "string" }, "volume": { "type": "string" } }, "description": "A relation describing the association between a book series and the associated journal." }, "CaseNote": { "required": [ "court", "judgementDate" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "court": { "$ref": "#/$defs/ExternalOrganizationRef" }, "title": { "$ref": "#/$defs/LocalizedString" }, "judgementDate": { "type": "string", "description": "The judgement date.", "format": "date" }, "sources": { "type": "array", "description": "Classified case note sources", "nullable": true, "items": { "$ref": "#/$defs/ClassifiedCaseNoteSource" } } }, "description": "A note on a case, detailing title, judgement data and court processing case." }, "ClassificationRef": { "required": [ "uri" ], "type": "object", "properties": { "uri": { "type": "string", "description": "Classification URI of the referred classification" }, "term": { "$ref": "#/$defs/SystemLocalizedString" } }, "description": "A reference to a classification value", "nullable": true }, "ClassificationSchemeRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a classification scheme", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ClassificationsKeywordGroup": { "required": [ "logicalName" ], "type": "object", "description": "De-normalized version of the full keyword group representation for instances where only structured keywords can be selected", "allOf": [ { "$ref": "#/$defs/KeywordGroup" }, { "type": "object", "properties": { "classifications": { "type": "array", "description": "A list classifications extracted from the keyword group structured keyword concept", "nullable": true, "items": { "$ref": "#/$defs/ClassificationRef" } } } } ] }, "ClassifiedCaseNoteSource": { "required": [ "classification", "value" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "classification": { "$ref": "#/$defs/ClassificationRef" }, "value": { "type": "string", "description": "The identifier of the case note in the source system." } }, "description": "Identification value of the case note in the source system." }, "ClassifiedFormattedLocalizedValue": { "required": [ "type" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "value": { "$ref": "#/$defs/FormattedLocalizedString" }, "type": { "$ref": "#/$defs/ClassificationRef" } }, "description": "A classified formatted localized value" }, "ClassifiedId": { "required": [ "id", "type" ], "type": "object", "description": "A classified ID", "allOf": [ { "$ref": "#/$defs/Identifier" }, { "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object", "format": "int64", "readOnly": true }, "id": { "type": "string", "description": "Classified ID" }, "type": { "$ref": "#/$defs/ClassificationRef" } } } ] }, "CompoundDate": { "required": [ "year" ], "type": "object", "properties": { "year": { "maximum": 4000, "minimum": 0, "type": "integer", "format": "int32" }, "month": { "maximum": 12, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "day": { "maximum": 31, "minimum": 1, "type": "integer", "format": "int32", "nullable": true } }, "description": "A date that can be defined by only year, year and month or a full date", "nullable": true }, "ConceptRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a concept", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ConferenceSeriesRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a conference series", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ContentRef": { "required": [ "systemName", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referred content", "format": "uuid" }, "systemName": { "type": "string" } }, "nullable": true, "discriminator": { "propertyName": "systemName", "mapping": { "AccessDefinition": "#/components/schemas/AccessDefinitionRef", "Activity": "#/components/schemas/ActivityRef", "Application": "#/components/schemas/ApplicationRef", "AuthorCollaboration": "#/components/schemas/AuthorCollaborationRef", "Award": "#/components/schemas/AwardRef", "ClassificationScheme": "#/components/schemas/ClassificationSchemeRef", "ConferenceSeries": "#/components/schemas/ConferenceSeriesRef", "DataSet": "#/components/schemas/DataSetRef", "Equipment": "#/components/schemas/EquipmentRef", "Event": "#/components/schemas/EventRef", "ExternalOrganization": "#/components/schemas/ExternalOrganizationRef", "ExternalPerson": "#/components/schemas/ExternalPersonRef", "Impact": "#/components/schemas/ImpactRef", "Journal": "#/components/schemas/JournalRef", "Organization": "#/components/schemas/OrganizationRef", "Person": "#/components/schemas/PersonRef", "Publisher": "#/components/schemas/PublisherRef", "PressMedia": "#/components/schemas/PressMediaRef", "Prize": "#/components/schemas/PrizeRef", "Project": "#/components/schemas/ProjectRef", "ResearchOutput": "#/components/schemas/ResearchOutputRef", "StudentThesis": "#/components/schemas/StudentThesisRef", "FundingOpportunity": "#/components/schemas/FundingOpportunityRef", "EthicalReview": "#/components/schemas/EthicalReviewRef", "ApplicationCluster": "#/components/schemas/ApplicationClusterRef", "AwardCluster": "#/components/schemas/AwardClusterRef", "User": "#/components/schemas/UserRef", "ERA2018FieldOfResearch": "#/components/schemas/Anzsrc2008FieldOfResearchRef", "UnitOfAssessmentREF2014": "#/components/schemas/Ref2014UnitOfAssessmentRef", "UnitOfAssessmentREF2020": "#/components/schemas/Ref2020UnitOfAssessmentRef", "ANZSRCTypeOfActivity": "#/components/schemas/Anzsrc2020TypeOfActivityRef", "ANZSRCFieldOfResearch": "#/components/schemas/Anzsrc2020FieldOfResearchRef", "ANZSRCSocioEconomicObjective": "#/components/schemas/Anzsrc2020SocioEconomicObjectiveRef", "Semester": "#/components/schemas/SemesterRef", "Education": "#/components/schemas/EducationRef", "Course": "#/components/schemas/CourseRef", "CurriculumVitae": "#/components/schemas/CurriculumVitaeRef", "CustomDefinedFieldConfiguration": "#/components/schemas/CustomDefinedFieldConfigurationRef", "KeywordGroupConfiguration": "#/components/schemas/KeywordGroupConfigurationRef", "Review": "#/components/schemas/ReviewRef", "GenericContentRef": "#/components/schemas/GenericContentRef", "UserProfile": "#/components/schemas/UserProfileRef", "Thesaurus": "#/components/schemas/ThesaurusRef", "Concept": "#/components/schemas/ConceptRef" } } }, "ContributionToBookAnthology": { "required": [ "category", "contributors", "hostPublicationTitle", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "Books, reports and anthologies/collected works where the author(s) are only responsible for part of the work, e.g. a chapter.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "placeOfPublication": { "type": "string", "description": "The place of publication.", "nullable": true }, "edition": { "type": "string", "description": "The edition that the production was published in.", "nullable": true }, "printISBNs": { "type": "array", "description": "The ISBN number for the printed versions of the production.", "nullable": true, "items": { "type": "string" } }, "electronicISBNs": { "type": "array", "description": "The ISBN number for the electronic versions of the production.", "nullable": true, "items": { "type": "string" } }, "publisher": { "$ref": "#/$defs/PublisherRef" }, "event": { "$ref": "#/$defs/EventRef" }, "publicationSeries": { "type": "array", "description": "The publication series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/PublicationSeries" } }, "pages": { "type": "string", "description": "The pages of the host publication covered by this contribution, for example 10-15.", "nullable": true }, "volume": { "type": "string", "description": "The volume that the research output was published in.", "nullable": true }, "hostPublicationEditors": { "type": "array", "description": "A list of host publication editors.", "nullable": true, "items": { "$ref": "#/$defs/Name" } }, "hostPublicationTitle": { "$ref": "#/$defs/FormattedString" }, "hostPublicationSubTitle": { "$ref": "#/$defs/FormattedString" }, "translatedHostPublicationTitle": { "$ref": "#/$defs/FormattedLocalizedString" }, "translatedHostPublicationSubtitle": { "$ref": "#/$defs/FormattedLocalizedString" }, "articleNumber": { "type": "string", "description": "The article number.", "nullable": true }, "caseNotes": { "type": "array", "description": "A collection of court case notes related to this research output.", "nullable": true, "items": { "$ref": "#/$defs/CaseNote" } }, "commissioningBody": { "$ref": "#/$defs/ExternalOrganizationRef" }, "bookSeries": { "type": "array", "description": "The book series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/BookSeriesJournalAssociation" } }, "chapter": { "type": "string", "description": "The chapter of the host publication covered by this contribution, for example 2.", "nullable": true }, "conferenceSeries": { "$ref": "#/$defs/ConferenceSeriesRef" }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true } } } ] }, "ContributionToConference": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "Article, abstract or poster, published in continuation of a conference.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "pages": { "type": "string", "description": "The pages of the host publication covered by this contribution, for example 10-15.", "nullable": true }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true }, "event": { "$ref": "#/$defs/EventRef" } } } ] }, "ContributionToJournal": { "required": [ "category", "contributors", "journalAssociation", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "A journal is published in a consecutive number of volumes/issues, as a series with the same journal title.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "event": { "$ref": "#/$defs/EventRef" }, "pages": { "type": "string", "description": "The pages of the host publication covered by this contribution, for example 10-15.", "nullable": true }, "volume": { "type": "string", "description": "The volume that the research output was published in.", "nullable": true }, "journalAssociation": { "$ref": "#/$defs/JournalAssociation" }, "articleNumber": { "type": "string", "description": "The article number.", "nullable": true }, "journalNumber": { "type": "string", "description": "The issue number of the journal the research output is published in.", "nullable": true }, "caseNotes": { "type": "array", "description": "A collection of court case notes related to this research output.", "nullable": true, "items": { "$ref": "#/$defs/CaseNote" } }, "conferenceSeries": { "$ref": "#/$defs/ConferenceSeriesRef" }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true } } } ] }, "ContributionToMemorandum": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "A contribution to memorandum or exposition.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "applicant": { "$ref": "#/$defs/ExternalOrganizationRef" }, "projectNumber": { "type": "string", "description": "The project number.", "nullable": true }, "journalNumber": { "type": "string", "description": "The journal number.", "nullable": true }, "dateFinished": { "type": "string", "description": "The date finished.", "format": "date", "nullable": true }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true }, "publicationSeries": { "type": "array", "description": "The publication series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/PublicationSeries" } }, "bookSeries": { "type": "array", "description": "The book series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/BookSeriesJournalAssociation" } } } } ] }, "ContributionToPeriodical": { "required": [ "category", "contributors", "journalAssociation", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "A research output that has been published in a domain-specific journal with a more communicative approach.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "publisher": { "$ref": "#/$defs/PublisherRef" }, "volume": { "type": "string", "description": "The volume that the research output was published in.", "nullable": true }, "journalAssociation": { "$ref": "#/$defs/JournalAssociation" }, "number": { "type": "string", "description": "The number of periodical.", "nullable": true }, "pages": { "type": "string", "description": "The pages of the host publication covered by this contribution, for example 10-15.", "nullable": true }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true } } } ] }, "CourseRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a course", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "CurrencyAmount": { "required": [ "currency", "value" ], "type": "object", "properties": { "currency": { "type": "string", "description": "An ISO-4217 3-letter alphabetic code as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-currency" }, "value": { "type": "string", "description": "A valid decimal monetary value as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-value", "format": "^-?[0-9]+(\\.[0-9]+)?$" } }, "description": "A monetary value in the specified currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/#paymentcurrencyamount-dictionary" }, "CurriculumVitaeRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a curriculum vitae", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "CustomDefinedField": { "required": [ "typeDiscriminator" ], "type": "object", "properties": { "typeDiscriminator": { "type": "string" } }, "description": "Map of CustomDefinedField values, where the key is the field identifier", "nullable": true, "example": "{ \"fieldName1\": \"typeDiscriminator\": \"Integer\", \"value\" : 1}", "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "Integer": "#/components/schemas/CustomDefinedFieldInteger", "String": "#/components/schemas/CustomDefinedFieldString", "Date": "#/components/schemas/CustomDefinedFieldDate", "Classification": "#/components/schemas/CustomDefinedFieldClassification", "Boolean": "#/components/schemas/CustomDefinedFieldBoolean", "Decimal": "#/components/schemas/CustomDefinedFieldDecimal" } } }, "CustomDefinedFieldBoolean": { "type": "object", "nullable": true, "allOf": [ { "$ref": "#/$defs/CustomDefinedField" }, { "type": "object", "properties": { "value": { "type": "boolean", "description": "The boolean value for the custom field", "nullable": true } } } ] }, "CustomDefinedFieldClassification": { "type": "object", "nullable": true, "allOf": [ { "$ref": "#/$defs/CustomDefinedField" }, { "type": "object", "properties": { "value": { "$ref": "#/$defs/ClassificationRef" } } } ] }, "CustomDefinedFieldConfigurationRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a custom-defined field configuration", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "CustomDefinedFieldDate": { "type": "object", "nullable": true, "allOf": [ { "$ref": "#/$defs/CustomDefinedField" }, { "type": "object", "properties": { "value": { "type": "string", "description": "The date value for the custom field", "format": "date", "nullable": true } } } ] }, "CustomDefinedFieldDecimal": { "type": "object", "nullable": true, "allOf": [ { "$ref": "#/$defs/CustomDefinedField" }, { "type": "object", "properties": { "value": { "type": "number", "description": "The decimal value for the custom field", "nullable": true } } } ] }, "CustomDefinedFieldInteger": { "type": "object", "nullable": true, "allOf": [ { "$ref": "#/$defs/CustomDefinedField" }, { "type": "object", "properties": { "value": { "type": "integer", "description": "The integer value for the custom field", "format": "int32", "nullable": true } } } ] }, "CustomDefinedFieldString": { "type": "object", "nullable": true, "allOf": [ { "$ref": "#/$defs/CustomDefinedField" }, { "type": "object", "properties": { "value": { "type": "string", "description": "The string value for the custom field", "nullable": true } } } ] }, "CustomDefinedFields": { "type": "object", "additionalProperties": { "$ref": "#/$defs/CustomDefinedField" }, "description": "Map of CustomDefinedField values, where the key is the field identifier", "nullable": true, "example": "{ \"fieldName1\": \"typeDiscriminator\": \"Integer\", \"value\" : 1}" }, "DataSetRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a data set", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "DateRange": { "type": "object", "properties": { "startDate": { "type": "string", "description": "Start date", "format": "date", "nullable": true }, "endDate": { "type": "string", "description": "End date", "format": "date", "nullable": true } }, "description": "A date range" }, "DoiElectronicVersion": { "required": [ "doi" ], "type": "object", "description": "DOI electronic version related to a research output.", "allOf": [ { "$ref": "#/$defs/ElectronicVersion" }, { "type": "object", "properties": { "doi": { "type": "string", "description": "The DOI of the electronic version (without proxy such as 10.1000/182)." }, "versionType": { "$ref": "#/$defs/ClassificationRef" } } } ] }, "EducationRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to Education", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ElectronicVersion": { "required": [ "typeDiscriminator" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "accessType": { "$ref": "#/$defs/ClassificationRef" }, "embargoPeriod": { "$ref": "#/$defs/DateRange" }, "licenseType": { "$ref": "#/$defs/ClassificationRef" }, "userDefinedLicense": { "type": "string", "description": "License defined by the user.", "nullable": true }, "visibleOnPortalDate": { "type": "string", "description": "Date where this document is/will be visible on the portal.", "format": "date", "readOnly": true }, "creator": { "type": "string", "description": "Username of creator", "readOnly": true }, "created": { "type": "string", "description": "Date and time of creation", "format": "date-time", "readOnly": true }, "typeDiscriminator": { "type": "string" } }, "description": "Electronic version related to a research output.", "nullable": true, "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "DoiElectronicVersion": "#/components/schemas/DoiElectronicVersion", "FileElectronicVersion": "#/components/schemas/FileElectronicVersion", "LinkElectronicVersion": "#/components/schemas/LinkElectronicVersion" } } }, "ElectronicVersionFile": { "required": [ "fileName", "mimeType" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "fileId": { "type": "string", "description": "The id of the file", "readOnly": true }, "fileName": { "type": "string", "description": "The documents file name" }, "mimeType": { "type": "string", "description": "The documents mime type" }, "size": { "type": "integer", "description": "The documents size in bytes", "format": "int64" }, "url": { "type": "string", "description": "Download url for the binary file", "readOnly": true }, "fileStoreLocations": { "type": "object", "additionalProperties": { "type": "string", "description": "Locations of the binary file in file stores.", "readOnly": true }, "description": "Locations of the binary file in file stores.", "readOnly": true }, "uploadedFile": { "$ref": "#/$defs/UploadedFile" }, "remoteFile": { "$ref": "#/$defs/RemoteFile" }, "fileData": { "type": "string", "description": "Base64 encoded file data for new files. This property can be used instead of uploadedFile for small files", "format": "byte", "writeOnly": true } }, "description": "Information about an electronic version file" }, "EquipmentRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a piece of equipment", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "EthicalReviewRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an ethical review", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "EventRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an event", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ExternalContributorAssociation": { "required": [ "externalPerson", "name", "role" ], "type": "object", "description": "An external contributor associated with the content.", "allOf": [ { "$ref": "#/$defs/AbstractContributorAssociation" }, { "type": "object", "properties": { "hidden": { "type": "boolean", "description": "If this contribution should be hidden, this is set to true, false otherwise. This is used for research output that have author collaborations. If they do, we hide the individual contributors." }, "contributionDescription": { "type": "string", "description": "A string that details the contribution of the associated person.", "nullable": true }, "contributionPercentage": { "type": "number", "description": "A real number between 0 and 1, describing the percentage of the contribution of the person.", "format": "double", "nullable": true }, "country": { "$ref": "#/$defs/ClassificationRef" }, "correspondingAuthor": { "type": "boolean", "description": "True if the contributor is the corresponding author, false otherwise." }, "name": { "$ref": "#/$defs/Name" }, "role": { "$ref": "#/$defs/ClassificationRef" }, "externalPerson": { "$ref": "#/$defs/ExternalPersonRef" } } } ] }, "ExternalOrganizationRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an organization external to the institution", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ExternalPersonRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a person external to the institution", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "FileElectronicVersion": { "type": "object", "description": "File electronic version related to a research output.", "allOf": [ { "$ref": "#/$defs/ElectronicVersion" }, { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the file.", "nullable": true }, "rightsStatement": { "type": "string", "description": "A description of property rights for the file.", "nullable": true }, "file": { "$ref": "#/$defs/ElectronicVersionFile" }, "versionType": { "$ref": "#/$defs/ClassificationRef" }, "legacyAccessDate": { "type": "string", "description": "The legacy access date (Elsevier/REF2020 only).", "format": "date", "nullable": true }, "legacyDepositDate": { "type": "string", "description": "The legacy deposit date (Elsevier/REF2020 only).", "format": "date", "nullable": true } } } ] }, "FormattedLocalizedString": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of localized strings that support formatting. Invalid locale values will be ignored.", "nullable": true, "example": "{\"en_GB\":\"Some text\"}" }, "description": "A set of localized strings that support formatting. Invalid locale values will be ignored.", "nullable": true, "example": { "en_GB": "Some text" } }, "FormattedString": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "The actual formatted string" } }, "description": "A string containing HTML formatted text" }, "FreeKeywordsKeywordGroup": { "required": [ "logicalName" ], "type": "object", "description": "De-normalized version of the full keyword group representation for instances where only free keywords can be selected", "allOf": [ { "$ref": "#/$defs/KeywordGroup" }, { "type": "object", "properties": { "keywords": { "minItems": 1, "type": "array", "description": "Free keywords", "items": { "$ref": "#/$defs/Keyword" } } } } ] }, "FullKeywordGroup": { "required": [ "logicalName" ], "type": "object", "description": "Keywords of a specific type. A type of keyword can be configured to solely support free keywords (represented as the FreeKeywordsKeywordGroup type), to solely support structured keywords (represented as the ClassificationsKeywordGroup type), or to both support structured keywords supplemented by optional free keywords (this type)", "allOf": [ { "$ref": "#/$defs/KeywordGroup" }, { "type": "object", "properties": { "keywordContainers": { "type": "array", "description": "Containers with structured keywords and/or free keywords", "nullable": true, "items": { "$ref": "#/$defs/KeywordContainer" } } } } ] }, "FundingDetails": { "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "fundingOrganizations": { "maxItems": 1, "type": "array", "description": "The internal or external funding organizations", "nullable": true, "items": { "$ref": "#/$defs/OrganizationOrExternalOrganizationRef" } }, "fundingOrganizationAcronym": { "type": "string", "description": "The acronym of the funding organization", "nullable": true }, "fundingNumbers": { "type": "array", "description": "Funding numbers/IDs", "nullable": true, "items": { "type": "string" } } }, "description": "Details about funding." }, "FundingOpportunityRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a funding opportunity", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "GenericContentRef": { "required": [ "uuid" ], "type": "object", "description": "A content reference for content that has no API model (yet)", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ISSNRef": { "required": [ "pureId" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the ISSN. This is found by retrieving the Journal and going through the ISSNs collection.", "format": "int64" }, "issn": { "type": "string", "description": "The actual ISSN value", "readOnly": true } }, "description": "A reference to a journal ISSN" }, "Id": { "required": [ "idSource", "value" ], "type": "object", "description": "An external ID", "allOf": [ { "$ref": "#/$defs/Identifier" }, { "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object", "format": "int64", "readOnly": true }, "idSource": { "type": "string", "description": "Name of the external source" }, "value": { "type": "string", "description": "External ID" } } } ] }, "Identifier": { "required": [ "typeDiscriminator" ], "type": "object", "properties": { "typeDiscriminator": { "type": "string" } }, "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "ClassifiedId": "#/components/schemas/ClassifiedId", "PrimaryId": "#/components/schemas/PrimaryId", "Id": "#/components/schemas/Id" } } }, "ImageFile": { "required": [ "fileName", "mimeType" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "fileId": { "type": "string", "description": "The id of the file", "readOnly": true }, "fileName": { "type": "string", "description": "The documents file name" }, "mimeType": { "type": "string", "description": "The documents mime type" }, "size": { "type": "integer", "description": "The documents size in bytes", "format": "int64" }, "url": { "type": "string", "description": "Download url for the binary file", "readOnly": true }, "fileStoreLocations": { "type": "object", "additionalProperties": { "type": "string", "description": "Locations of the binary file in file stores.", "readOnly": true }, "description": "Locations of the binary file in file stores.", "readOnly": true }, "uploadedFile": { "$ref": "#/$defs/UploadedFile" }, "remoteFile": { "$ref": "#/$defs/RemoteFile" }, "fileData": { "type": "string", "description": "Base64 encoded file data for new files. This property can be used instead of uploadedFile for small files", "format": "byte", "writeOnly": true }, "type": { "$ref": "#/$defs/ClassificationRef" }, "copyrightConfirmation": { "type": "boolean", "description": "Indicates whether this file has been confirmed to adhere to the appropriate copyrights", "nullable": true }, "caption": { "$ref": "#/$defs/LocalizedString" }, "altText": { "$ref": "#/$defs/LocalizedString" }, "copyrightStatement": { "$ref": "#/$defs/LocalizedString" } }, "description": "An image file" }, "ImpactRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to impact", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "InternalContributorAssociation": { "required": [ "name", "person", "role" ], "type": "object", "description": "An internal contributor associated with the content.", "allOf": [ { "$ref": "#/$defs/AbstractContributorAssociation" }, { "type": "object", "properties": { "hidden": { "type": "boolean", "description": "If this contribution should be hidden, this is set to true, false otherwise. This is used for research output that have author collaborations. If they do, we hide the individual contributors." }, "contributionDescription": { "type": "string", "description": "A string that details the contribution of the associated person.", "nullable": true }, "contributionPercentage": { "type": "number", "description": "A real number between 0 and 1, describing the percentage of the contribution of the person.", "format": "double", "nullable": true }, "country": { "$ref": "#/$defs/ClassificationRef" }, "correspondingAuthor": { "type": "boolean", "description": "True if the contributor is the corresponding author, false otherwise." }, "name": { "$ref": "#/$defs/Name" }, "role": { "$ref": "#/$defs/ClassificationRef" }, "person": { "$ref": "#/$defs/PersonRef" }, "organizations": { "type": "array", "description": "A collection of organizational unit affiliations.", "nullable": true, "items": { "$ref": "#/$defs/OrganizationRef" } } } } ] }, "JournalAssociation": { "required": [ "journal" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "title": { "$ref": "#/$defs/JournalTitleRef" }, "issn": { "$ref": "#/$defs/ISSNRef" }, "journal": { "$ref": "#/$defs/JournalRef" } }, "description": "A journal associated with a research output.", "nullable": true }, "JournalRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a Journal", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "JournalTitleRef": { "required": [ "pureId" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the title. This is found by retrieving the Journal and going through the titles collection.", "format": "int64" }, "title": { "type": "string", "description": "The title of the journal.", "readOnly": true } }, "description": "A reference to a journal title" }, "Keyword": { "required": [ "locale" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "locale": { "type": "string", "description": "Locale that user defined keywords are in" }, "freeKeywords": { "type": "array", "description": "User defined keywords in a specific locale", "items": { "type": "string" } } }, "description": "List of free keywords" }, "KeywordContainer": { "required": [ "structuredKeyword" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "structuredKeyword": { "$ref": "#/$defs/ClassificationRef" }, "freeKeywords": { "type": "array", "description": "Free keywords", "nullable": true, "items": { "$ref": "#/$defs/Keyword" } } }, "description": "Container for a structured keyword and/or free keywords" }, "KeywordGroup": { "required": [ "logicalName", "typeDiscriminator" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "logicalName": { "type": "string", "description": "Unique name of the configuration that specifies this keyword group" }, "name": { "$ref": "#/$defs/LocalizedString" }, "typeDiscriminator": { "type": "string" } }, "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "ClassificationsKeywordGroup": "#/components/schemas/ClassificationsKeywordGroup", "FreeKeywordsKeywordGroup": "#/components/schemas/FreeKeywordsKeywordGroup", "FullKeywordGroup": "#/components/schemas/FullKeywordGroup" } } }, "KeywordGroupConfigurationRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a keyword group configuration", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Link": { "required": [ "url" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "url": { "type": "string", "description": "The URL (Uniform Resource Locator) of the link" }, "alias": { "type": "string", "description": "A user-friendly text to show instead of the URL", "nullable": true }, "description": { "$ref": "#/$defs/LocalizedString" }, "linkType": { "$ref": "#/$defs/ClassificationRef" } }, "description": "A hyperlink describing a location on the web." }, "LinkElectronicVersion": { "required": [ "link" ], "type": "object", "description": "Link electronic version related to a research output.", "allOf": [ { "$ref": "#/$defs/ElectronicVersion" }, { "type": "object", "properties": { "link": { "type": "string", "description": "A link to the electronic version." }, "versionType": { "$ref": "#/$defs/ClassificationRef" } } } ] }, "LocalizedString": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string values, one for each submission locale. Note: invalid locale values will be ignored.", "nullable": true, "example": "{\"en_GB\":\"Some text\"}" }, "description": "A set of string values, one for each submission locale. Note: invalid locale values will be ignored.", "nullable": true, "example": { "en_GB": "Some text" } }, "Memorandum": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "A memorandum or exposition.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "applicant": { "$ref": "#/$defs/ExternalOrganizationRef" }, "projectNumber": { "type": "string", "description": "The project number.", "nullable": true }, "journalNumber": { "type": "string", "description": "The journal number.", "nullable": true }, "dateFinished": { "type": "string", "description": "The date finished.", "format": "date", "nullable": true }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true }, "publicationSeries": { "type": "array", "description": "The publication series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/PublicationSeries" } }, "bookSeries": { "type": "array", "description": "The book series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/BookSeriesJournalAssociation" } } } } ] }, "Name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "description": "A name describing a person, made up of given- and family name" }, "NonTextual": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "Research output that is not explicitly text, e.g. content with main focus on audio or images.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "placeOfPublication": { "type": "string", "description": "The place of publication.", "nullable": true }, "edition": { "type": "string", "description": "The edition that the production was published in.", "nullable": true }, "publisher": { "$ref": "#/$defs/PublisherRef" }, "event": { "$ref": "#/$defs/EventRef" }, "outputMedia": { "$ref": "#/$defs/ClassificationRef" }, "size": { "type": "string", "description": "The size of the production.", "nullable": true } } } ] }, "OrganizationOrExternalOrganizationRef": { "type": "object", "properties": { "organizationRef": { "$ref": "#/$defs/OrganizationRef" }, "externalOrganizationRef": { "$ref": "#/$defs/ExternalOrganizationRef" } }, "description": "A reference to an organization in the institution or an external organization", "nullable": true }, "OrganizationRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an organization in the institution", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "OtherContribution": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "Research output that does not fit into the other categories.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "publicationSeries": { "type": "array", "description": "The publication series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/PublicationSeries" } }, "placeOfPublication": { "type": "string", "description": "The place of publication.", "nullable": true }, "edition": { "type": "string", "description": "The edition that the production was published in.", "nullable": true }, "printISBNs": { "type": "array", "description": "The ISBN number for the printed versions of the production.", "nullable": true, "items": { "type": "string" } }, "electronicISBNs": { "type": "array", "description": "The ISBN number for the electronic versions of the production.", "nullable": true, "items": { "type": "string" } }, "publisher": { "$ref": "#/$defs/PublisherRef" }, "volume": { "type": "string", "description": "The volume that the research output was published in.", "nullable": true }, "typeDescription": { "$ref": "#/$defs/LocalizedString" }, "outputMedia": { "type": "string", "nullable": true }, "caseNotes": { "type": "array", "description": "A collection of court case notes related to this research output.", "nullable": true, "items": { "$ref": "#/$defs/CaseNote" } }, "bookSeries": { "type": "array", "description": "The book series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/BookSeriesJournalAssociation" } }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true } } } ] }, "Patent": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "A patent is a document that grants the rights of a piece of work/invention to its originator.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "country": { "$ref": "#/$defs/ClassificationRef" }, "ipcs": { "type": "array", "description": "The International Patent Classifications", "nullable": true, "items": { "type": "string" } }, "patentNumber": { "type": "string", "description": "The patent number.", "nullable": true }, "date": { "type": "string", "description": "The filing date.", "format": "date", "nullable": true }, "priorityDate": { "type": "string", "description": "The priority date.", "format": "date", "nullable": true }, "priorityNumber": { "type": "string", "description": "The priority number.", "nullable": true }, "publisher": { "$ref": "#/$defs/PublisherRef" } } } ] }, "PersonRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a person internal to the institution", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "PressMediaRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a press/media", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "PrimaryId": { "required": [ "idSource", "value" ], "type": "object", "description": "A primary external ID", "allOf": [ { "$ref": "#/$defs/Identifier" }, { "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object", "format": "int64", "readOnly": true }, "idSource": { "type": "string", "description": "Name of the external source" }, "value": { "type": "string", "description": "Primary external ID" } } } ] }, "PrizeRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a prize", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ProjectAwardableAssociation": { "required": [ "project" ], "type": "object", "properties": { "award": { "$ref": "#/$defs/AwardRef" }, "project": { "$ref": "#/$defs/ProjectRef" } }, "description": "A relation to a project, optionally in the context of the Award that made it possible.", "nullable": true }, "ProjectRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to project", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "PublicationSeries": { "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "name": { "$ref": "#/$defs/FormattedString" }, "publisherName": { "type": "string", "description": "The publisher of the publication series.", "nullable": true }, "printIssn": { "type": "string", "description": "The print ISSN of the publication series.", "nullable": true }, "electronicIssn": { "type": "string", "description": "The electronic ISSN of the publication series.", "nullable": true }, "no": { "type": "string", "description": "The number of the publication series.", "nullable": true }, "volume": { "type": "string", "description": "The volume of the publication series.", "nullable": true } }, "description": "A publication series." }, "PublicationStatus": { "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "current": { "type": "boolean", "description": "True when this status element is the current, false otherwise.", "readOnly": true }, "publicationStatus": { "$ref": "#/$defs/ClassificationRef" }, "publicationDate": { "$ref": "#/$defs/CompoundDate" } }, "description": "A representation of a point in time when the status of a publication changed, e.g. the submission date or publication date of the publication." }, "PublisherRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a publisher", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Ref2014UnitOfAssessmentRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a Ref2014UnitOfAssessment", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Ref2020UnitOfAssessmentRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a Ref2020UnitOfAssessment", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "RemoteFile": { "required": [ "fileId", "fileState", "sourceId", "storeName" ], "type": "object", "properties": { "sourceId": { "type": "string", "description": "The remote source ID" }, "storeName": { "type": "string", "description": "The name of the remote store" }, "timeStamp": { "type": "string", "description": "The timestamp at which the file was stored", "format": "date-time" }, "fileId": { "type": "string", "description": "The remote file ID" }, "fileState": { "type": "string", "description": "The remote file state", "enum": [ "AWAITING_CREATION", "CREATION_IN_PROGRESS", "CREATION_FAILED", "STORED", "AWAITING_DELETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED" ] }, "metadataUpdateRequired": { "type": "boolean", "description": "Whether the file's metadata should be updated", "default": false } }, "description": "Information about a remote file (Elsevier only)" }, "ResearchOutputAssociation": { "required": [ "researchOutput" ], "type": "object", "properties": { "researchOutput": { "$ref": "#/$defs/ResearchOutputRef" } }, "description": "An association to a research output.", "nullable": true }, "ResearchOutputRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a research output", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ReviewRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a review", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "SemesterRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to semester", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "StudentThesisRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to student thesis", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "SupervisorAssociation": { "required": [ "role" ], "type": "object", "properties": { "pureId": { "type": "integer", "description": "Pure database ID of the object, prefer using the UUID if it is present on the entity", "format": "int64", "readOnly": true }, "externalOrganizations": { "type": "array", "description": "A collection of external organization affiliations.", "nullable": true, "items": { "$ref": "#/$defs/ExternalOrganizationRef" } }, "name": { "$ref": "#/$defs/Name" }, "person": { "$ref": "#/$defs/PersonRef" }, "externalPerson": { "$ref": "#/$defs/ExternalPersonRef" }, "organizations": { "type": "array", "description": "A collection of organizational affiliations.", "nullable": true, "items": { "$ref": "#/$defs/OrganizationRef" } }, "role": { "$ref": "#/$defs/ClassificationRef" } }, "description": "A supervisor on a research output." }, "SystemCurrencyAmount": { "required": [ "value" ], "type": "object", "properties": { "currency": { "type": "string", "description": "An ISO-4217 3-letter alphabetic code representing the Pure installation's system currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-currency", "readOnly": true }, "value": { "type": "string", "description": "A valid decimal monetary value as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/#dom-paymentcurrencyamount-value", "format": "^-?[0-9]+(\\.[0-9]+)?$" } }, "description": "A monetary value in the Pure installation's system currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/#paymentcurrencyamount-dictionary" }, "SystemLocalizedString": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of localized string values each for a specific UI locale.", "nullable": true, "example": "{\"en_GB\":\"Some text\"}" }, "description": "A set of localized string values each for a specific UI locale.", "nullable": true, "example": { "en_GB": "Some text" } }, "ThesaurusRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a thesaurus", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Thesis": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "A thesis.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "placeOfPublication": { "type": "string", "description": "The place of publication.", "nullable": true }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true }, "edition": { "type": "string", "description": "The edition that the production was published in.", "nullable": true }, "printISBNs": { "type": "array", "description": "The ISBN number for the printed versions of the production.", "nullable": true, "items": { "type": "string" } }, "electronicISBNs": { "type": "array", "description": "The ISBN number for the electronic versions of the production.", "nullable": true, "items": { "type": "string" } }, "publisher": { "$ref": "#/$defs/PublisherRef" }, "volume": { "type": "string", "description": "The volume that the research output was published in.", "nullable": true }, "publicationSeries": { "type": "array", "description": "The publication series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/PublicationSeries" } }, "bookSeries": { "type": "array", "description": "The book series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/BookSeriesJournalAssociation" } }, "qualification": { "$ref": "#/$defs/ClassificationRef" }, "awardingInstitutions": { "type": "array", "description": "The awarding institution.", "nullable": true, "items": { "$ref": "#/$defs/OrganizationOrExternalOrganizationRef" } }, "supervisorOrganizations": { "type": "array", "description": "A collection of organizational affiliations associated with supervisors of this research output.", "nullable": true, "items": { "$ref": "#/$defs/OrganizationRef" } }, "supervisorExternalOrganizations": { "type": "array", "description": "A collection of external organization affiliations associated with supervisors of this research output.", "nullable": true, "items": { "$ref": "#/$defs/ExternalOrganizationRef" } }, "supervisors": { "type": "array", "description": "The supervisors of this research output.", "nullable": true, "items": { "$ref": "#/$defs/SupervisorAssociation" } }, "sponsors": { "type": "array", "description": "The sponsors of this research output.", "nullable": true, "items": { "$ref": "#/$defs/ExternalOrganizationRef" } }, "awardDate": { "type": "string", "format": "date" } } } ] }, "UploadedFile": { "required": [ "key" ], "type": "object", "properties": { "digest": { "type": "string", "description": "The calculated digest for the file in Pure", "readOnly": true }, "digestType": { "type": "string", "description": "The digest type", "readOnly": true }, "size": { "type": "integer", "description": "The file size of the file in Pure", "format": "int64", "readOnly": true }, "mimeType": { "type": "string", "description": "The mime type detected for the file", "readOnly": true }, "timeStamp": { "type": "string", "description": "The timestamp Pure received the file", "format": "date-time", "readOnly": true }, "expires": { "type": "string", "description": "The timestamp where Pure deletes the uploaded file if it has not been attached to any content", "format": "date-time", "readOnly": true }, "key": { "type": "string", "description": "Pure key identifer for the file upload", "readOnly": true } }, "description": "Information about the uploaded file" }, "UserProfileRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a user profile", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "UserRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an user", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Visibility": { "required": [ "key" ], "type": "object", "properties": { "key": { "type": "string", "description": "Visibility value", "enum": [ "FREE", "CAMPUS", "BACKEND", "CONFIDENTIAL" ] }, "description": { "$ref": "#/$defs/SystemLocalizedString" } }, "description": "Visibility of an object" }, "Workflow": { "required": [ "step" ], "type": "object", "properties": { "step": { "type": "string", "description": "Current workflow step" }, "description": { "$ref": "#/$defs/SystemLocalizedString" } }, "description": "Information about workflow" }, "WorkingPaper": { "required": [ "category", "contributors", "language", "managingOrganization", "publicationStatuses", "title", "type" ], "type": "object", "description": "A working paper is a document that constitutes an early version of a publication. Working papers are primarily used for exchanging ideas or to get feedback, before submitting it to a publisher. Working papers are usually published by the authors own institution.", "allOf": [ { "$ref": "#/$defs/ResearchOutput" }, { "type": "object", "properties": { "volume": { "type": "string", "description": "The volume that the research output was published in.", "nullable": true }, "numberOfPages": { "type": "integer", "description": "The number of pages in the research output.", "format": "int32", "nullable": true }, "pages": { "type": "string", "description": "The pages of the host publication covered by this contribution, for example 10-15.", "nullable": true }, "publicationSeries": { "type": "array", "description": "The publication series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/PublicationSeries" } }, "placeOfPublication": { "type": "string", "description": "The place of publication.", "nullable": true }, "edition": { "type": "string", "description": "The edition that the production was published in.", "nullable": true }, "printISBNs": { "type": "array", "description": "The ISBN number for the printed versions of the production.", "nullable": true, "items": { "type": "string" } }, "electronicISBNs": { "type": "array", "description": "The ISBN number for the electronic versions of the production.", "nullable": true, "items": { "type": "string" } }, "publisher": { "$ref": "#/$defs/PublisherRef" }, "bookSeries": { "type": "array", "description": "The book series this research output is part of.", "nullable": true, "items": { "$ref": "#/$defs/BookSeriesJournalAssociation" } } } } ] } } }