University of Bath application API

openapi: 3.0.1
info:
  title: Pure activity application 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.33.3-3
servers:
- url: /ws/api
security:
- api-key: []
tags:
- name: application
paths:
  /applications:
    get:
      tags:
      - application
      summary: Lists all applications
      description: Lists all applications in the Pure instance. If you need to filter the applications returned, see the POST version which supports additional filtering.
      operationId: application_list
      parameters:
      - name: size
        in: query
        description: Number of returned applications 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 application_getOrderings
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationListResult'
    put:
      tags:
      - application
      summary: Create application
      description: Create application
      operationId: application_create
      requestBody:
        description: The content to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Application'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /applications/allowed-applicant-roles:
    get:
      tags:
      - application
      summary: A list of allowed applicant roles
      description: Get a list of allowed applicant roles on applications
      operationId: application_getAllowedApplicantRoles
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-application-statuses:
    get:
      tags:
      - application
      summary: A list of allowed application statuses
      description: Get a list of allowed application statuses that can be used for the 'applicationStatuses.status' attribute of applications
      operationId: application_getAllowedApplicationStatuses
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-budget-account-classifications:
    get:
      tags:
      - application
      summary: A list of allowed account classifications
      description: Get a list of allowed account classifications for application budgets
      operationId: application_getAllowedBudgetAccountClassifications
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-classified-identifier-types:
    get:
      tags:
      - application
      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 applications
      operationId: application_getAllowedClassifiedIdentifierTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-collaborator-types:
    get:
      tags:
      - application
      summary: A list of allowed collaborators types
      description: Get a list of allowed collaborator types on applications
      operationId: application_getAllowedCollaboratorTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-custom-defined-field-values/{propertyName}/classifications:
    get:
      tags:
      - application
      summary: Get allowed classifications for the custom-defined field associated with the application
      description: Get allowed classifications for the custom-defined field associated with the application.
      operationId: application_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'
  /applications/allowed-description-types:
    get:
      tags:
      - application
      summary: A list of allowed description types
      description: Get a list of allowed description types on applications
      operationId: application_getAllowedDescriptionTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-document-licenses:
    get:
      tags:
      - application
      summary: A list of allowed document licenses
      description: Get a list of allowed document licenses for applications
      operationId: application_getAllowedDocumentLicenses
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-document-types:
    get:
      tags:
      - application
      summary: A list of allowed document types
      description: Get a list of allowed document types on applications
      operationId: application_getAllowedDocumentTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-document-version-types:
    get:
      tags:
      - application
      summary: A list of allowed document version types
      description: Get a list of allowed document version types for applications
      operationId: application_getAllowedDocumentVersionTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-funding-classifications:
    get:
      tags:
      - application
      summary: A list of allowed fundings classifications
      description: Get a list of allowed funding classifications for fundings on applications
      operationId: application_getAllowedFundingClassifications
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-keyword-group-configurations:
    get:
      tags:
      - application
      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: application_getAllowedKeywordGroupConfigurations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
  /applications/allowed-keyword-group-configurations/{id}/classifications:
    get:
      tags:
      - application
      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: application_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'
  /applications/allowed-link-types:
    get:
      tags:
      - application
      summary: A list of allowed link types
      description: Get a list of allowed link types for applications
      operationId: application_getAllowedLinkTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-locales:
    get:
      tags:
      - application
      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: application_getAllowedLocales
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalesList'
  /applications/allowed-nature-types:
    get:
      tags:
      - application
      summary: A list of allowed nature types
      description: Get a list of allowed nature types for applications
      operationId: application_getAllowedNatureTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-templates:
    get:
      tags:
      - application
      summary: A list of allowed application templates
      description: Get a list of allowed templates that can be used for applications. Some of the templates that exists in the API specification may be disabled for the Pure installation.
      operationId: application_getAllowedTemplates
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedTemplateListResult'
  /applications/allowed-types:
    get:
      tags:
      - application
      summary: A list of allowed application types
      description: Get a list of allowed types that can be used for the 'type' attribute of applications
      operationId: application_getAllowedTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /applications/allowed-workflow-steps:
    get:
      tags:
      - application
      summary: A list of allowed workflow steps
      description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of applications
      operationId: application_getAllowedWorkflowSteps
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListResult'
  /applications/disciplines/allowed-discipline-schemes:
    get:
      tags:
      - application
      summary: A list of allowed discipline schemes
      description: Get a list fo a allowed discipline schemes for applications
      operationId: application_getAllowedDisciplineSchemes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
  /applications/disciplines/{discipline-scheme}/allowed-disciplines:
    get:
      tags:
      - application
      summary: A list of allowed disciplines for a specific discipline scheme
      description: Get a list of a allowed disciplines for specific discipline scheme for applications
      operationId: application_getAllowedDisciplines
      parameters:
      - name: discipline-scheme
        in: path
        description: Identifier for the discipline scheme for application
        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'
  /applications/disciplines/{discipline-scheme}/search:
    post:
      tags:
      - application
      summary: Query operation for disciplines associated with applications
      description: Lists disciplines from the discipline scheme associated with applications in the Pure instance that matches the provided query.
      operationId: application_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'
  /applications/file-uploads:
    put:
      tags:
      - application
      summary: Upload file to a specific application
      description: Uploads file for the application
      operationId: application_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'
  /applications/orderings:
    get:
      tags:
      - application
      summary: Lists available orderings
      description: Lists all orderings available to the application endpoint. These values can be used by the order parameter.
      operationId: application_getOrderings
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderingsList'
  /applications/search:
    post:
      tags:
      - application
      summary: Query operation for applications
      description: Lists applications 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: application_query
      requestBody:
        description: The query to perform
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationsQuery'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationListResult'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /applications/{uuid}:
    get:
      tags:
      - application
      summary: Get application
      description: Get application with specific UUID.
      operationId: application_get
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired application
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '301':
          description: The requested content have changed UUID
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - application
      summary: Update application
      description: Update application with specific UUID.
      operationId: application_update
      parameters:
      - name: uuid
        in: path
        description: UUID of the application to update
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      requestBody:
        description: The content to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Application'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '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:
      - application
      summary: Delete application
      description: Delete application with specific UUID.
      operationId: application_delete
      parameters:
      - name: uuid
        in: path
        description: UUID of the application
        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'
  /applications/{uuid}/actions/lock:
    post:
      tags:
      - application
      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: application_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'
  /applications/{uuid}/actions/unlock:
    post:
      tags:
      - application
      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: application_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'
  /applications/{uuid}/budgets:
    get:
      tags:
      - application
      summary: Get the budgets for the application
      description: Get the budgets for the application with the specified UUID.
      operationId: application_getBudgets
      parameters:
      - name: uuid
        in: path
        description: UUID of the application
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationBudgetResult'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /applications/{uuid}/budgets/{id}:
    get:
      tags:
      - application
      summary: Get a specific budget for the application
      description: Get a specific budget for the application with the specified UUID.
      operationId: application_getBudget
      parameters:
      - name: uuid
        in: path
        description: UUID of the application
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      - name: id
        in: path
        description: ID of the budget
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationBudget'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - application
      summary: Update budget for an application
      description: Update budget for an application with specific UUID.
      operationId: application_updateBudget
      parameters:
      - name: uuid
        in: path
        description: UUID of the application with the budget
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      - name: id
        in: path
        description: ID of the budget to update
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: The content to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationBudget'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationBudget'
        '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'
  /applications/{uuid}/cluster:
    get:
      tags:
      - application
      summary: Get the application cluster for the application
      description: Get the application cluster for the application with the specified UUID.
      operationId: application_getCluster
      parameters:
      - name: uuid
        in: path
        description: UUID of the application
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationCluster'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /applications/{uuid}/dependents:
    get:
      tags:
      - application
      summary: Lists all dependents to an application
      description: 'Lists all dependents to an application with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
      operationId: application_dependents
      parameters:
      - name: uuid
        in: path
        description: UUID of the application
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      - name: verbose
        in: query
        description: 'Default: false. Setting this to true will add links and names to the output but will also have an impact on performance. Use with caution.'
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentRefListResult'
  /applications/{uuid}/disciplines/{discipline-scheme}:
    get:
      tags:
      - application
      summary: Get disciplines from the discipline scheme associated with the application
      description: Get disciplines from the discipline scheme associated with the application with specific UUID.
      operationId: application_getDisciplineAssociation
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired application
        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:
      - application
      summary: Update disciplines from the discipline scheme associated with the application
      description: Update disciplines from the discipline scheme associated with the application with specific UUID.
      operationId: application_putDisciplineAssociation
      parameters:
      - name: uuid
        in: path
        description: UUID of the application 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'
  /applications/{uuid}/files/{fileId}:
    get:
      tags:
      - application
      summary: Get file from the application
      description: Get file from the application
      operationId: application_getFile
      parameters:
      - name: uuid
        in: path
        description: UUID of the application
        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
  /applications/{uuid}/notes:
    get:
      tags:
      - application
      summary: Lists notes
      description: Lists notes associated with an application ordered by date (nulls last)
      operationId: application_listNotes
      parameters:
      - name: uuid
        in: path
        description: UU

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-bath/refs/heads/main/openapi/university-of-bath-application-api-openapi.yml