Hong Kong Baptist University project API

openapi: 3.0.1
info:
  title: Pure activity project API
  description: The Pure API provides a secure and complete web services API for using and managing research information data in Pure. The API enables a broad range of use-cases for interacting with research information, from anonymous Open Data scenarios to enabling the next generation Pure admin.
  termsOfService: ''
  contact:
    name: ''
    url: ''
    email: pure-support@elsevier.com
  license:
    name: ''
    url: ''
  version: 5.35.0
servers:
- url: https://scholars.hkbu.edu.hk/ws/api
security:
- api-key: []
tags:
- name: project
paths:
  /projects:
    get:
      tags:
      - project
      summary: Lists all projects
      description: Lists all projects in the Pure instance. If you need to filter the projects returned, see the POST version which supports additional filtering.
      operationId: project_list_1
      parameters:
      - name: size
        in: query
        description: Number of returned 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 project_getOrderings
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListResult'
    put:
      tags:
      - project
      summary: Create project
      description: Create project
      operationId: project_create_1
      requestBody:
        description: The content to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Project'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /projects/allowed-classified-identifier-types:
    get:
      tags:
      - project
      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 projects
      operationId: project_getAllowedClassifiedIdentifierTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-collaborator-types:
    get:
      tags:
      - project
      summary: A list of allowed collaborator types
      description: Get a list of allowed types for collaborators on projects
      operationId: project_getAllowedCollaboratorTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-custom-defined-field-values/{propertyName}/classifications:
    get:
      tags:
      - project
      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: project_getAllowedCustomDefinedFieldClassifications_1
      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'
  /projects/allowed-description-types:
    get:
      tags:
      - project
      summary: A list of allowed description types
      description: Get a list of allowed types for descriptions on projects
      operationId: project_getAllowedDescriptionTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-document-licenses:
    get:
      tags:
      - project
      summary: A list of allowed document licenses
      description: Get a list of allowed document licenses for projects
      operationId: project_getAllowedDocumentLicenses_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-document-types:
    get:
      tags:
      - project
      summary: A list of allowed document types
      description: Get a list of allowed types for documents on projects
      operationId: project_getAllowedDocumentTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-image-types:
    get:
      tags:
      - project
      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 projects
      operationId: project_getAllowedImageTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-keyword-group-configurations:
    get:
      tags:
      - project
      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: project_getAllowedKeywordGroupConfigurations_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
  /projects/allowed-keyword-group-configurations/{id}/classifications:
    get:
      tags:
      - project
      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: project_getAllowedKeywordGroupConfigurationClassifications_1
      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'
  /projects/allowed-link-types:
    get:
      tags:
      - project
      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 projects
      operationId: project_getAllowedLinkTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-locales:
    get:
      tags:
      - project
      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: project_getAllowedLocales_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalesList'
  /projects/allowed-nature-types:
    get:
      tags:
      - project
      summary: A list of allowed nature types
      description: Get a list of allowed nature types for projects
      operationId: project_getAllowedNatureTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-participant-roles:
    get:
      tags:
      - project
      summary: A list of allowed participant roles
      description: Get a list of allowed roles for participant on projects
      operationId: project_getAllowedParticipantRoles_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-project-relation-types:
    get:
      tags:
      - project
      summary: A list of allowed project relation types
      description: Get a list of allowed project relation types on projects
      operationId: project_getAllowedProjectRelationTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-templates:
    get:
      tags:
      - project
      summary: A list of allowed project templates
      description: Get a list of allowed templates that can be used for projects. Some of the templates that exists in the API specification may be disabled for the Pure installation.
      operationId: project_getAllowedTemplates_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedTemplateListResult'
  /projects/allowed-types:
    get:
      tags:
      - project
      summary: A list of allowed project types
      description: Get a list of allowed types that can be used for the 'type' attribute of projects
      operationId: project_getAllowedTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /projects/allowed-workflow-steps:
    get:
      tags:
      - project
      summary: A list of allowed workflow steps
      description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of projects
      operationId: project_getAllowedWorkflowSteps_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListResult'
  /projects/disciplines/allowed-discipline-schemes:
    get:
      tags:
      - project
      summary: A list of allowed discipline schemes
      description: Get a list fo a allowed discipline schemes for projects
      operationId: project_getAllowedDisciplineSchemes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
  /projects/disciplines/{discipline-scheme}/allowed-disciplines:
    get:
      tags:
      - project
      summary: A list of allowed disciplines for a specific discipline scheme
      description: Get a list of a allowed disciplines for specific discipline scheme for projects
      operationId: project_getAllowedDisciplines_1
      parameters:
      - name: discipline-scheme
        in: path
        description: Identifier for the discipline scheme for project
        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'
  /projects/disciplines/{discipline-scheme}/search:
    post:
      tags:
      - project
      summary: Query operation for disciplines associated with projects
      description: Lists disciplines from the discipline scheme associated with projects in the Pure instance that matches the provided query.
      operationId: project_listDisciplineAssociations_1
      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'
  /projects/file-uploads:
    put:
      tags:
      - project
      summary: Upload file to a specific project
      description: Uploads file for the project
      operationId: project_fileUploads_1
      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'
  /projects/orderings:
    get:
      tags:
      - project
      summary: Lists available orderings
      description: Lists all orderings available to the project endpoint. These values can be used by the order parameter.
      operationId: project_getOrderings_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderingsList'
  /projects/search:
    post:
      tags:
      - project
      summary: Query operation for projects
      description: Lists 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: project_query_1
      requestBody:
        description: The query to perform
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectsQuery'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListResult'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /projects/{uuid}:
    get:
      tags:
      - project
      summary: Get project
      description: Get project with specific UUID.
      operationId: project_get_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired project
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '301':
          description: The requested content have changed UUID
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - project
      summary: Update project
      description: Update project with specific UUID.
      operationId: project_update_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the project to update
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      requestBody:
        description: The content to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Project'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '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:
      - project
      summary: Delete project
      description: Delete project with specific UUID.
      operationId: project_delete_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the 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'
  /projects/{uuid}/actions/lock:
    post:
      tags:
      - project
      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: project_lock_1
      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'
  /projects/{uuid}/actions/unlock:
    post:
      tags:
      - project
      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: project_unlock_1
      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'
  /projects/{uuid}/application-clusters:
    get:
      tags:
      - project
      summary: Get the application clusters for the project
      description: Get the application clusters for the project with the specified UUID.
      operationId: project_getApplicationClusters_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the project
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationClusterListResult'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /projects/{uuid}/award-clusters:
    get:
      tags:
      - project
      summary: Get the award clusters for the project
      description: Get the award clusters for the project with the specified UUID.
      operationId: project_getAwardClusters_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the project
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwardClusterListResult'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /projects/{uuid}/dependents:
    get:
      tags:
      - project
      summary: Lists all dependents to an project
      description: 'Lists all dependents to an 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: project_dependents_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the project
        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'
  /projects/{uuid}/disciplines/{discipline-scheme}:
    get:
      tags:
      - project
      summary: Get disciplines from the discipline scheme associated with the project
      description: Get disciplines from the discipline scheme associated with the project with specific UUID.
      operationId: project_getDisciplineAssociation_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired project
        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:
      - project
      summary: Update disciplines from the discipline scheme associated with the project
      description: Update disciplines from the discipline scheme associated with the project with specific UUID.
      operationId: project_putDisciplineAssociation_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the project 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'
  /projects/{uuid}/files/{fileId}:
    get:
      tags:
      - project
      summary: Get file from the project
      description: Get file from the project
      operationId: project_getFile_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the 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
  /projects/{uuid}/notes:
    get:
      tags:
      - project
      summary: Lists notes
      description: Lists notes associated with an project ordered by date (nulls last)
      operationId: project_listNotes_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the 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: Project not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - project
      summary: Create note
      description: Create note and associate it with the project
      operationId: project_createNote_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the 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:
    ApplicationRef:
      required:
      - uuid
      type: object
      description: A reference to an application
      nullable: true
      allOf:
      - $ref: '#/components/schemas/ContentRef'
    DataSetAwardableAssociation:
      required:
      - dataSet
      type: object
      properties:
        award:
          $ref: '#/components/schemas/AwardRef'
        dataSet:
          $ref: '#/components/schemas/DataSetRef'
      description: A relation to a dataset, optionally in the context of the Award that made it possible.
    ProjectRef:
      required:
      - uuid
      type: object
      description: A reference to project
      nullable: true
      allOf:
      - $ref: '#/components/schemas/ContentRef'
    ClassificationRef:
      required:
      - uri
      type: object
      properties:
        uri:
          type: string
          description: Classification URI of the referred classification
        term:
          $ref: '#/components/schemas/SystemLocalizedString'
      description: A reference to a classification value
      nullable: true
    PrizeAwardableAssociation:
      required:
      - prize
      type: object
      properties:
        award:
          $ref: '#/components/schemas/AwardRef'
        prize:
          $ref: '#/components/schemas/PrizeRef'
      description: A relation to a prize, optionally in the context of the Award that made it possible.
    ExternalOrganizationRef:
      required:
      - uuid
      type: object
      description: A reference to an organization external to the institution
      nullable: true
      allOf:
      - $ref: '#/components/schemas/ContentRef'
    EquipmentAwardableAssociation:
      required:
      - equipment
      type: object
      properties:
        award:
          $ref: '#/components/schemas/AwardRef'
        equipment:
          $ref: '#/components/schemas/EquipmentRef'
      description: A relation to an equipment, optionally in the context of the Award that made it possible.
    DisciplinesAssociationsQuery:
      type: object
      properties:
        uuids:
          type: array
          items:
            type: string
            format: uuid
        size:
          type: integer
          format: int32
        offset:
          

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hong-kong-baptist-university/refs/heads/main/openapi/hong-kong-baptist-university-project-api-openapi.yml