{ "$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-activity-schema.json", "title": "University of Bath Pure API Activity", "description": "Activities exist in many variations.", "required": [ "managingOrganization", "period", "persons", "type", "typeDiscriminator", "visibility" ], "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 }, "organizations": { "type": "array", "description": "A collection of organization associations.", "nullable": true, "items": { "$ref": "#/$defs/OrganizationRef" } }, "persons": { "type": "array", "description": "A collection of persons.", "items": { "$ref": "#/$defs/AbstractActivityPersonAssociation" } }, "period": { "$ref": "#/$defs/CompoundDateRange" }, "category": { "$ref": "#/$defs/ClassificationRef" }, "managingOrganization": { "$ref": "#/$defs/OrganizationRef" }, "links": { "type": "array", "description": "Additional links associated with this activity.", "nullable": true, "items": { "$ref": "#/$defs/Link" } }, "type": { "$ref": "#/$defs/ClassificationRef" }, "visibility": { "$ref": "#/$defs/Visibility" }, "workflow": { "$ref": "#/$defs/Workflow" }, "externalOrganizations": { "type": "array", "description": "A collection of external organization affiliations.", "nullable": true, "items": { "$ref": "#/$defs/ExternalOrganizationRef" } }, "identifiers": { "type": "array", "description": "Identifiers related to the activity.", "nullable": true, "items": { "$ref": "#/$defs/Identifier" } }, "keywordGroups": { "type": "array", "description": "Groups of keywords associated with the research output.", "nullable": true, "items": { "$ref": "#/$defs/KeywordGroup" } }, "activities": { "type": "array", "description": "A collection of related activities.", "nullable": true, "items": { "$ref": "#/$defs/ActivityRef" } }, "pressMedia": { "type": "array", "description": "A collection of related press media.", "nullable": true, "items": { "$ref": "#/$defs/PressMediaRef" } }, "studentTheses": { "type": "array", "description": "A collection of related student theses.", "nullable": true, "items": { "$ref": "#/$defs/StudentThesisRef" } }, "researchOutputs": { "type": "array", "description": "A collection of related research outputs.", "nullable": true, "items": { "$ref": "#/$defs/ResearchOutputRef" } }, "impacts": { "type": "array", "description": "A collection of related impacts.", "nullable": true, "items": { "$ref": "#/$defs/ImpactRef" } }, "equipment": { "type": "array", "description": "A collection of equipment.", "nullable": true, "items": { "$ref": "#/$defs/EquipmentRef" } }, "degreeOfRecognition": { "$ref": "#/$defs/ClassificationRef" }, "documents": { "type": "array", "description": "Associated documents for the activity.", "nullable": true, "items": { "$ref": "#/$defs/Document" } }, "descriptions": { "type": "array", "description": "A collection of descriptions.", "nullable": true, "items": { "$ref": "#/$defs/ClassifiedFormattedLocalizedValue" } }, "images": { "type": "array", "description": "Image files with a maximum file size of 1MB.", "nullable": true, "items": { "$ref": "#/$defs/ImageFile" } }, "customDefinedFields": { "$ref": "#/$defs/CustomDefinedFields" }, "indicators": { "type": "array", "description": "Indicators for the activity.", "nullable": true, "items": { "$ref": "#/$defs/ClassificationRef" } }, "systemName": { "type": "string", "description": "The content system name", "readOnly": true }, "typeDiscriminator": { "type": "string" } }, "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "Attendance": "#/components/schemas/Attendance", "Consultancy": "#/components/schemas/Consultancy", "EditorialWork": "#/components/schemas/EditorialWork", "Examination": "#/components/schemas/Examination", "HostVisitor": "#/components/schemas/HostVisitor", "Membership": "#/components/schemas/Membership", "OtherActivity": "#/components/schemas/OtherActivity", "Talk": "#/components/schemas/Talk", "VisitOther": "#/components/schemas/VisitOther" } }, "$defs": { "AbstractActivityPersonAssociation": { "required": [ "role", "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" } }, "name": { "$ref": "#/$defs/Name" }, "role": { "$ref": "#/$defs/ClassificationRef" }, "typeDiscriminator": { "type": "string" } }, "description": "An association between an activity and a person, which can either be internal or external", "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "InternalActivityPersonAssociation": "#/components/schemas/InternalActivityPersonAssociation", "ExternalActivityPersonAssociation": "#/components/schemas/ExternalActivityPersonAssociation" } } }, "AbstractEditorialWorkAssociation": { "required": [ "typeDiscriminator" ], "type": "object", "properties": { "typeDiscriminator": { "type": "string" } }, "description": "Association to one and only one of: event, publisher or journal.", "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "EventEditorialWorkAssociation": "#/components/schemas/EventMembershipAssociation", "PublisherEditorialWorkAssociation": "#/components/schemas/PublisherEditorialWorkAssociation", "JournalEditorialWorkAssociation": "#/components/schemas/JournalEditorialWorkAssociation" } } }, "AbstractExamineeAssociation": { "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 }, "typeDiscriminator": { "type": "string" } }, "description": "An association between examination and an examinee, which can either be internal or external", "nullable": true, "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "InternalExamineeAssociation": "#/components/schemas/InternalExamineeAssociation", "ExternalExamineeAssociation": "#/components/schemas/ExternalExamineeAssociation" } } }, "AccessDefinitionRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an access definition", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ActivityAbstractAssociation": { "required": [ "typeDiscriminator" ], "type": "object", "properties": { "typeDiscriminator": { "type": "string" } }, "description": "Association to one and only one of: event, organization or external organization.", "discriminator": { "propertyName": "typeDiscriminator", "mapping": { "ActivityEventAssociation": "#/components/schemas/ActivityEventAssociation", "ActivityOrganizationAssociation": "#/components/schemas/ActivityOrganizationAssociation", "ActivityExternalOrganizationAssociation": "#/components/schemas/ActivityExternalOrganizationAssociation" } } }, "ActivityEventAssociation": { "required": [ "event" ], "type": "object", "description": "An association with an event.", "allOf": [ { "$ref": "#/$defs/ActivityAbstractAssociation" }, { "type": "object", "properties": { "event": { "$ref": "#/$defs/EventRef" } } } ] }, "ActivityExternalOrganizationAssociation": { "required": [ "externalOrganization" ], "type": "object", "description": "An association with an external organization.", "allOf": [ { "$ref": "#/$defs/ActivityAbstractAssociation" }, { "type": "object", "properties": { "externalOrganization": { "$ref": "#/$defs/ExternalOrganizationRef" } } } ] }, "ActivityOrganizationAssociation": { "required": [ "organization" ], "type": "object", "description": "An association with an organization.", "allOf": [ { "$ref": "#/$defs/ActivityAbstractAssociation" }, { "type": "object", "properties": { "organization": { "$ref": "#/$defs/OrganizationRef" } } } ] }, "ActivityRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an activity", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "ActivityVisitorAssociation": { "required": [ "externalPerson" ], "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 organizations.", "nullable": true, "items": { "$ref": "#/$defs/ExternalOrganizationRef" } }, "externalPerson": { "$ref": "#/$defs/ExternalPersonRef" }, "visitorDegree": { "type": "string", "description": "Visitor degree.", "nullable": true }, "country": { "$ref": "#/$defs/ClassificationRef" } }, "description": "An association between activity and a person that has attended it" }, "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" } ] }, "Attendance": { "required": [ "managingOrganization", "period", "persons", "type", "visibility" ], "type": "object", "description": "Participating in or organizing an event", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "event": { "$ref": "#/$defs/EventRef" } } } ] }, "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" } ] }, "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" } } } } ] }, "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 }, "CompoundDateRange": { "type": "object", "properties": { "startDate": { "$ref": "#/$defs/CompoundDate" }, "endDate": { "$ref": "#/$defs/CompoundDate" } }, "description": "A date range of that can be defined by only year, year and month or a full date" }, "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" } ] }, "Consultancy": { "required": [ "consultancyFor", "managingOrganization", "period", "persons", "title", "type", "visibility" ], "type": "object", "description": "Consultancy", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "title": { "$ref": "#/$defs/FormattedLocalizedString" }, "consultancyFor": { "$ref": "#/$defs/ActivityAbstractAssociation" } } } ] }, "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" } } }, "CourseRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a course", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "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" } ] }, "Document": { "required": [ "fileName", "mimeType", "type", "visibility" ], "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 }, "title": { "type": "string", "description": "Document title", "nullable": true }, "type": { "$ref": "#/$defs/ClassificationRef" }, "license": { "$ref": "#/$defs/ClassificationRef" }, "visibleOnPortalDate": { "type": "string", "description": "The date the document will be available on the portal", "format": "date", "readOnly": true }, "visibility": { "$ref": "#/$defs/Visibility" }, "creator": { "type": "string", "description": "The user that created the document", "readOnly": true }, "created": { "type": "string", "description": "Create date for the document", "format": "date-time", "readOnly": true } }, "description": "Document" }, "EditorialWork": { "required": [ "editorialWork", "managingOrganization", "period", "persons", "type", "visibility" ], "type": "object", "description": "Publication peer-review and editorial work", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "editorialWork": { "$ref": "#/$defs/AbstractEditorialWorkAssociation" } } } ] }, "EducationRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to Education", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "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" } ] }, "EventMembershipAssociation": { "required": [ "event" ], "type": "object", "description": "An editorial work association with an event.", "allOf": [ { "$ref": "#/$defs/AbstractEditorialWorkAssociation" }, { "type": "object", "properties": { "event": { "$ref": "#/$defs/EventRef" } } } ] }, "EventRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to an event", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "Examination": { "required": [ "managingOrganization", "period", "persons", "title", "type", "visibility" ], "type": "object", "description": "Examination", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "title": { "$ref": "#/$defs/FormattedLocalizedString" }, "examinationsAtOrganizations": { "type": "array", "description": "The examination at organizations.", "nullable": true, "items": { "$ref": "#/$defs/OrganizationOrExternalOrganizationRef" } }, "examinees": { "type": "array", "description": "List of examinees.", "nullable": true, "items": { "$ref": "#/$defs/AbstractExamineeAssociation" } } } } ] }, "ExternalActivityPersonAssociation": { "required": [ "role" ], "type": "object", "description": "An association between an external person and the activity", "allOf": [ { "$ref": "#/$defs/AbstractActivityPersonAssociation" }, { "type": "object", "properties": { "externalPerson": { "$ref": "#/$defs/ExternalPersonRef" } } } ] }, "ExternalExamineeAssociation": { "required": [ "externalPerson" ], "type": "object", "description": "An external examinee association.", "allOf": [ { "$ref": "#/$defs/AbstractExamineeAssociation" }, { "type": "object", "properties": { "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" } ] }, "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" } }, "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" } } } } ] }, "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" } ] }, "HostVisitor": { "required": [ "managingOrganization", "period", "type", "visibility" ], "type": "object", "description": "Hosting a visitor", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "persons": { "type": "array", "description": "A collection of persons.", "nullable": true, "items": { "$ref": "#/$defs/AbstractActivityPersonAssociation" } }, "event": { "$ref": "#/$defs/EventRef" }, "visitors": { "maxItems": 1, "minItems": 1, "type": "array", "description": "A collection of visitors.", "nullable": true, "items": { "$ref": "#/$defs/ActivityVisitorAssociation" } } } } ] }, "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" } ] }, "InternalActivityPersonAssociation": { "required": [ "role" ], "type": "object", "description": "An association between an internal person and the activity", "allOf": [ { "$ref": "#/$defs/AbstractActivityPersonAssociation" }, { "type": "object", "properties": { "person": { "$ref": "#/$defs/PersonRef" }, "organizations": { "type": "array", "description": "A collection of organizational unit affiliations.", "nullable": true, "items": { "$ref": "#/$defs/OrganizationRef" } } } } ] }, "InternalExamineeAssociation": { "required": [ "person" ], "type": "object", "description": "An internal examinee association.", "allOf": [ { "$ref": "#/$defs/AbstractExamineeAssociation" }, { "type": "object", "properties": { "person": { "$ref": "#/$defs/PersonRef" } } } ] }, "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 }, "JournalEditorialWorkAssociation": { "required": [ "journal" ], "type": "object", "description": "An editorial work association with a journal.", "allOf": [ { "$ref": "#/$defs/AbstractEditorialWorkAssociation" }, { "type": "object", "properties": { "journal": { "$ref": "#/$defs/JournalAssociation" } } } ] }, "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." }, "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" } }, "Membership": { "required": [ "managingOrganization", "memberOf", "period", "persons", "type", "visibility" ], "type": "object", "description": "Membership", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "memberOf": { "$ref": "#/$defs/ActivityAbstractAssociation" } } } ] }, "Name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "description": "A name describing a person, made up of given- and family name" }, "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" } ] }, "OtherActivity": { "required": [ "managingOrganization", "period", "persons", "title", "type", "visibility" ], "type": "object", "description": "Other activity", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "title": { "$ref": "#/$defs/FormattedLocalizedString" }, "association": { "$ref": "#/$defs/ActivityAbstractAssociation" } } } ] }, "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" } ] }, "ProjectRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to project", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "PublisherEditorialWorkAssociation": { "required": [ "publisher" ], "type": "object", "description": "An editorial work association with a publisher.", "allOf": [ { "$ref": "#/$defs/AbstractEditorialWorkAssociation" }, { "type": "object", "properties": { "publisher": { "$ref": "#/$defs/PublisherRef" } } } ] }, "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)" }, "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" } ] }, "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" } }, "Talk": { "required": [ "managingOrganization", "period", "persons", "talkLocation", "title", "type", "visibility" ], "type": "object", "description": "Talk or presentation", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "title": { "$ref": "#/$defs/FormattedLocalizedString" }, "talkLocation": { "$ref": "#/$defs/ActivityAbstractAssociation" } } } ] }, "ThesaurusRef": { "required": [ "uuid" ], "type": "object", "description": "A reference to a thesaurus", "nullable": true, "allOf": [ { "$ref": "#/$defs/ContentRef" } ] }, "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" }, "VisitOther": { "required": [ "externalOrganizationRef", "managingOrganization", "period", "type", "visibility" ], "type": "object", "description": "Visiting an external institution", "allOf": [ { "$ref": "#/$defs/Activity" }, { "type": "object", "properties": { "persons": { "type": "array", "description": "A collection of persons.", "nullable": true, "items": { "$ref": "#/$defs/AbstractActivityPersonAssociation" } }, "event": { "$ref": "#/$defs/EventRef" }, "externalOrganizationRef": { "$ref": "#/$defs/ExternalOrganizationRef" } } } ] }, "Workflow": { "required": [ "step" ], "type": "object", "properties": { "step": { "type": "string", "description": "Current workflow step" }, "description": { "$ref": "#/$defs/SystemLocalizedString" } }, "description": "Information about workflow" } } }