University of Bath Pure API DataSet

{
  "$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-dataset-schema.json",
  "title": "University of Bath Pure API DataSet",
  "description": "A dataset",
  "required": [
    "managingOrganization",
    "persons",
    "publisher",
    "title",
    "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
    },
    "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/LocalizedString"
    },
    "descriptions": {
      "type": "array",
      "description": "A collection of descriptions.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/ClassifiedLocalizedValue"
      }
    },
    "managingOrganization": {
      "$ref": "#/$defs/OrganizationRef"
    },
    "type": {
      "$ref": "#/$defs/ClassificationRef"
    },
    "natureTypes": {
      "type": "array",
      "description": "Nature of activity types for the project.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/ClassificationRef"
      }
    },
    "publisher": {
      "$ref": "#/$defs/PublisherRef"
    },
    "temporalCoveragePeriod": {
      "$ref": "#/$defs/CompoundDateRange"
    },
    "dataProductionPeriod": {
      "$ref": "#/$defs/CompoundDateRange"
    },
    "identifiers": {
      "type": "array",
      "description": "IDs that this object corresponds to in external systems. Such as a Scopus ID. Used by Pure where it is necessary to identify objects to specific external systems",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/Identifier"
      }
    },
    "geoLocation": {
      "$ref": "#/$defs/DataSetGeoLocation"
    },
    "persons": {
      "type": "array",
      "description": "DEPRECATED - use contributors instead. The persons that the dataset is associated with",
      "deprecated": true,
      "items": {
        "$ref": "#/$defs/AbstractDataSetPersonAssociation"
      }
    },
    "contributors": {
      "type": "array",
      "description": "The contributors that the dataset is associated with",
      "items": {
        "$ref": "#/$defs/AbstractDataSetContributorAssociation"
      }
    },
    "totalNumberOfAuthors": {
      "type": "integer",
      "description": "The total number of authors from author collaborations.",
      "format": "int32",
      "nullable": true
    },
    "doi": {
      "$ref": "#/$defs/DataSetDoi"
    },
    "documents": {
      "type": "array",
      "description": "A collection of documents.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetDocument"
      }
    },
    "physicalData": {
      "type": "array",
      "description": "A collection of physical data.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetPhysicalData"
      }
    },
    "contactPerson": {
      "$ref": "#/$defs/PersonRef"
    },
    "legalConditions": {
      "type": "array",
      "description": "A collection of legal conditions.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetLegalCondition"
      }
    },
    "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"
      }
    },
    "publicationAvailableDate": {
      "$ref": "#/$defs/CompoundDate"
    },
    "openAccess": {
      "$ref": "#/$defs/OpenAccess"
    },
    "openAireCompliant": {
      "type": "boolean",
      "description": "OpenAire Compliancy.",
      "readOnly": true
    },
    "license": {
      "$ref": "#/$defs/ClassificationRef"
    },
    "dataSets": {
      "type": "array",
      "description": "A collection of related datasets.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetAssociation"
      }
    },
    "projects": {
      "type": "array",
      "description": "A collection of related projects.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetProjectAssociation"
      }
    },
    "researchOutputs": {
      "type": "array",
      "description": "A collection of related research outputs.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetResearchOutputAssociation"
      }
    },
    "activities": {
      "type": "array",
      "description": "A collection of related activities.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetActivityAssociation"
      }
    },
    "pressMedia": {
      "type": "array",
      "description": "A collection of related press media.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetPressMediaAssociation"
      }
    },
    "studentTheses": {
      "type": "array",
      "description": "A collection of related student theses.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetStudentThesisAssociation"
      }
    },
    "impacts": {
      "type": "array",
      "description": "A collection of related impacts.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetImpactAssociation"
      }
    },
    "prizes": {
      "type": "array",
      "description": "A collection of related prizes.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetPrizeAssociation"
      }
    },
    "equipment": {
      "type": "array",
      "description": "A collection of related equipment.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/DataSetEquipmentAssociation"
      }
    },
    "links": {
      "type": "array",
      "description": "A collection of links.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/Link"
      }
    },
    "keywordGroups": {
      "type": "array",
      "description": "A group for each type of keyword present.",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/KeywordGroup"
      }
    },
    "visibility": {
      "$ref": "#/$defs/Visibility"
    },
    "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 dataset",
      "nullable": true,
      "items": {
        "$ref": "#/$defs/FundingDetails"
      }
    },
    "customDefinedFields": {
      "$ref": "#/$defs/CustomDefinedFields"
    },
    "workflow": {
      "$ref": "#/$defs/Workflow"
    },
    "systemName": {
      "type": "string",
      "description": "The content system name",
      "readOnly": true
    }
  },
  "$defs": {
    "AbstractDataSetContributorAssociation": {
      "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 dataset and a contributor",
      "discriminator": {
        "propertyName": "typeDiscriminator",
        "mapping": {
          "DataSetInternalContributorAssociation": "#/components/schemas/DataSetInternalContributorAssociation",
          "DataSetExternalContributorAssociation": "#/components/schemas/DataSetExternalContributorAssociation",
          "DataSetAuthorCollaborationContributorAssociation": "#/components/schemas/DataSetAuthorCollaborationContributorAssociation"
        }
      }
    },
    "AbstractDataSetPersonAssociation": {
      "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"
        },
        "period": {
          "$ref": "#/$defs/DateRange"
        },
        "typeDiscriminator": {
          "type": "string"
        }
      },
      "description": "An association between dataset and a person",
      "discriminator": {
        "propertyName": "typeDiscriminator",
        "mapping": {
          "InternalDataSetPersonAssociation": "#/components/schemas/InternalDataSetPersonAssociation",
          "ExternalDataSetPersonAssociation": "#/components/schemas/ExternalDataSetPersonAssociation"
        }
      }
    },
    "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"
        }
      ]
    },
    "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"
              }
            }
          }
        }
      ]
    },
    "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"
    },
    "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}"
    },
    "DataSetActivityAssociation": {
      "required": [
        "activity"
      ],
      "type": "object",
      "properties": {
        "activity": {
          "$ref": "#/$defs/ActivityRef"
        }
      },
      "description": "An association to an activity."
    },
    "DataSetAssociation": {
      "required": [
        "dataSet"
      ],
      "type": "object",
      "properties": {
        "dataSet": {
          "$ref": "#/$defs/DataSetRef"
        }
      },
      "description": "An association to a dataset."
    },
    "DataSetAuthorCollaborationContributorAssociation": {
      "required": [
        "authorCollaboration"
      ],
      "type": "object",
      "description": "An author collaboration associated with the content.",
      "allOf": [
        {
          "$ref": "#/$defs/AbstractDataSetContributorAssociation"
        },
        {
          "type": "object",
          "properties": {
            "authorCollaboration": {
              "$ref": "#/$defs/AuthorCollaborationRef"
            }
          }
        }
      ]
    },
    "DataSetDocument": {
      "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
        },
        "embargoDate": {
          "type": "string",
          "description": "Embargo date.",
          "format": "date-time",
          "nullable": true
        }
      },
      "description": "A dataset document."
    },
    "DataSetDoi": {
      "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
        },
        "doi": {
          "type": "string",
          "description": "DOI.",
          "nullable": true
        },
        "accessType": {
          "$ref": "#/$defs/ClassificationRef"
        },
        "embargoPeriod": {
          "$ref": "#/$defs/DateRange"
        },
        "licenseType": {
          "$ref": "#/$defs/ClassificationRef"
        }
      },
      "description": "A DOI."
    },
    "DataSetEquipmentAssociation": {
      "required": [
        "equipment"
      ],
      "type": "object",
      "properties": {
        "equipment": {
          "$ref": "#/$defs/EquipmentRef"
        }
      },
      "description": "An association to an equipment."
    },
    "DataSetExternalContributorAssociation": {
      "required": [
        "externalPerson",
        "role"
      ],
      "type": "object",
      "description": "An external contributor associated with the content.",
      "allOf": [
        {
          "$ref": "#/$defs/AbstractDataSetContributorAssociation"
        },
        {
          "type": "object",
          "properties": {
            "name": {
      

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-bath/refs/heads/main/json-schema/university-of-bath-dataset-schema.json