openapi: 3.0.1 info: title: Pure activity 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.3-4 servers: - url: https://pure.kfupm.edu.sa/ws/api description: KFUPM Elsevier Pure Web Services (authentication required) security: - api-key: [] tags: - name: activity paths: /activities: get: tags: - activity summary: Lists all activities description: Lists all activities in the Pure instance. If you need to filter the activities returned, see the POST version which supports additional filtering. operationId: activity_list parameters: - name: size in: query description: Number of returned activities 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 /activities/orderings schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ActivityListResult' put: tags: - activity summary: Create activity description: Create activity operationId: activity_create requestBody: description: The content to create content: application/json: schema: $ref: '#/components/schemas/Activity' required: true responses: '201': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Activity' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /activities/allowed-attendance-person-roles: get: tags: - activity summary: A list of allowed attendance activity person roles description: Get a list of allowed roles for persons on attendance activities operationId: activity_getAllowedAttendancePersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-categories: get: tags: - activity summary: A list of allowed categories description: Get a list of allowed categories for activities operationId: activity_getAllowedCategories responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-classified-identifier-types: get: tags: - activity 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 activities operationId: activity_getAllowedClassifiedIdentifierTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-consultancy-person-roles: get: tags: - activity summary: A list of allowed consultancy activity person roles description: Get a list of allowed roles for persons on consultancy activities operationId: activity_getAllowedConsultancyPersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-custom-defined-field-values/{propertyName}/classifications: get: tags: - activity summary: Get allowed classifications for the custom-defined field associated with the activity description: Get allowed classifications for the custom-defined field associated with the activity. operationId: activity_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' /activities/allowed-degree-of-recognitions: get: tags: - activity summary: A list of allowed degree of recognitions description: Get a list of allowed degree of recognitions on activities operationId: activity_getAllowedDegreeOfRecognitions responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-description-types: get: tags: - activity summary: A list of allowed description types description: Get a list of allowed types for descriptions on activities operationId: activity_getAllowedDescriptionTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-document-licenses: get: tags: - activity summary: A list of allowed document licenses description: Get a list of allowed license types for documents on activities operationId: activity_getAllowedDocumentLicenses responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-document-types: get: tags: - activity summary: A list of allowed document types description: Get a list of allowed types for documents on activities operationId: activity_getAllowedDocumentTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-editorial-work-person-roles: get: tags: - activity summary: A list of allowed editorial-work activity person roles description: Get a list of allowed roles for persons on editorial-work activities operationId: activity_getAllowedEditorialWorkPersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-examination-person-roles: get: tags: - activity summary: A list of allowed examination activity person roles description: Get a list of allowed roles for persons on examination activities operationId: activity_getAllowedExaminationPersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-host-visitor-countries: get: tags: - activity summary: A list of allowed host visitor countries description: Get a list of allowed countries host visitor activities operationId: activity_getAllowedHostVisitorCountries responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-host-visitor-person-roles: get: tags: - activity summary: A list of allowed host-visitor activity person roles description: Get a list of allowed roles for persons on host visitor activities operationId: activity_getAllowedHostVisitorPersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-image-types: get: tags: - activity 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 activities operationId: activity_getAllowedImageTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-indicators: get: tags: - activity summary: A list of allowed activity indicators description: Get a list of allowed indicators on activities operationId: activity_getAllowedIndicators responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-keyword-group-configurations: get: tags: - activity 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: activity_getAllowedKeywordGroupConfigurations responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList' /activities/allowed-keyword-group-configurations/{id}/classifications: get: tags: - activity 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: activity_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' /activities/allowed-link-types: get: tags: - activity summary: A list of allowed link types description: Get a list of allowed link types on activities operationId: activity_getAllowedLinkTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-locales: get: tags: - activity 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: activity_getAllowedLocales responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LocalesList' /activities/allowed-membership-person-roles: get: tags: - activity summary: A list of allowed membership activity person roles description: Get a list of allowed roles for persons on membership activities operationId: activity_getAllowedMembershipPersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-other-activity-person-roles: get: tags: - activity summary: A list of allowed other activity person roles description: Get a list of allowed roles for persons on other activities operationId: activity_getAllowedOtherActivityPersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-talk-person-roles: get: tags: - activity summary: A list of allowed talk activity person roles description: Get a list of allowed roles for persons on talk activities operationId: activity_getAllowedTalkPersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-types: get: tags: - activity summary: A list of allowed activity types description: Get a list of allowed types that can be used for the 'type' attribute of activities operationId: activity_getAllowedTypes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-visit-other-person-roles: get: tags: - activity summary: A list of allowed visit-other activity person roles description: Get a list of allowed roles for persons on visit-other activities operationId: activity_getAllowedVisitOtherPersonRoles responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ClassificationRefList' /activities/allowed-workflow-steps: get: tags: - activity summary: A list of allowed workflow steps in localized strings description: Get a list of allowed workflow steps. operationId: activity_getAllowedWorkflowSteps responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/WorkflowListResult' /activities/disciplines/allowed-discipline-schemes: get: tags: - activity summary: A list of allowed discipline schemes description: Get a list fo a allowed discipline schemes for activities operationId: activity_getAllowedDisciplineSchemes responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult' /activities/disciplines/{discipline-scheme}/allowed-disciplines: get: tags: - activity summary: A list of allowed disciplines for a specific discipline scheme description: Get a list of a allowed disciplines for specific discipline scheme for activities operationId: activity_getAllowedDisciplines parameters: - name: discipline-scheme in: path description: Identifier for the discipline scheme for activities required: true schema: type: string - name: size in: query description: Number of returned disciplines 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/DisciplinesDisciplineListResult' /activities/disciplines/{discipline-scheme}/search: post: tags: - activity summary: Query operation for disciplines associated with activities description: Lists disciplines from the discipline scheme associated with activities in the Pure instance that matches the provided query. operationId: activity_listDisciplineAssociations parameters: - name: discipline-scheme in: path description: Identifier for the discipline scheme required: true schema: type: string requestBody: description: The query to perform content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociationsQuery' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociationListResult' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /activities/file-uploads: put: tags: - activity summary: Upload file to a specific activity description: Uploads file for the activity operationId: activity_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' /activities/orderings: get: tags: - activity summary: Lists available orderings description: Lists all orderings available to the activities endpoint. These values can be used by the order parameter when listing activities. operationId: activity_getOrderings responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/OrderingsList' /activities/search: post: tags: - activity summary: Query operation for activities description: Lists activities 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: activity_query requestBody: description: The query to perform content: application/json: schema: $ref: '#/components/schemas/ActivitiesQuery' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ActivityListResult' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' /activities/{uuid}: get: tags: - activity summary: Get activity description: Get activity with specific UUID. operationId: activity_get parameters: - name: uuid in: path description: UUID of the desired activity required: true schema: pattern: .+ type: string format: uuid responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Activity' '301': description: The requested content have changed UUID '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - activity summary: Update an activity description: Update an activity with specific UUID. operationId: activity_update parameters: - name: uuid in: path description: UUID of the activity to update required: true schema: pattern: .+ type: string format: uuid requestBody: description: The content to update content: application/json: schema: $ref: '#/components/schemas/Activity' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Activity' '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: - activity summary: Delete activity description: Delete activity with specific UUID. operationId: activity_delete parameters: - name: uuid in: path description: UUID of the activity 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' /activities/{uuid}/actions/lock: post: tags: - activity 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: activity_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' /activities/{uuid}/actions/unlock: post: tags: - activity 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: activity_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' /activities/{uuid}/dependents: get: tags: - activity summary: Lists all dependents to a activity description: 'Lists all dependents to a activity with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. ' operationId: activity_dependents parameters: - name: uuid in: path description: UUID of the activity required: true schema: pattern: .+ type: string format: uuid - name: verbose in: query description: DEPRECATED - Parameter has no effect. deprecated: true schema: type: boolean responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ContentRefListResult' /activities/{uuid}/disciplines/{discipline-scheme}: get: tags: - activity summary: Get disciplines from the discipline scheme associated with the activity description: Get disciplines from the discipline scheme associated with the activity with specific UUID. operationId: activity_getDisciplineAssociation parameters: - name: uuid in: path description: UUID of the desired activity required: true schema: pattern: .+ type: string format: uuid - name: discipline-scheme in: path description: Identifier for the discipline scheme required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociation' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - activity summary: Update disciplines from the discipline scheme associated with the activity description: Update disciplines from the discipline scheme associated with the activity with specific UUID. operationId: activity_putDisciplineAssociation parameters: - name: uuid in: path description: UUID of the activity to update required: true schema: pattern: .+ type: string format: uuid - name: discipline-scheme in: path description: Identifier for the discipline scheme required: true schema: type: string requestBody: description: The disciplines association to create content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociation' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/DisciplinesAssociation' '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' /activities/{uuid}/files/{fileId}: get: tags: - activity summary: Get file from the activity description: Get file from the activity operationId: activity_getFile parameters: - name: uuid in: path description: UUID of the activity 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 /activities/{uuid}/notes: get: tags: - activity summary: Lists notes description: Lists notes associated with an activity ordered by date (nulls last) operationId: activity_listNotes parameters: - name: uuid in: path description: UUID of the activity 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: activity not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - activity summary: Create note description: Create note and associate it with an activity operationId: activity_createNote parameters: - name: uuid in: path description: UUID of the activity 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: Activity: required: - managingOrganization - period - persons - type - typeDiscriminator - visibility type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true uuid: type: string description: UUID, this is the primary identity of the entity format: uuid readOnly: true createdBy: type: string description: Username of creator readOnly: true createdDate: type: string description: Date and time of creation format: date-time readOnly: true modifiedBy: type: string description: Username of the user that performed a modification readOnly: true modifiedDate: type: string description: Date and time of last modification format: date-time readOnly: true portalUrl: type: string description: URL of the content on the Pure Portal readOnly: true prettyUrlIdentifiers: type: array description: All pretty URLs readOnly: true items: type: string description: All pretty URLs readOnly: true previousUuids: type: array description: UUIDs of other content items which have been merged into this content item (or similar) readOnly: true items: type: string description: UUIDs of other content items which have been merged into this content item (or similar) readOnly: true version: type: string description: Used to guard against conflicting updates. For new content this is null, and for existing content the current value. The property should never be modified by a client, except in the rare case where the client wants to perform an update irrespective of if other clients have made updates in the meantime, also known as a "dirty write". A dirty write is performed by not including the property value or setting the property to null nullable: true organizations: type: array description: A collection of organization associations. nullable: true items: $ref: '#/components/schemas/OrganizationRef' persons: type: array description: A collection of persons. items: $ref: '#/components/schemas/AbstractActivityPersonAssociation' period: $ref: '#/components/schemas/CompoundDateRange' category: $ref: '#/components/schemas/ClassificationRef' managingOrganization: $ref: '#/components/schemas/OrganizationRef' links: type: array description: Additional links associated with this activity. nullable: true items: $ref: '#/components/schemas/Link' type: $ref: '#/components/schemas/ClassificationRef' visibility: $ref: '#/components/schemas/Visibility' workflow: $ref: '#/components/schemas/Workflow' externalOrganizations: type: array description: A collection of external organization affiliations. nullable: true items: $ref: '#/components/schemas/ExternalOrganizationRef' identifiers: type: array description: Identifiers related to the activity. nullable: true items: $ref: '#/components/schemas/Identifier' keywordGroups: type: array description: Groups of keywords associated with the research output. nullable: true items: $ref: '#/components/schemas/KeywordGroup' activities: type: array description: A collection of related activities. nullable: true items: $ref: '#/components/schemas/ActivityRef' pressMedia: type: array description: A collection of related press media. nullable: true items: $ref: '#/components/schemas/PressMediaRef' studentTheses: type: array description: A collection of related student theses. nullable: true items: $ref: '#/components/schemas/StudentThesisRef' prizes: type: array description: A collection of related prizes. nullable: true items: $ref: '#/components/schemas/ActivityPrizeAssociation' projects: type: array description: A collection of related projects. nullable: true items: $ref: '#/components/schemas/ActivityProjectAssociation' dataSets: type: array description: A collection of related data sets. nullable: true items: $ref: '#/components/schemas/ActivityDatasetAssociation' researchOutputs: type: array description: A collection of related research outputs. nullable: true items: $ref: '#/components/schemas/ResearchOutputRef' impacts: type: array description: A collection of related impacts. nullable: true items: $ref: '#/components/schemas/ImpactRef' equipment: type: array description: A collection of equipment. nullable: true items: $ref: '#/components/schemas/EquipmentRef' degreeOfRecognition: $ref: '#/components/schemas/ClassificationRef' documents: type: array description: Associated documents for the activity. nullable: true items: $ref: '#/components/schemas/Document' descriptions: type: array description: A collection of descriptions. nullable: true items: $ref: '#/components/schemas/ClassifiedFormattedLocalizedValue' images: type: array description: Image files with a maximum file size of 1MB. nullable: true items: $ref: '#/components/schemas/ImageFile' customDefinedFields: $ref: '#/components/schemas/CustomDefinedFields' indicators: type: array description: Indicators for the activity. nullable: true items: $ref: '#/components/schemas/ClassificationRef' systemName: type: string description: The content system name readOnly: true typeDiscriminator: type: string description: Activities exist in many variations. discriminator: propertyName: typeDiscriminator mapping: Attendance: '#/components/schemas/Attendance' Consultancy: '#/components/schemas/Consultancy' EditorialWork: '#/components/schemas/EditorialWork' Examination: '#/components/schemas/Examination' HostVisitor: '#/components/schemas/HostVisitor' Membership: '#/components/schemas/Membership' OtherActivity: '#/components/schemas/OtherActivity' Talk: '#/components/schemas/Talk' VisitOther: '#/components/schemas/VisitOther' DisciplinesDisciplineScheme: required: - disciplineScheme - title type: object properties: disciplineScheme: type: string description: The discipline scheme identifier title: type: string description: The discipline title description: A discipline scheme 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 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) 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 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: '#/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 description: Document DisciplinesDisciplineListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Disciplines items: $ref: '#/components/schemas/DisciplinesDiscipline' description: List of disciplines for a specific discipline scheme ActivityProjectAssociation: required: - project type: object properties: project: $ref: '#/components/schemas/ProjectRef' description: An association with a project. StudentThesisRef: required: - uuid type: object description: A reference to student thesis nullable: true allOf: - $ref: '#/components/schemas/ContentRef' Link: required: - url type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true url: type: string description: The URL (Uniform Resource Locator) of the link alias: type: string description: A user-friendly text to show instead of the URL nullable: true description: $ref: '#/components/schemas/LocalizedString' linkType: $ref: '#/components/schemas/ClassificationRef' description: A hyperlink describing a location on the web. ActivityDatasetAssociation: required: - dataset type: object properties: dataset: $ref: '#/components/schemas/DataSetRef' description: An association with an dataset. 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 ExternalOrganizationRef: required: - uuid type: object description: A reference to an organization external to the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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' DataSetRef: required: - uuid type: object description: A reference to a data set nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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 Name: type: object properties: firstName: type: string lastName: type: string description: A name describing a person, made up of given- and family name DisciplinesDisciplineAssignment: required: - disciplineId - splitPercentage type: object properties: disciplineId: type: string description: The assigned discipline splitPercentage: type: number description: The split percentages within an assigned discipline scheme must sum up to 100% format: double description: The assigned discipline and its split percentage DisciplinesAssociationsQuery: type: object properties: uuids: type: array items: type: string format: uuid size: type: integer format: int32 offset: type: integer format: int32 description: Create a query for discipline associations EquipmentRef: required: - uuid type: object description: A reference to a piece of equipment nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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: '#/components/schemas/FormattedLocalizedString' type: $ref: '#/components/schemas/ClassificationRef' description: A classified formatted localized value 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 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 ActivityListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Activity items: $ref: '#/components/schemas/Activity' description: List of activities. Can contain a subset of all items along with the full count 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 DisciplinesDisciplineSchemeListResult: type: object properties: count: type: integer description: The amount of discipline schemes format: int32 items: type: array description: Discipline schemes items: $ref: '#/components/schemas/DisciplinesDisciplineScheme' description: List of discipline schemes ActivityPrizeAssociation: required: - prize type: object properties: prize: $ref: '#/components/schemas/PrizeRef' description: An association with a prize. AllowedKeywordGroupConfigurationList: type: object properties: configurations: type: array items: $ref: '#/components/schemas/AllowedKeywordGroupConfiguration' description: List of allowed keyword group configurations ContentRefListResult: type: object properties: items: type: array items: $ref: '#/components/schemas/ContentRef' description: List of Content Refs 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' ProjectRef: required: - uuid type: object description: A reference to project nullable: true allOf: - $ref: '#/components/schemas/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' PersonExpertise: '#/components/schemas/PersonExpertiseRef' Contract: '#/components/schemas/ContractRef' Milestone: '#/components/schemas/MilestoneRef' Fingerprint: '#/components/schemas/FingerprintRef' Specialization: '#/components/schemas/SpecializationRef' StudentProject: '#/components/schemas/StudentProjectRef' DisciplinesDiscipline: type: object properties: disciplineId: type: string description: The discipline identifier readOnly: true title: type: string description: The discipline title readOnly: true description: type: string description: The discipline description readOnly: true description: A discipline within a specific discipline scheme ImpactRef: required: - uuid type: object description: A reference to impact nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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 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' OrganizationRef: required: - uuid type: object description: A reference to an organization in the institution nullable: true allOf: - $ref: '#/components/schemas/ContentRef' 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 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}' ResearchOutputRef: required: - uuid type: object description: A reference to a research output nullable: true allOf: - $ref: '#/components/schemas/ContentRef' FormattedLocalizedString: type: object additionalProperties: type: string description: A set of localized strings that support formatting. Invalid locale values will be ignored. nullable: true example: '{"en_GB":"Some text"}' description: A set of localized strings that support formatting. Invalid locale values will be ignored. nullable: true example: en_GB: Some text ClassificationSchemeRef: required: - uuid type: object description: A reference to a classification scheme nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ClassificationRefList: type: object properties: classifications: type: array items: $ref: '#/components/schemas/ClassificationRef' description: List of classification references PrizeRef: required: - uuid type: object description: A reference to a prize nullable: true allOf: - $ref: '#/components/schemas/ContentRef' PressMediaRef: required: - uuid type: object description: A reference to a press/media nullable: true allOf: - $ref: '#/components/schemas/ContentRef' DisciplinesAssociation: required: - disciplineAssignments type: object properties: content: $ref: '#/components/schemas/ContentRef' disciplineScheme: type: string description: The discipline scheme these disciplines are assigned from readOnly: true disciplineAssignments: type: array description: A collection of assigned disciplines items: $ref: '#/components/schemas/DisciplinesDisciplineAssignment' description: An association between a content and a number of discipline assignments 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 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 WorkflowListResult: type: object properties: workflows: type: array description: Allowed workflow steps. items: $ref: '#/components/schemas/Workflow' description: List of workflow steps. 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 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' 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 AbstractActivityPersonAssociation: required: - role - typeDiscriminator type: object properties: pureId: type: integer description: Pure database ID of the object, prefer using the UUID if it is present on the entity format: int64 readOnly: true externalOrganizations: type: array description: A collection of external organization affiliations. nullable: true items: $ref: '#/components/schemas/ExternalOrganizationRef' name: $ref: '#/components/schemas/Name' role: $ref: '#/components/schemas/ClassificationRef' typeDiscriminator: type: string description: An association between an activity and a person, which can either be internal or external discriminator: propertyName: typeDiscriminator mapping: InternalActivityPersonAssociation: '#/components/schemas/InternalActivityPersonAssociation' ExternalActivityPersonAssociation: '#/components/schemas/ExternalActivityPersonAssociation' 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 DisciplinesAssociationListResult: type: object properties: count: type: integer description: The full count, ignoring paging format: int32 pageInformation: $ref: '#/components/schemas/PageInformation' items: type: array description: Discipline associations items: $ref: '#/components/schemas/DisciplinesAssociation' description: List of discipline associations. Can contain a subset of all items along with the full count Workflow: required: - step type: object properties: step: type: string description: Current workflow step description: $ref: '#/components/schemas/SystemLocalizedString' description: Information about workflow OrderingsList: type: object properties: orderings: type: array description: IDs of ways content can be ordered items: type: string description: IDs of ways content can be ordered description: List of available orderings ActivityRef: required: - uuid type: object description: A reference to an activity nullable: true allOf: - $ref: '#/components/schemas/ContentRef' ActivitiesQuery: 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 activities securitySchemes: api-key: type: apiKey description: Security mechanism for the API name: api-key in: header