Queen's University Belfast studentProject API

openapi: 3.0.1
info:
  title: Pure activity studentProject 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.qub.ac.uk/ws/api
  description: Queen's University Belfast Pure API
security:
- api-key: []
tags:
- name: studentProject
paths:
  /student-projects:
    get:
      tags:
      - studentProject
      summary: Lists all student projects
      description: Lists all student projects in the Pure instance. If you need to filter the student projects returned, see the POST version which supports additional filtering.
      operationId: studentProject_list
      parameters:
      - name: size
        in: query
        description: Number of returned student projects 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 /student-projects/orderings
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudentProjectListResult'
    put:
      tags:
      - studentProject
      summary: Create student project
      description: Create student project
      operationId: studentProject_create
      requestBody:
        description: The content to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StudentProject'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudentProject'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /student-projects/allowed-appendix-document-licenses:
    get:
      tags:
      - studentProject
      summary: A list of allowed document licenses
      description: Get a list of allowed document licenses for student projects
      operationId: studentProject_getAllowedAppendixDocumentLicenses
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-appendix-document-types:
    get:
      tags:
      - studentProject
      summary: A list of allowed document types
      description: Get a list of allowed types for documents on student projects
      operationId: studentProject_getAllowedAppendixDocumentTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-campuses:
    get:
      tags:
      - studentProject
      summary: A list of allowed campuses
      description: Get a list of allowed campuses on student projects
      operationId: studentProject_getAllowedCampuses
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-document-licenses:
    get:
      tags:
      - studentProject
      summary: A list of allowed document licenses
      description: Get a list of allowed document licenses for student projects
      operationId: studentProject_getAllowedDocumentLicenses
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-document-types:
    get:
      tags:
      - studentProject
      summary: A list of allowed document types
      description: Get a list of allowed types for documents on student projects
      operationId: studentProject_getAllowedDocumentTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-external-collaborator-roles:
    get:
      tags:
      - studentProject
      summary: A list of allowed external collaborator rules
      description: Get a list of allowed external collaborator rules for the 'externalCollaborators' property on student projects
      operationId: studentProject_getAllowedExternalCollaboratorRoles
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-groups:
    get:
      tags:
      - studentProject
      summary: A list of allowed groups
      description: Get a list of allowed groups on student projects
      operationId: studentProject_getAllowedGroups
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-image-types:
    get:
      tags:
      - studentProject
      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: studentProject_getAllowedImageTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-keyword-group-configurations:
    get:
      tags:
      - studentProject
      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: studentProject_getAllowedKeywordGroupConfigurations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
  /student-projects/allowed-keyword-group-configurations/{id}/classifications:
    get:
      tags:
      - studentProject
      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: studentProject_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'
  /student-projects/allowed-languages:
    get:
      tags:
      - studentProject
      summary: A list of allowed languages
      description: Get a list of allowed languages on student projects
      operationId: studentProject_getAllowedLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-link-types:
    get:
      tags:
      - studentProject
      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 student project
      operationId: studentProject_getAllowedLinkTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-locales:
    get:
      tags:
      - studentProject
      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: studentProject_getAllowedLocales
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalesList'
  /student-projects/allowed-supervisor-types:
    get:
      tags:
      - studentProject
      summary: A list of allowed supervisor types
      description: Get a list of allowed supervisor types on student projects
      operationId: studentProject_getAllowedSupervisorTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-types:
    get:
      tags:
      - studentProject
      summary: A list of allowed student project types
      description: Get a list of allowed types that can be used for the 'type' attribute of student project
      operationId: studentProject_getAllowedTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /student-projects/allowed-workflow-steps:
    get:
      tags:
      - studentProject
      summary: A list of allowed workflow steps in localized strings
      description: Get a list of allowed workflow steps.
      operationId: studentProject_getAllowedWorkflowSteps
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListResult'
  /student-projects/file-uploads:
    put:
      tags:
      - studentProject
      summary: Upload file to a specific student project
      description: Uploads file for the student project
      operationId: studentProject_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'
  /student-projects/orderings:
    get:
      tags:
      - studentProject
      summary: Lists available orderings
      description: Lists all orderings available to the student project endpoint. These values can be used by the order parameter.
      operationId: studentProject_getOrderings
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderingsList'
  /student-projects/search:
    post:
      tags:
      - studentProject
      summary: Query operation for student project
      description: Lists student projects 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: studentProject_query
      requestBody:
        description: The query to perform
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StudentProjectQuery'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudentProjectListResult'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /student-projects/{uuid}:
    get:
      tags:
      - studentProject
      summary: Get student project
      description: Get student project with specific UUID.
      operationId: studentProject_get
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired student project
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudentProject'
        '301':
          description: The requested content have changed UUID
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - studentProject
      summary: Update student project
      description: Update student project with specific UUID.
      operationId: studentProject_update
      parameters:
      - name: uuid
        in: path
        description: UUID of the student project to update
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      requestBody:
        description: The content to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StudentProject'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudentProject'
        '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:
      - studentProject
      summary: Delete student project
      description: Delete student project with specific UUID.
      operationId: studentProject_delete
      parameters:
      - name: uuid
        in: path
        description: UUID of the student project
        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'
  /student-projects/{uuid}/actions/lock:
    post:
      tags:
      - studentProject
      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: studentProject_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'
  /student-projects/{uuid}/actions/unlock:
    post:
      tags:
      - studentProject
      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: studentProject_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'
  /student-projects/{uuid}/dependents:
    get:
      tags:
      - studentProject
      summary: Lists all dependents to the student project
      description: 'Lists all dependents to the student project with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
      operationId: studentProject_dependents
      parameters:
      - name: uuid
        in: path
        description: UUID of the student project
        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'
  /student-projects/{uuid}/files/{fileId}:
    get:
      tags:
      - studentProject
      summary: Get file from the student project
      description: Get file from the student project
      operationId: studentProject_getFile
      parameters:
      - name: uuid
        in: path
        description: UUID of the student project
        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
  /student-projects/{uuid}/notes:
    get:
      tags:
      - studentProject
      summary: Lists notes
      description: Lists notes associated with an student project ordered by date (nulls last)
      operationId: studentProject_listNotes
      parameters:
      - name: uuid
        in: path
        description: UUID of the student project 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: studentProject not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - studentProject
      summary: Create note
      description: Create note and associate it with an student project
      operationId: studentProject_createNote
      parameters:
      - name: uuid
        in: path
        description: UUID of the student project 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:
    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
    StudentProjectSupervisor:
      required:
      - externalPerson
      - person
      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
        supervisorType:
          $ref: '#/components/schemas/ClassificationRef'
        email:
          type: string
          description: The supervisor email
          nullable: true
        person:
          $ref: '#/components/schemas/PersonRef'
        externalPerson:
          $ref: '#/components/schemas/ExternalPersonRef'
      description: A supervisor for a student project
    StudentProject:
      required:
      - authors
      - confidential
      - educations
      - externalCollaboration
      - hasSupervisors
      - language
      - publicationDate
      - 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
        publishingInstitution:
          type: string
          description: The Publishing institution of the student thesis
          nullable: true
        hasSupervisors:
          type: boolean
          description: Whether the student project has supervisors or not
        supervisors:
          type: array
          description: A collection of supervisors
          items:
            $ref: '#/components/schemas/StudentProjectSupervisor'
        publishingPlace:
          type: string
          description: Place of Publishing
          nullable: true
        location:
          type: string
          description: The location
          nullable: true
        placement:
          type: string
          description: The placement
          nullable: true
        contactInfo:
          type: string
          description: The contact info for the student project
          nullable: true
        room:
          type: string
          description: The room where the exam will take/took place
          nullable: true
        time:
          type: string
          description: The time when the exam will take/took place
          nullable: true
        examiner:
          type: string
          description: The examiner of the exam of the student thesis
          nullable: true
        documents:
          type: array
          description: The student project documents
          items:
            $ref: '#/components/schemas/StudentProjectDocument'
        appendices:
          type: array
          description: The student project appendix documents
          items:
            $ref: '#/components/schemas/StudentProjectAppendixDocument'
        educations:
          type: array
          description: The educations of the student project
          items:
            $ref: '#/components/schemas/EducationAssociation'
        authorComment:
          type: string
          description: Text field to capture any authors who could not be identified as an author model
          nullable: true
        externalCollaboration:
          type: boolean
          description: Whether it has an external collaboration or not
        externalCollaborators:
          type: array
          description: The external collaborators of the student project
          items:
            $ref: '#/components/schemas/StudentProjectExternalCollaborator'
        campus:
          $ref: '#/components/schemas/ClassificationRef'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        notificationRecipients:
          type: array
          description: A number of email addresses that will be notified once this student project enters the validated workflow step
          items:
            $ref: '#/components/schemas/StudentProjectNotificationRecipient'
        authors:
          type: array
          description: The collection of authors of the student project
          items:
            $ref: '#/components/schemas/StudentProjectAuthor'
        title:
          $ref: '#/components/schemas/FormattedLocalizedString'
        subTitle:
          $ref: '#/components/schemas/FormattedLocalizedString'
        studentProjectAbstract:
          $ref: '#/components/schemas/FormattedLocalizedString'
        language:
          $ref: '#/components/schemas/ClassificationRef'
        numberOfPages:
          type: integer
          description: The number of pages in the production. Not used by patents
          format: int32
          nullable: true
        publicationDate:
          $ref: '#/components/schemas/CompoundDate'
        confidential:
          type: boolean
          description: Indicates if the Student Project is confidential
        type:
          $ref: '#/components/schemas/ClassificationRef'
        visibility:
          $ref: '#/components/schemas/Visibility'
        links:
          type: array
          description: A collection of links
          items:
            $ref: '#/components/schemas/Link'
        images:
          type: array
          description: A collection of images
          items:
            $ref: '#/components/schemas/ImageFile'
        workflow:
          $ref: '#/components/schemas/Workflow'
        keywordGroups:
          type: array
          description: Groups of keywords associated

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/queens-university-belfast/refs/heads/main/openapi/queens-university-belfast-studentproject-api-openapi.yml