Queen's University Belfast ethicalReview API

openapi: 3.0.1
info:
  title: Pure activity ethicalReview 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: ethicalReview
paths:
  /ethical-reviews:
    get:
      tags:
      - ethicalReview
      summary: Lists all ethicalReviews
      description: Lists all ethicalReviews in the Pure instance. If you need to filter the ethicalReviews returned, see the POST version which supports additional filtering.
      operationId: ethicalReview_list
      parameters:
      - name: size
        in: query
        description: Number of returned ethicalReviews 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 /ethicalReviews/orderings
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EthicalReviewListResult'
    put:
      tags:
      - ethicalReview
      summary: Create ethicalReview
      description: Create ethicalReview
      operationId: ethicalReview_create
      requestBody:
        description: The content to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EthicalReview'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EthicalReview'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /ethical-reviews/allowed-classified-identifier-types:
    get:
      tags:
      - ethicalReview
      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 ethical reviews
      operationId: ethicalReview_getAllowedClassifiedIdentifierTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /ethical-reviews/allowed-custom-defined-field-values/{propertyName}/classifications:
    get:
      tags:
      - ethicalReview
      summary: Get allowed classifications for the custom-defined field associated with the project
      description: Get allowed classifications for the custom-defined field associated with the project.
      operationId: ethicalReview_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'
  /ethical-reviews/allowed-description-types:
    get:
      tags:
      - ethicalReview
      summary: A list of allowed description types
      description: Get a list of allowed types for descriptions on ethical reviews
      operationId: ethicalReview_getAllowedDescriptionTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /ethical-reviews/allowed-document-types:
    get:
      tags:
      - ethicalReview
      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 ethicalReviews
      operationId: ethicalReview_getAllowedDocumentTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /ethical-reviews/allowed-keyword-group-configurations:
    get:
      tags:
      - ethicalReview
      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: ethicalReview_getAllowedKeywordGroupConfigurations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
  /ethical-reviews/allowed-keyword-group-configurations/{id}/classifications:
    get:
      tags:
      - ethicalReview
      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: ethicalReview_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'
  /ethical-reviews/allowed-link-types:
    get:
      tags:
      - ethicalReview
      summary: A list of allowed link types
      description: Get a list of allowed link types on ethical reviews
      operationId: ethicalReview_getAllowedLinkTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /ethical-reviews/allowed-locales:
    get:
      tags:
      - ethicalReview
      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: ethicalReview_getAllowedLocales
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalesList'
  /ethical-reviews/allowed-persons-roles:
    get:
      tags:
      - ethicalReview
      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 ethical review.
      operationId: ethicalReview_getAllowedPersonsRoles
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /ethical-reviews/allowed-types:
    get:
      tags:
      - ethicalReview
      summary: A list of allowed ethical review types
      description: Get a list of allowed types that can be used for the 'type' attribute of ethical review
      operationId: ethicalReview_getAllowedTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /ethical-reviews/allowed-workflow-steps:
    get:
      tags:
      - ethicalReview
      summary: A list of allowed workflow steps
      description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of ethicalReviews
      operationId: ethicalReview_getAllowedWorkflowSteps
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListResult'
  /ethical-reviews/file-uploads:
    put:
      tags:
      - ethicalReview
      summary: Upload file for a specific ethicalReview
      description: Uploads file for the ethicalReview
      operationId: ethicalReview_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'
  /ethical-reviews/orderings:
    get:
      tags:
      - ethicalReview
      summary: Lists available orderings
      description: Lists all orderings available to the ethicalReviews endpoint. These values can be used by the order parameter when listing ethicalReviews.
      operationId: ethicalReview_getOrderings
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderingsList'
  /ethical-reviews/search:
    post:
      tags:
      - ethicalReview
      summary: Query operation for ethicalReviews
      description: Lists ethicalReviews 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: ethicalReview_query
      requestBody:
        description: The query to perform
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EthicalReviewQuery'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EthicalReviewListResult'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /ethical-reviews/{uuid}:
    get:
      tags:
      - ethicalReview
      summary: Get ethicalReview
      description: Get ethicalReview with specific UUID.
      operationId: ethicalReview_get
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired ethicalReview
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EthicalReview'
        '301':
          description: The requested content have changed UUID
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - ethicalReview
      summary: Update ethicalReview
      description: Update ethicalReview with specific UUID.
      operationId: ethicalReview_update
      parameters:
      - name: uuid
        in: path
        description: UUID of the ethicalReview to update
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      requestBody:
        description: The content to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EthicalReview'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EthicalReview'
        '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:
      - ethicalReview
      summary: Delete ethicalReview
      description: Delete ethicalReview with specific UUID.
      operationId: ethicalReview_delete
      parameters:
      - name: uuid
        in: path
        description: UUID of the ethicalReview
        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'
  /ethical-reviews/{uuid}/actions/lock:
    post:
      tags:
      - ethicalReview
      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: ethicalReview_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'
  /ethical-reviews/{uuid}/actions/unlock:
    post:
      tags:
      - ethicalReview
      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: ethicalReview_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'
  /ethical-reviews/{uuid}/dependents:
    get:
      tags:
      - ethicalReview
      summary: Lists all dependents to an ethical review
      description: 'Lists all dependents to an ethical review with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
      operationId: ethicalReview_dependents
      parameters:
      - name: uuid
        in: path
        description: UUID of the ethical review
        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'
  /ethical-reviews/{uuid}/files/{fileId}:
    get:
      tags:
      - ethicalReview
      summary: Get file from the ethicalReview
      description: Get file from the ethicalReview
      operationId: ethicalReview_getFile
      parameters:
      - name: uuid
        in: path
        description: UUID of the ethicalReview
        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
  /ethical-reviews/{uuid}/milestones:
    get:
      tags:
      - ethicalReview
      summary: List milestones on an ethical review
      description: List milestones on an ethical review.
      operationId: ethicalReview_getMilestones
      parameters:
      - name: uuid
        in: path
        description: UUID of the ethical review
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MilestoneListResult'
        '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'
  /ethical-reviews/{uuid}/notes:
    get:
      tags:
      - ethicalReview
      summary: Lists notes
      description: Lists notes associated with an ethicalReview ordered by date (nulls last)
      operationId: ethicalReview_listNotes
      parameters:
      - name: uuid
        in: path
        description: UUID of the ethicalReview 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: ethicalReview not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - ethicalReview
      summary: Create note
      description: Create note and associate it with the ethicalReview
      operationId: ethicalReview_createNote
      parameters:
      - name: uuid
        in: path
        description: UUID of the ethicalReview 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:
    EthicalReview:
      required:
      - managingOrganization
      - organizations
      - persons
      - 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'
        applications:
          type: array
          items:
            $ref: '#/components/schemas/EthicalReviewApplicationAssociation'
        awards:
          type: array
          items:
            $ref: '#/components/schemas/EthicalReviewAwardAssociation'
        persons:
          type: array
          description: A collection of persons.
          items:
            $ref: '#/components/schemas/AbstractClassifiedEthicalReviewPersonAssociation'
        documents:
          type: array
          description: A collection of documents related to the ethical review.
          nullable: true
          items:
            $ref: '#/components/schemas/EthicalReviewDocument'
        ethicalReviewReply:
          type: string
          description: The reply to the ethical review, either approved or declined.
          enum:
          - PENDING
          - APPROVED
          - DECLINED
          - EXTENDED
          - WITHDRAWN
          - EXPIRED
        managingOrganization:
          $ref: '#/components/schemas/OrganizationRef'
        organizations:
          type: array
          description: A collection of organization associations.
          items:
            $ref: '#/components/schemas/OrganizationRef'
        externalOrganizations:
          type: array
          description: A collection of external organization affiliations.
          nullable: true
          items:
            $ref: '#/components/schemas/ExternalOrganizationRef'
        visibility:
          $ref: '#/components/schemas/Visibility'
        identifiers:
          type: array
          description: Identifiers related to the ethical review.
          nullable: true
          items:
            $ref: '#/components/schemas/Identifier'
        links:
          type: array
          description: Additional links associated with this activity.
          nullable: true
          items:
            $ref: '#/components/schemas/Link'
        descriptions:
          type: array
          description: A collection of descriptions for the project. Query the /projects/allowed-description-types endpoint for allowed types.
          nullable: true
          items:
            $ref: '#/components/schemas/ClassifiedLocalizedValue'
        customDefinedFields:
          $ref: '#/components/schemas/CustomDefinedFields'
        type:
          $ref: '#/components/schemas/ClassificationRef'
        keywordGroups:
          type: array
          description: Groups of keywords associated with the ethical review.
          nullable: true
          items:
            $ref: '#/components/schemas/KeywordGroup'
        workflow:
          $ref: '#/components/schemas/Workflow'
        systemName:
          type: string
          description: The content system name
          readOnly: true
      description: An ethical review
    EthicalReviewQuery:
      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 ethical review
    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
    EthicalReviewAwardAssociation:
      required:
      - award
      type: object
      properties:
        award:
          $ref: '#/components/schemas/AwardRef'
      description: An association with an award
    UserRef:
      required:
      - uuid
      type: object
      description: A reference to an user
      nullable: true
      allOf:
      - $ref: '#/components/schemas/ContentRef'
    EthicalReviewListResult:
      type: object
      properties:
        count:
          type: integer
          description: The full count, ignoring paging
          format: int32
        pageInformation:
          $ref: '#/components/schemas/PageInformation'
        items:
          type: array
          description: EthicalReview
          items:
            $ref: '#/components/schemas/EthicalReview'
      description: List of ethical reviews. Can contain a subset of all items along with the full count
    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
    Link:
      required:
      - url
      type: object
      properties:
        pureId:
          type: integer
          description: Pure database ID of the object, prefer using the UUID if 

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