openapi: 3.0.1 info: title: Pure activity dataSet API description: The Pure API provides a secure and complete web services API for using and managing research information data in Pure. The API enables a broad range of use-cases for interacting with research information, from anonymous Open Data scenarios to enabling the next generation Pure admin. termsOfService: '' contact: name: '' url: '' email: pure-support@elsevier.com license: name: '' url: '' version: 5.35.0 servers: - url: https://scholars.hkbu.edu.hk/ws/api security: - api-key: [] tags: - name: dataSet paths: /data-sets: get: tags: - dataSet summary: Lists all data sets description: Lists all data sets in the Pure instance. If you need to filter the data sets returned, see the POST version which supports additional filtering. operationId: dataSet_list parameters: - name: size in: query description: Number of returned data sets per request. schema: maximum: 1000 type: integer format: int32 default: 10 - name: offset in: query description: The offset for the returned list. 0 or null value is from the start schema: type: integer format: int32 default: 0 - name: order in: query description: The order of the list, must be a value from /data sets/orderings schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DataSetListResult' put: tags: - dataSet summary: Create data set description: Create data set operationId: dataSet_create requestBody: description: The content to create content: application/json: schema: $ref: '#/components/schemas/DataSet' required: true responses: '201': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DataSet' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /data-sets/allowed-classified-identifier-types: get: tags: - dataSet summary: A list of allowed classified identifier types description: Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of data sets operationId: dataSet_getAllowedClassifiedIdentifierTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-contributors-roles: get: tags: - dataSet summary: A list of allowed contributors roles description: Get a list of allowed contributors roles that can be used for the 'contributor.role' attribute of the data set. operationId: dataSet_getAllowedContributorsRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-custom-defined-field-values/{propertyName}/classifications: get: tags: - dataSet summary: Get allowed classifications for the custom-defined field associated with the data set description: Get allowed classifications for the custom-defined field associated with the data set. operationId: dataSet_getAllowedCustomDefinedFieldClassifications parameters: - name: propertyName in: path description: PropertyName for the desired custom-defined field required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /data-sets/allowed-description-types: get: tags: - dataSet summary: A list of allowed classifications for the descriptions property description: Get a list of classifications that can be used when submitting a description. operationId: dataSet_getAllowedDescriptionTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-document-licenses: get: tags: - dataSet summary: A list of allowed document licenses description: Get a list of allowed license types that can be used for the 'documents.license' attribute of data sets operationId: dataSet_getAllowedDocumentLicenses responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-document-types: get: tags: - dataSet summary: A list of allowed document types description: Get a list of allowed license types that can be used for the 'documents.type' attribute of data sets operationId: dataSet_getAllowedDocumentTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-doi-access-types: get: tags: - dataSet summary: A list of allowed access types for DOI description: Get a list of allowed DOI access types on data sets operationId: dataSet_getAllowedDoiAccessTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-doi-license-types: get: tags: - dataSet summary: A list of allowed license types for DOI description: Get a list of allowed DOI license types on data sets operationId: dataSet_getAllowedDoiLicenseTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-image-types: get: tags: - dataSet summary: A list of allowed image types description: Get a list of allowed image types that can be used for the 'images.type' attribute of the data set. operationId: dataSet_getAllowedImageTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-keyword-group-configurations: get: tags: - dataSet summary: A list of keyword group configurations description: Get a list of allowed keyword group configurations that can be used when submitting keyword groups. operationId: dataSet_getAllowedKeywordGroupConfigurations responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList' /data-sets/allowed-keyword-group-configurations/{id}/classifications: get: tags: - dataSet summary: A list of allowed classifications for the specified keyword group description: Get a list of allowed classifications that can be used when submitting a specified keyword group. operationId: dataSet_getAllowedKeywordGroupConfigurationClassifications parameters: - name: id in: path description: Pure id of the keyword group configuration required: true schema: type: integer format: int64 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-legal-condition-types: get: tags: - dataSet summary: A list of allowed legal condition types description: Get a list of allowed types for legal condition on data sets operationId: dataSet_getAllowedLegalConditionsTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-licenses: get: tags: - dataSet summary: A list of allowed licenses description: Get a list of allowed licenses on data sets operationId: dataSet_getAllowedLicenses responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-link-types: get: tags: - dataSet summary: A list of allowed link types description: Get a list of allowed link types that can be used for the 'links.linkType' attribute of data sets operationId: dataSet_getAllowedLinkTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-locales: get: tags: - dataSet summary: A list of allowed locales in localized strings description: Get a list of allowed locales that can be used when submitting localized string entities. operationId: dataSet_getAllowedLocales responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LocalesList' /data-sets/allowed-nature-types: get: tags: - dataSet summary: A list of allowed nature types description: Get a list of allowed nature types for data sets. operationId: dataSet_getAllowedNatureTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-open-access-permissions: get: tags: - dataSet summary: A list of allowed open access permissions description: Get a list of allowed open access permissions on data sets operationId: dataSet_getAllowedOpenAccessPermissions responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-persons-roles: get: tags: - dataSet summary: A list of allowed person roles description: Get a list of allowed person roles that can be used for the 'persons.role' attribute of the data set. operationId: dataSet_getAllowedPersonsRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-physical-data-types: get: tags: - dataSet summary: A list of allowed physical data types description: Get a list of allowed types for physical data on data sets operationId: dataSet_getAllowedPhysicalDataTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-types: get: tags: - dataSet summary: A list of allowed classifications for the type property description: Get a list of classifications that can be used when submitting a type. operationId: dataSet_getAllowedTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /data-sets/allowed-workflow-steps: get: tags: - dataSet summary: A list of allowed workflow steps description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of data sets operationId: dataSet_getAllowedWorkflowSteps responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/WorkflowListResult' /data-sets/file-uploads: put: tags: - dataSet summary: Upload file to a specific data set description: Uploads file for the data set operationId: dataSet_fileUploads parameters: - name: Content-Type in: header description: Set the mime type for the file schema: type: string requestBody: content: '*/*': schema: type: string format: binary required: true responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/UploadedFile' application/xml: schema: $ref: '#/components/schemas/UploadedFile' /data-sets/search: post: tags: - dataSet summary: Query operation for data sets description: Lists data sets in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options. operationId: dataSet_query requestBody: description: The query to perform content: application/json: schema: $ref: '#/components/schemas/DataSetsQuery' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DataSetListResult' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /data-sets/{uuid}: get: tags: - dataSet summary: Get data set description: Get data set with specific UUID. operationId: dataSet_get parameters: - name: uuid in: path description: UUID of the desired data set required: true schema: pattern: .+ type: string format: uuid responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DataSet' '301': description: The requested content have changed UUID '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - dataSet summary: Update data set description: Update data set with specific UUID. operationId: dataSet_update parameters: - name: uuid in: path description: UUID of the data set to update required: true schema: pattern: .+ type: string format: uuid requestBody: description: The content to update content: application/json: schema: $ref: '#/components/schemas/DataSet' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DataSet' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Version conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' delete: tags: - dataSet summary: Delete data set description: Delete data set with specific UUID. operationId: dataSet_delete parameters: - name: uuid in: path description: UUID of the data set required: true schema: pattern: .+ type: string format: uuid responses: '204': description: Successful operation '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' /data-sets/{uuid}/actions/lock: post: tags: - dataSet summary: Lock the content description: Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API. operationId: dataSet_lock parameters: - name: uuid in: path description: UUID of the content to lock required: true schema: pattern: .+ type: string format: uuid responses: '204': description: Content marked as locked '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Content already locked content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' /data-sets/{uuid}/actions/unlock: post: tags: - dataSet summary: Unlock the content description: Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API. operationId: dataSet_unlock parameters: - name: uuid in: path description: UUID of the content to unlock required: true schema: pattern: .+ type: string format: uuid responses: '204': description: Content marked as unlocked '404': description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '409': description: Content already unlocked content: application/problem+json: schema: $ref: '#/components/schemas/ConflictProblemDetails' /data-sets/{uuid}/files/{fileId}: get: tags: - dataSet summary: Get file from the data set description: Get file from the data set operationId: dataSet_getFile parameters: - name: uuid in: path description: UUID of the data set required: true schema: pattern: .+ type: string format: uuid - name: fileId in: path description: 'File id ' required: true schema: pattern: .+ type: string responses: '200': description: Successful operation content: '*/*': schema: type: string format: binary /data-sets/{uuid}/notes: get: tags: - dataSet summary: Lists notes description: Lists notes associated with an data set ordered by date (nulls last) operationId: dataSet_listNotes parameters: - name: uuid in: path description: UUID of the data set to get notes for required: true schema: pattern: .+ type: string format: uuid - name: size in: query description: Number of returned notes per request schema: maximum: 1000 type: integer format: int32 default: 10 - name: offset in: query description: The offset for the returned list. 0 or null value is from the start schema: type: integer format: int32 default: 0 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/NoteListResult' '404': description: data set not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - dataSet summary: Create note description: Create note and associate it with a data set operationId: dataSet_createNote parameters: - name: uuid in: path description: UUID of the data set to add note to required: true schema: pattern: .+ type: string format: uuid requestBody: description: The note to create content: application/json: schema: $ref: '#/components/schemas/Note' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Note' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' components: schemas: Note: required: - text type: object properties: date: type: string description: Date and time of when the note was created, an event occurred or similar. Can be any point in time, but is normally preferred format: date-time nullable: true username: type: string description: Username related to the note. Usually a username of the user creating the note. Does not have to be a username of a Pure user nullable: true text: type: string description: Note text description: A note 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: '#/components/schemas/LocalizedString' linkType: $ref: '#/components/schemas/ClassificationRef' description: A hyperlink describing a location on the web. 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 ClassificationSchemeRef: required: - uuid type: object description: A reference to a classification scheme nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ClassificationRef: required: - uri type: object properties: uri: type: string description: Classification URI of the referred classification term: $ref: '#/components/schemas/SystemLocalizedString' description: A reference to a classification value nullable: true ProjectRef: required: - uuid type: object description: A reference to project nullable: true allOf: - $ref: '#/components/schemas/ContentRef' EquipmentRef: required: - uuid type: object description: A reference to a piece of equipment nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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: '#/components/schemas/LocalizedString' typeDiscriminator: type: string discriminator: propertyName: typeDiscriminator mapping: ClassificationsKeywordGroup: '#/components/schemas/ClassificationsKeywordGroup' FreeKeywordsKeywordGroup: '#/components/schemas/FreeKeywordsKeywordGroup' FullKeywordGroup: '#/components/schemas/FullKeywordGroup' PublisherRef: required: - uuid type: object description: A reference to a publisher nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ClassificationRefList: type: object properties: classifications: type: array items: $ref: '#/components/schemas/ClassificationRef' description: List of classification references NoteListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Notes items: $ref: '#/components/schemas/Note' description: List of notes OrganizationRef: required: - uuid type: object description: A reference to an organization in the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' OrganizationOrExternalOrganizationRef: type: object properties: organizationRef: $ref: '#/components/schemas/OrganizationRef' externalOrganizationRef: $ref: '#/components/schemas/ExternalOrganizationRef' description: A reference to an organization in the institution or an external organization nullable: true DataSetActivityAssociation: required: - activity type: object properties: activity: $ref: '#/components/schemas/ActivityRef' description: An association to an activity. 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 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' PersonExpertise: '#/components/schemas/PersonExpertiseRef' Contract: '#/components/schemas/ContractRef' Milestone: '#/components/schemas/MilestoneRef' Fingerprint: '#/components/schemas/FingerprintRef' Specialization: '#/components/schemas/SpecializationRef' StudentProject: '#/components/schemas/StudentProjectRef' ConflictProblemDetails: type: object properties: type: type: string description: A URI reference [RFC3986] that identifies the problem type. title: type: string description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). status: type: integer description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. modified: type: string format: date-time modifiedBy: type: string description: Problem details for state conflict failures 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: '#/components/schemas/UploadedFile' remoteFile: $ref: '#/components/schemas/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: '#/components/schemas/ClassificationRef' copyrightConfirmation: type: boolean description: Indicates whether this file has been confirmed to adhere to the appropriate copyrights nullable: true caption: $ref: '#/components/schemas/LocalizedString' altText: $ref: '#/components/schemas/LocalizedString' copyrightStatement: $ref: '#/components/schemas/LocalizedString' description: An image file ExternalOrganizationRef: required: - uuid type: object description: A reference to an organization external to the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ImpactRef: required: - uuid type: object description: A reference to impact nullable: true allOf: - $ref: '#/components/schemas/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' DataSetStudentThesisAssociation: required: - studentThesis type: object properties: studentThesis: $ref: '#/components/schemas/StudentThesisRef' description: An association to a student thesis. DataSetEquipmentAssociation: required: - equipment type: object properties: equipment: $ref: '#/components/schemas/EquipmentRef' description: An association to an equipment. DataSetResearchOutputAssociation: required: - researchOutput type: object properties: researchOutput: $ref: '#/components/schemas/ResearchOutputRef' description: An association to a research output. DataSetPhysicalData: required: - media - storageLocation - title 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: type: string description: Title. storageLocation: type: string description: Storage location. accessDescription: type: string description: Access description. nullable: true media: type: string description: Media. type: $ref: '#/components/schemas/ClassificationRef' description: A description of physical data. PageInformation: type: object properties: offset: type: integer description: Offset that returned items start at format: int32 size: type: integer description: The requested number of items. May be higher than the actual number of items in the result if there are fewer items in the store than requested format: int32 description: Information about pages DataSetsQuery: type: object properties: uuids: type: array items: type: string format: uuid size: type: integer format: int32 offset: type: integer format: int32 orderings: type: array items: type: string searchString: type: string description: String used to perform search orderBy: type: string writeOnly: true description: Create a query for data sets DataSetLegalCondition: 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 description: type: string description: Description. nullable: true type: $ref: '#/components/schemas/ClassificationRef' description: A description of a legal condition. AllowedKeywordGroupConfiguration: required: - targetSystemName 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 targetSystemName: type: string description: The content system name this configuration applies to keywordGroupType: type: string description: The OpenAPI schema type of this keyword configuration readOnly: true name: $ref: '#/components/schemas/LocalizedString' description: $ref: '#/components/schemas/FormattedLocalizedString' classificationScheme: $ref: '#/components/schemas/ClassificationSchemeRef' allowUserdefinedKeywords: type: boolean description: Defines if user defined keywords are allowed limitToLeafSelection: type: boolean logicalName: type: string relationType: type: string description: The schema name of the type (with the ability to associate keywords) on which the keyword group configuration is related to, e.g. StaffOrganizationAssociation. It can also be set to null (default value), which means the keyword group configuration is related to the main type (the target system name) and not a relation of the main type. nullable: true description: A specification of the allowed behavior of a specified keyword group CustomDefinedFields: type: object additionalProperties: $ref: '#/components/schemas/CustomDefinedField' description: Map of CustomDefinedField values, where the key is the field identifier nullable: true example: '{ "fieldName1": "typeDiscriminator": "Integer", "value" : 1}' ActivityRef: required: - uuid type: object description: A reference to an activity nullable: true allOf: - $ref: '#/components/schemas/ContentRef' LocalesList: type: object properties: locales: pattern: /^[a-z]{2}_[A-Z]{2}$/ type: array description: Allowed locale values for use in localized string entities. The locale format consists of lower-case ISO 639 alpha-2 language code and upper-cased ISO 3166 alpha-2 country code. items: pattern: /^[a-z]{2}_[A-Z]{2}$/ type: string description: Allowed locale values for use in localized string entities. The locale format consists of lower-case ISO 639 alpha-2 language code and upper-cased ISO 3166 alpha-2 country code. description: List of available locales 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 Visibility: required: - key type: object properties: key: type: string description: Visibility value enum: - FREE - CAMPUS - BACKEND - CONFIDENTIAL description: $ref: '#/components/schemas/SystemLocalizedString' description: Visibility of an object PrizeRef: required: - uuid type: object description: A reference to a prize nullable: true allOf: - $ref: '#/components/schemas/ContentRef' DataSetPressMediaAssociation: required: - pressMedia type: object properties: pressMedia: $ref: '#/components/schemas/PressMediaRef' description: An association to a press media. 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: '#/components/schemas/LocalizedString' descriptions: type: array description: A collection of descriptions. nullable: true items: $ref: '#/components/schemas/ClassifiedLocalizedValue' managingOrganization: $ref: '#/components/schemas/OrganizationRef' type: $ref: '#/components/schemas/ClassificationRef' natureTypes: type: array description: Nature of activity types for the project. nullable: true items: $ref: '#/components/schemas/ClassificationRef' publisher: $ref: '#/components/schemas/PublisherRef' temporalCoveragePeriod: $ref: '#/components/schemas/CompoundDateRange' dataProductionPeriod: $ref: '#/components/schemas/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: '#/components/schemas/Identifier' geoLocation: $ref: '#/components/schemas/DataSetGeoLocation' persons: type: array description: DEPRECATED - use contributors instead. The persons that the dataset is associated with deprecated: true items: $ref: '#/components/schemas/AbstractDataSetPersonAssociation' contributors: type: array description: The contributors that the dataset is associated with items: $ref: '#/components/schemas/AbstractDataSetContributorAssociation' totalNumberOfAuthors: type: integer description: The total number of authors from author collaborations. format: int32 nullable: true doi: $ref: '#/components/schemas/DataSetDoi' documents: type: array description: A collection of documents. nullable: true items: $ref: '#/components/schemas/DataSetDocument' physicalData: type: array description: A collection of physical data. nullable: true items: $ref: '#/components/schemas/DataSetPhysicalData' contactPerson: $ref: '#/components/schemas/PersonRef' legalConditions: type: array description: A collection of legal conditions. nullable: true items: $ref: '#/components/schemas/DataSetLegalCondition' organizations: type: array description: A collection of organizational unit affiliations. nullable: true items: $ref: '#/components/schemas/OrganizationRef' externalOrganizations: type: array description: A collection of external organization affiliations. nullable: true items: $ref: '#/components/schemas/ExternalOrganizationRef' publicationAvailableDate: $ref: '#/components/schemas/CompoundDate' openAccess: $ref: '#/components/schemas/OpenAccess' openAireCompliant: type: boolean description: OpenAire Compliancy. readOnly: true license: $ref: '#/components/schemas/ClassificationRef' dataSets: type: array description: A collection of related datasets. nullable: true items: $ref: '#/components/schemas/DataSetAssociation' projects: type: array description: A collection of related projects. nullable: true items: $ref: '#/components/schemas/DataSetProjectAssociation' researchOutputs: type: array description: A collection of related research outputs. nullable: true items: $ref: '#/components/schemas/DataSetResearchOutputAssociation' activities: type: array description: A collection of related activities. nullable: true items: $ref: '#/components/schemas/DataSetActivityAssociation' pressMedia: type: array description: A collection of related press media. nullable: true items: $ref: '#/components/schemas/DataSetPressMediaAssociation' studentTheses: type: array description: A collection of related student theses. nullable: true items: $ref: '#/components/schemas/DataSetStudentThesisAssociation' impacts: type: array description: A collection of related impacts. nullable: true items: $ref: '#/components/schemas/DataSetImpactAssociation' prizes: type: array description: A collection of related prizes. nullable: true items: $ref: '#/components/schemas/DataSetPrizeAssociation' equipment: type: array description: A collection of related equipment. nullable: true items: $ref: '#/components/schemas/DataSetEquipmentAssociation' links: type: array description: A collection of links. nullable: true items: $ref: '#/components/schemas/Link' keywordGroups: type: array description: A group for each type of keyword present. nullable: true items: $ref: '#/components/schemas/KeywordGroup' visibility: $ref: '#/components/schemas/Visibility' images: type: array description: Image files with a maximum file size of 1MB nullable: true items: $ref: '#/components/schemas/ImageFile' fundingText: $ref: '#/components/schemas/LocalizedString' fundingDetails: type: array description: The funding details for the dataset nullable: true items: $ref: '#/components/schemas/FundingDetails' customDefinedFields: $ref: '#/components/schemas/CustomDefinedFields' workflow: $ref: '#/components/schemas/Workflow' systemName: type: string description: The content system name readOnly: true description: A dataset DataSetGeoLocation: type: object properties: point: type: string description: Location expressed as a point nullable: true polygon: type: string description: Location expressed as a polygon nullable: true calculatedPoint: type: string description: Used to determine whether or not we may update the point. An end-user has not entered a point manually if the value of the calculated point is the same as point readOnly: true geographicalCoverage: $ref: '#/components/schemas/LocalizedString' description: A data set geo-location. 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: '#/components/schemas/LocalizedString' type: $ref: '#/components/schemas/ClassificationRef' description: A classified localized value 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: '#/components/schemas/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' DataSetAssociation: required: - dataSet type: object properties: dataSet: $ref: '#/components/schemas/DataSetRef' description: An association to a dataset. StudentThesisRef: required: - uuid type: object description: A reference to student thesis nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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 ProblemDetails: type: object properties: type: type: string description: A URI reference [RFC3986] that identifies the problem type. title: type: string description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). status: type: integer description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. format: int32 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. description: RFC7807 Error details discriminator: propertyName: type mapping: /error: '#/components/schemas/GenericProblemDetails' /validation-error: '#/components/schemas/ValidationProblemDetails' /dependency-violation-error: '#/components/schemas/DependencyViolationProblemDetails' 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) OpenAccess: type: object properties: openAccessPermission: $ref: '#/components/schemas/ClassificationRef' openAccessEmbargoMonths: type: integer description: Open access embargo months. format: int32 nullable: true openAccessEmbargoDate: type: string description: Open access embargo date. format: date nullable: true readOnly: true description: Open Access information. AllowedKeywordGroupConfigurationList: type: object properties: configurations: type: array items: $ref: '#/components/schemas/AllowedKeywordGroupConfiguration' description: List of allowed keyword group configurations 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: '#/components/schemas/ClassificationRef' embargoPeriod: $ref: '#/components/schemas/DateRange' licenseType: $ref: '#/components/schemas/ClassificationRef' description: A DOI. DataSetProjectAssociation: required: - project type: object properties: project: $ref: '#/components/schemas/ProjectRef' description: An association to a project. 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: '#/components/schemas/UploadedFile' remoteFile: $ref: '#/components/schemas/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: '#/components/schemas/ClassificationRef' license: $ref: '#/components/schemas/ClassificationRef' visibleOnPortalDate: type: string description: The date the document will be available on the portal format: date readOnly: true visibility: $ref: '#/components/schemas/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. DataSetListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: DataSets items: $ref: '#/components/schemas/DataSet' description: List of datasets. Can contain a subset of all items along with the full count ResearchOutputRef: required: - uuid type: object description: A reference to a research output nullable: true allOf: - $ref: '#/components/schemas/ContentRef' DataSetPrizeAssociation: required: - prize type: object properties: prize: $ref: '#/components/schemas/PrizeRef' description: An association to a prize. 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' PersonRef: required: - uuid type: object description: A reference to a person internal to the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' Name: type: object properties: firstName: type: string lastName: type: string description: A name describing a person, made up of given- and family name PressMediaRef: required: - uuid type: object description: A reference to a press/media nullable: true allOf: - $ref: '#/components/schemas/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 Workflow: required: - step type: object properties: step: type: string description: Current workflow step description: $ref: '#/components/schemas/SystemLocalizedString' description: Information about workflow CompoundDateRange: type: object properties: startDate: $ref: '#/components/schemas/CompoundDate' endDate: $ref: '#/components/schemas/CompoundDate' description: A date range of that can be defined by only year, year and month or a full date 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 WorkflowListResult: type: object properties: workflows: type: array description: Allowed workflow steps. items: $ref: '#/components/schemas/Workflow' description: List of workflow steps. DataSetRef: required: - uuid type: object description: A reference to a data set nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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: '#/components/schemas/ExternalOrganizationRef' name: $ref: '#/components/schemas/Name' role: $ref: '#/components/schemas/ClassificationRef' period: $ref: '#/components/schemas/DateRange' typeDiscriminator: type: string description: An association between dataset and a person discriminator: propertyName: typeDiscriminator mapping: InternalDataSetPersonAssociation: '#/components/schemas/InternalDataSetPersonAssociation' ExternalDataSetPersonAssociation: '#/components/schemas/ExternalDataSetPersonAssociation' DataSetImpactAssociation: required: - impact type: object properties: impact: $ref: '#/components/schemas/ImpactRef' description: An association to an impact. FundingDetails: type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true fundingOrganizations: maxItems: 1 type: array description: The internal or external funding organizations nullable: true items: $ref: '#/components/schemas/OrganizationOrExternalOrganizationRef' fundingOrganizationAcronym: type: string description: The acronym of the funding organization nullable: true fundingNumbers: type: array description: Funding numbers/IDs nullable: true items: type: string description: Details about funding. securitySchemes: api-key: type: apiKey description: Security mechanism for the API name: api-key in: header