King Fahd University of Petroleum & Minerals award API

openapi: 3.0.1
info:
  title: Pure activity award API
  description: The Pure API provides a secure and complete web services API for using and managing research information data in Pure. The API enables a broad range of use-cases for interacting with research information, from anonymous Open Data scenarios to enabling the next generation Pure admin.
  termsOfService: ''
  contact:
    name: ''
    url: ''
    email: pure-support@elsevier.com
  license:
    name: ''
    url: ''
  version: 5.35.3-4
servers:
- url: https://pure.kfupm.edu.sa/ws/api
  description: KFUPM Elsevier Pure Web Services (authentication required)
security:
- api-key: []
tags:
- name: award
paths:
  /awards:
    get:
      tags:
      - award
      summary: Lists all awards
      description: Lists all awards in the Pure instance. If you need to filter the awards returned, see the POST version which supports additional filtering.
      operationId: award_list
      parameters:
      - name: size
        in: query
        description: Number of returned awards 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 award_getOrderings
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwardListResult'
    put:
      tags:
      - award
      summary: Create award
      description: Create award
      operationId: award_create
      requestBody:
        description: The content to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Award'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Award'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /awards/allowed-awardholder-roles:
    get:
      tags:
      - award
      summary: A list of allowed award holder roles
      description: Get a list of allowed roles for award holders on awards
      operationId: award_getAllowedAwardHolderRoles
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-budget-account-classifications:
    get:
      tags:
      - award
      summary: A list of allowed account classifications
      description: Get a list of allowed account classifications for award budgets
      operationId: award_getAllowedBudgetAccountClassifications
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-classified-identifier-types:
    get:
      tags:
      - award
      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 awards
      operationId: award_getAllowedClassifiedIdentifierTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-collaborator-types:
    get:
      tags:
      - award
      summary: A list of allowed collaborator types
      description: Get a list of allowed types for collaborators on awards
      operationId: award_getAllowedCollaboratorTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-custom-defined-field-values/{propertyName}/classifications:
    get:
      tags:
      - award
      summary: Get allowed classifications for the custom-defined field associated with the award
      description: Get allowed classifications for the custom-defined field associated with the award.
      operationId: award_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'
  /awards/allowed-description-types:
    get:
      tags:
      - award
      summary: A list of allowed description types
      description: Get a list of allowed types for descriptions on awards
      operationId: award_getAllowedDescriptionTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-document-licenses:
    get:
      tags:
      - award
      summary: A list of allowed document licenses
      description: Get a list of allowed document licenses for awards
      operationId: award_getAllowedDocumentLicenses
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-document-types:
    get:
      tags:
      - award
      summary: A list of allowed document types
      description: Get a list of allowed types for documents on awards
      operationId: award_getAllowedDocumentTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-document-version-types:
    get:
      tags:
      - award
      summary: A list of allowed document version types
      description: Get a list of allowed version types for documents on awards
      operationId: award_getAllowedDocumentVersionTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-funding-classifications:
    get:
      tags:
      - award
      summary: A list of allowed funding classifications
      description: Get a list of allowed funding classifications for fundings on awards
      operationId: award_getAllowedFundingClassifications
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-keyword-group-configurations:
    get:
      tags:
      - award
      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: award_getAllowedKeywordGroupConfigurations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
  /awards/allowed-keyword-group-configurations/{id}/classifications:
    get:
      tags:
      - award
      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: award_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'
  /awards/allowed-link-types:
    get:
      tags:
      - award
      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 awards
      operationId: award_getAllowedLinkTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-locales:
    get:
      tags:
      - award
      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: award_getAllowedLocales
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalesList'
  /awards/allowed-nature-types:
    get:
      tags:
      - award
      summary: A list of allowed nature types
      description: Get a list of allowed nature types for awards
      operationId: award_getAllowedNatureTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-templates:
    get:
      tags:
      - award
      summary: A list of allowed award templates
      description: Get a list of allowed templates that can be used for awards. Some of the templates that exists in the API specification may be disabled for the Pure installation.
      operationId: award_getAllowedTemplates
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedTemplateListResult'
  /awards/allowed-types:
    get:
      tags:
      - award
      summary: A list of allowed award types
      description: Get a list of allowed types that can be used for the 'type' attribute of awards
      operationId: award_getAllowedTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /awards/allowed-workflow-steps:
    get:
      tags:
      - award
      summary: A list of allowed workflow steps
      description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of awards
      operationId: award_getAllowedWorkflowSteps
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListResult'
  /awards/disciplines/allowed-discipline-schemes:
    get:
      tags:
      - award
      summary: A list of allowed discipline schemes
      description: Get a list fo a allowed discipline schemes for awards
      operationId: award_getAllowedDisciplineSchemes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
  /awards/disciplines/{discipline-scheme}/allowed-disciplines:
    get:
      tags:
      - award
      summary: A list of allowed disciplines for a specific discipline scheme
      description: Get a list of a allowed disciplines for specific discipline scheme for awards
      operationId: award_getAllowedDisciplines
      parameters:
      - name: discipline-scheme
        in: path
        description: Identifier for the discipline scheme for award
        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'
  /awards/disciplines/{discipline-scheme}/search:
    post:
      tags:
      - award
      summary: Query operation for disciplines associated with awards
      description: Lists disciplines from the discipline scheme associated with awards in the Pure instance that matches the provided query.
      operationId: award_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'
  /awards/file-uploads:
    put:
      tags:
      - award
      summary: Upload file to a specific award
      description: Uploads file for the award
      operationId: award_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'
  /awards/orderings:
    get:
      tags:
      - award
      summary: Lists available orderings
      description: Lists all orderings available to the award endpoint. These values can be used by the order parameter.
      operationId: award_getOrderings
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderingsList'
  /awards/search:
    post:
      tags:
      - award
      summary: Query operation for awards
      description: Lists awards 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: award_query
      requestBody:
        description: The query to perform
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwardsQuery'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwardListResult'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /awards/{uuid}:
    get:
      tags:
      - award
      summary: Get award
      description: Get award with specific UUID.
      operationId: award_get
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired award
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Award'
        '301':
          description: The requested content have changed UUID
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - award
      summary: Update award
      description: Update award with specific UUID.
      operationId: award_update
      parameters:
      - name: uuid
        in: path
        description: UUID of the award to update
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      requestBody:
        description: The content to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Award'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Award'
        '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:
      - award
      summary: Delete award
      description: Delete award with specific UUID.
      operationId: award_delete
      parameters:
      - name: uuid
        in: path
        description: UUID of the award
        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'
  /awards/{uuid}/actions/lock:
    post:
      tags:
      - award
      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: award_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'
  /awards/{uuid}/actions/unlock:
    post:
      tags:
      - award
      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: award_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'
  /awards/{uuid}/budgets:
    get:
      tags:
      - award
      summary: Get the budgets for the award
      description: Get the budgets for the award with the specified UUID.
      operationId: award_getBudgets
      parameters:
      - name: uuid
        in: path
        description: UUID of the award
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwardBudgetResult'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /awards/{uuid}/budgets/{id}:
    get:
      tags:
      - award
      summary: Get a specific budget for the award
      description: Get a specific budget for the award with the specified UUID.
      operationId: award_getBudget
      parameters:
      - name: uuid
        in: path
        description: UUID of the award
        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/AwardBudget'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - award
      summary: Update budget for an award
      description: Update budget for an award with specific UUID.
      operationId: award_updateBudget
      parameters:
      - name: uuid
        in: path
        description: UUID of the award 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/AwardBudget'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwardBudget'
        '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'
  /awards/{uuid}/cluster:
    get:
      tags:
      - award
      summary: Get the award cluster for the award
      description: Get the award cluster for the award with the specified UUID.
      operationId: award_getCluster
      parameters:
      - name: uuid
        in: path
        description: UUID of the award
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwardCluster'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /awards/{uuid}/dependents:
    get:
      tags:
      - award
      summary: Lists all dependents to an award
      description: 'Lists all dependents to an award with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
      operationId: award_dependents
      parameters:
      - name: uuid
        in: path
        description: UUID of the award
        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'
  /awards/{uuid}/disciplines/{discipline-scheme}:
    get:
      tags:
      - award
      summary: Get disciplines from the discipline scheme associated with the award
      description: Get disciplines from the discipline scheme associated with the award with specific UUID.
      operationId: award_getDisciplineAssociation
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired award
        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:
      - award
      summary: Update disciplines from the discipline scheme associated with the award
      description: Update disciplines from the discipline scheme associated with the award with specific UUID.
      operationId: award_putDisciplineAssociation
      parameters:
      - name: uuid
        in: path
        description: UUID of the award 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'
  /awards/{uuid}/files/{fileId}:
    get:
      tags:
      - award
      summary: Get file from the award
      description: Get file from the award
      operationId: award_getFile
      parameters:
      - name: uuid
        in: path
        description: UUID of the award
        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
  /awards/{uuid}/fingerprints:
    get:
      tags:
      - award
      summary: Get the fingerprints for the award
      description: Get the fingerprints for the award with the specified UUID.
      operationId: award_getFingerprints
      parameters:
      - name: uuid
        in: path
        description: UUID of the award
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FingerprintListResult'
        '403':
          description: Access to requested resource is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /awards/{uuid}/milestones:
    get:
      tags:
      - award
      summary: List award milestones on an award
      description: List award milestones on an award.
      operationId: award_getMilestones
      parameters:
      - name: uuid
        in: path
        description: UUID of the award
        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

# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kfupm/refs/heads/main/openapi/kfupm-award-api-openapi.yml