University of Bath · Schema
University of Bath Pure API Person
An academic professional, student, or other individual attached to the institution.
EducationHigher EducationUniversityUnited KingdomResearchOpen DataLibraryMetadata
Properties
| Name | Type | Description |
|---|---|---|
| pureId | integer | Pure database ID of the object, prefer using the UUID if it is present on the entity |
| uuid | string | UUID, this is the primary identity of the entity |
| createdBy | string | Username of creator |
| createdDate | string | Date and time of creation |
| modifiedBy | string | Username of the user that performed a modification |
| modifiedDate | string | Date and time of last modification |
| portalUrl | string | URL of the content on the Pure Portal |
| prettyUrlIdentifiers | array | All pretty URLs |
| previousUuids | array | UUIDs of other content items which have been merged into this content item (or similar) |
| version | string | 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 th |
| startDateAsResearcher | string | Date that the person entered into the academic profession. |
| affiliationNote | string | Notes regarding affiliations of the person. |
| dateOfBirth | string | The person's date of birth. |
| employeeStartDate | string | Date of the persons first day of the institution. |
| employeeEndDate | string | Date of the persons last day of the institution. |
| externalPositions | array | positions held by the person, that are external to the institution |
| keywordGroups | array | Groups of Keyword associated with the person. |
| leavesOfAbsence | array | Leaves of absence had by the person. |
| links | array | Links associated with the person. |
| name | object | |
| names | array | Variant names of the person, Known aliases, ect. |
| nationality | object | |
| orcid | string | orcid of the person. |
| orcidAuthenticated | boolean | Authentication status of the orcid associated with the person. |
| cienciaId | string | Ciencia ID of the person. |
| cienciaIdAuthenticated | boolean | Authentication status of the Ciencia ID associated with the person. |
| honoraryStaffOrganizationAssociations | array | Organizations that the person is associated with under the title of 'Honorary Staff' |
| staffOrganizationAssociations | array | Organizations that the person is associated with as 'Staff' |
| studentOrganizationAssociations | array | Organizations that the person is associated with as a 'Student' |
| visitingScholarOrganizationAssociations | array | Organizations that the person is associated with as a 'Visiting Scholar |
| academicQualifications | array | Levels of academic qualifications that the person has achieved. |
| profilePhotos | array | Profile photos in the form of Image files. The maximum file size is 1mb |
| documents | array | Associated documents for the person |
| privateAddress | object | |
| professionalQualifications | array | The professional qualifications held by the person |
| selectedForProfileRefinementService | boolean | If the person has been profiled. |
| profileInformation | array | Information objects making up profiles made of the person |
| retirementDate | string | Date of retirement for the person |
| gender | object | |
| titles | array | Titles held by the person |
| visibility | object | |
| willingToTakePhdStudents | boolean | Boolean to define if the Person is willing to take on Phd Students. |
| willingToTakePhdStudentsDescription | string | Field to describe or list phd projects that the person will participate in. |
| identifiers | array | Identifiers related to the person |
| user | object | |
| customDefinedFields | object | |
| workflow | object | |
| mainResearchArea | object | |
| systemName | string | The content system name |
JSON Schema
{
"$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-person-schema.json",
"title": "University of Bath Pure API Person",
"description": "An academic professional, student, or other individual attached to the institution.",
"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
},
"startDateAsResearcher": {
"type": "string",
"description": "Date that the person entered into the academic profession.",
"format": "date",
"nullable": true
},
"affiliationNote": {
"type": "string",
"description": "Notes regarding affiliations of the person.",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"description": "The person's date of birth.",
"format": "date",
"nullable": true
},
"employeeStartDate": {
"type": "string",
"description": "Date of the persons first day of the institution.",
"format": "date",
"nullable": true
},
"employeeEndDate": {
"type": "string",
"description": "Date of the persons last day of the institution.",
"format": "date",
"nullable": true
},
"externalPositions": {
"type": "array",
"description": "positions held by the person, that are external to the institution",
"nullable": true,
"items": {
"$ref": "#/$defs/ExternalAppointment"
}
},
"keywordGroups": {
"type": "array",
"description": "Groups of Keyword associated with the person.",
"nullable": true,
"items": {
"$ref": "#/$defs/KeywordGroup"
}
},
"leavesOfAbsence": {
"type": "array",
"description": "Leaves of absence had by the person.",
"nullable": true,
"items": {
"$ref": "#/$defs/PersonClassifiedLeaveOfAbsence"
}
},
"links": {
"type": "array",
"description": "Links associated with the person.",
"nullable": true,
"items": {
"$ref": "#/$defs/Link"
}
},
"name": {
"$ref": "#/$defs/Name"
},
"names": {
"type": "array",
"description": "Variant names of the person, Known aliases, ect.",
"nullable": true,
"items": {
"$ref": "#/$defs/ClassifiedName"
}
},
"nationality": {
"$ref": "#/$defs/ClassificationRef"
},
"orcid": {
"type": "string",
"description": "orcid of the person.",
"nullable": true
},
"orcidAuthenticated": {
"type": "boolean",
"description": "Authentication status of the orcid associated with the person.",
"readOnly": true
},
"cienciaId": {
"type": "string",
"description": "Ciencia ID of the person.",
"nullable": true
},
"cienciaIdAuthenticated": {
"type": "boolean",
"description": "Authentication status of the Ciencia ID associated with the person."
},
"honoraryStaffOrganizationAssociations": {
"type": "array",
"description": "Organizations that the person is associated with under the title of 'Honorary Staff'",
"nullable": true,
"items": {
"$ref": "#/$defs/HonoraryStaffOrganizationAssociation"
}
},
"staffOrganizationAssociations": {
"type": "array",
"description": "Organizations that the person is associated with as 'Staff'",
"nullable": true,
"items": {
"$ref": "#/$defs/StaffOrganizationAssociation"
}
},
"studentOrganizationAssociations": {
"type": "array",
"description": "Organizations that the person is associated with as a 'Student'",
"nullable": true,
"items": {
"$ref": "#/$defs/StudentOrganizationAssociation"
}
},
"visitingScholarOrganizationAssociations": {
"type": "array",
"description": "Organizations that the person is associated with as a 'Visiting Scholar",
"nullable": true,
"items": {
"$ref": "#/$defs/VisitingScholarOrganizationAssociation"
}
},
"academicQualifications": {
"type": "array",
"description": "Levels of academic qualifications that the person has achieved.",
"nullable": true,
"items": {
"$ref": "#/$defs/AcademicQualification"
}
},
"profilePhotos": {
"type": "array",
"description": "Profile photos in the form of Image files. The maximum file size is 1mb",
"nullable": true,
"items": {
"$ref": "#/$defs/ImageFile"
}
},
"documents": {
"type": "array",
"description": "Associated documents for the person",
"nullable": true,
"items": {
"$ref": "#/$defs/Document"
}
},
"privateAddress": {
"$ref": "#/$defs/Address"
},
"professionalQualifications": {
"type": "array",
"description": "The professional qualifications held by the person",
"nullable": true,
"items": {
"$ref": "#/$defs/ProfessionalQualification"
}
},
"selectedForProfileRefinementService": {
"type": "boolean",
"description": "If the person has been profiled."
},
"profileInformation": {
"type": "array",
"description": "Information objects making up profiles made of the person",
"nullable": true,
"items": {
"$ref": "#/$defs/ClassifiedFormattedLocalizedValue"
}
},
"retirementDate": {
"type": "string",
"description": "Date of retirement for the person",
"format": "date",
"nullable": true
},
"gender": {
"$ref": "#/$defs/ClassificationRef"
},
"titles": {
"type": "array",
"description": "Titles held by the person",
"nullable": true,
"items": {
"$ref": "#/$defs/ClassifiedLocalizedValue"
}
},
"visibility": {
"$ref": "#/$defs/Visibility"
},
"willingToTakePhdStudents": {
"type": "boolean",
"description": "Boolean to define if the Person is willing to take on Phd Students."
},
"willingToTakePhdStudentsDescription": {
"type": "string",
"description": "Field to describe or list phd projects that the person will participate in.",
"nullable": true
},
"identifiers": {
"type": "array",
"description": "Identifiers related to the person",
"nullable": true,
"items": {
"$ref": "#/$defs/Identifier"
}
},
"user": {
"$ref": "#/$defs/UserRef"
},
"customDefinedFields": {
"$ref": "#/$defs/CustomDefinedFields"
},
"workflow": {
"$ref": "#/$defs/Workflow"
},
"mainResearchArea": {
"$ref": "#/$defs/ClassificationRef"
},
"systemName": {
"type": "string",
"description": "The content system name",
"readOnly": true
}
},
"$defs": {
"AcademicQualification": {
"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
},
"awardDate": {
"type": "string",
"description": "Date that the education was awarded at.",
"format": "date",
"nullable": true
},
"period": {
"$ref": "#/$defs/CompoundDateRange"
},
"fieldOfStudy": {
"$ref": "#/$defs/ClassificationRef"
},
"fieldOfStudyUnstructured": {
"$ref": "#/$defs/LocalizedString"
},
"organization": {
"$ref": "#/$defs/OrganizationOrExternalOrganizationRef"
},
"projectTitle": {
"$ref": "#/$defs/LocalizedString"
},
"qualification": {
"$ref": "#/$defs/ClassificationRef"
},
"qualificationUnstructured": {
"$ref": "#/$defs/LocalizedString"
},
"distinction": {
"$ref": "#/$defs/ClassificationRef"
},
"supervisor": {
"$ref": "#/$defs/InternalOrExternalSupervisor"
}
},
"description": "An object mapping the data of an education received by a person"
},
"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"
}
]
},
"Address": {
"type": "object",
"properties": {
"road": {
"type": "string",
"description": "Name of road and house number, eg. 'Pennsylvania Avenue' or '123 Main St.'",
"nullable": true
},
"room": {
"type": "string",
"description": "Room number or name if available, eg. '1.23' or 'Office of Creative Services'",
"nullable": true
},
"building": {
"type": "string",
"description": "Building Name if available, eg. 'Couper Administration Building'",
"nullable": true
},
"postalCode": {
"type": "string",
"description": "Postal code",
"nullable": true
},
"city": {
"type": "string",
"description": "City or town, eg. 'Binghamton'",
"nullable": true
},
"country": {
"$ref": "#/$defs/ClassificationRef"
}
},
"description": "A physical address",
"nullable": true
},
"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"
}
]
},
"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"
}
}
}
}
]
},
"ClassifiedAddress": {
"required": [
"addressType"
],
"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
},
"addressType": {
"$ref": "#/$defs/ClassificationRef"
},
"addressLines": {
"type": "string",
"description": "Address for personal residence",
"nullable": true
},
"street": {
"type": "string",
"description": "The name of the street",
"nullable": true
},
"building": {
"type": "string",
"description": "The name of the building",
"nullable": true
},
"postalcode": {
"type": "string",
"description": "The postal code of the city",
"nullable": true
},
"city": {
"type": "string",
"description": "The name of the city",
"nullable": true
},
"country": {
"$ref": "#/$defs/ClassificationRef"
},
"subdivision": {
"$ref": "#/$defs/ClassificationRef"
},
"geoLocation": {
"$ref": "#/$defs/GeoLocation"
}
},
"description": "A physical address"
},
"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"
}
}
}
]
},
"ClassifiedLocalizedValue": {
"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/LocalizedString"
},
"type": {
"$ref": "#/$defs/ClassificationRef"
}
},
"description": "A classified localized value"
},
"ClassifiedName": {
"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/Name"
},
"type": {
"$ref": "#/$defs/ClassificationRef"
}
},
"description": "A classified name"
},
"ClassifiedValue": {
"required": [
"type",
"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
},
"value": {
"type": "string",
"description": "Classified value"
},
"type": {
"$ref": "#/$defs/ClassificationRef"
}
},
"description": "A classified value"
},
"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"
}
]
},
"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"
}
]
},
"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"
},
"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
},
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-bath/refs/heads/main/json-schema/university-of-bath-person-schema.json