University of Bath externalOrganization API

openapi: 3.0.1
info:
  title: Pure activity externalOrganization 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: externalOrganization
paths:
  /external-organizations:
    get:
      tags:
      - externalOrganization
      summary: Lists all external organizations
      description: Lists all external organizations in the Pure instance. If you need to filter the external organizations returned, see the POST version which supports additional filtering.
      operationId: externalOrganization_list
      parameters:
      - name: size
        in: query
        description: Number of returned external organizations 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 /external-organizations/orderings
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalOrganizationListResult'
    put:
      tags:
      - externalOrganization
      summary: Create external organization
      description: Create external organization
      operationId: externalOrganization_create
      requestBody:
        description: The content to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalOrganization'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalOrganization'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /external-organizations/allowed-address-countries:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed address countries
      description: Get a list of allowed countries that can be used for the 'address.country' attribute of external organizations
      operationId: externalOrganization_getAllowedAddressCountries
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-address-subdivision:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed address subdivisions
      description: Get a list of allowed subdivisions that can be used for the 'address.subdivisions' attribute of external organizations
      operationId: externalOrganization_getAllowedAddressSubdivisions
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-classified-file-types:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed classified identifier types
      description: Get a list of allowed classified image types that can be used for the 'images.type' attribute of external organizations
      operationId: externalOrganization_getAllowedClassifiedImageTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-classified-identifier-types:
    get:
      tags:
      - externalOrganization
      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 external organizations
      operationId: externalOrganization_getAllowedClassifiedIdentifierTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-document-licenses:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed document licenses
      description: Get a list of allowed document licenses that can be used for the 'documents.license' attribute of external organizations
      operationId: externalOrganization_getAllowedDocumentLicenses
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-document-types:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed document types
      description: Get a list of allowed document types that can be used for the 'documents.type' attribute of external organizations
      operationId: externalOrganization_getAllowedDocumentTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-keyword-group-configurations:
    get:
      tags:
      - externalOrganization
      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: externalOrganization_getAllowedKeywordGroupConfigurations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
  /external-organizations/allowed-keyword-group-configurations/{id}/classifications:
    get:
      tags:
      - externalOrganization
      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: externalOrganization_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'
  /external-organizations/allowed-link-types:
    get:
      tags:
      - externalOrganization
      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 external organizations
      operationId: externalOrganization_getAllowedLinkTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-locales:
    get:
      tags:
      - externalOrganization
      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: externalOrganization_getAllowedLocales
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalesList'
  /external-organizations/allowed-nature-types:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed nature types
      description: Get a list of allowed nature types that can be used for the 'natureTypes' attribute of external organizations
      operationId: externalOrganization_getAllowedNatureTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-types:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed external organization types
      description: Get a list of allowed types that can be used for the 'type' attribute of external organizations
      operationId: externalOrganization_getAllowedTypes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /external-organizations/allowed-workflow-steps:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed workflow steps
      description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of external organizations
      operationId: externalOrganization_getAllowedWorkflowSteps
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListResult'
  /external-organizations/disciplines/allowed-discipline-schemes:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed discipline schemes
      description: Get a list fo a allowed discipline schemes for external organizations
      operationId: externalOrganization_getAllowedDisciplineSchemes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
  /external-organizations/disciplines/{discipline-scheme}/allowed-disciplines:
    get:
      tags:
      - externalOrganization
      summary: A list of allowed disciplines for a specific discipline scheme
      description: Get a list of a allowed disciplines for specific discipline scheme for external organizations
      operationId: externalOrganization_getAllowedDisciplines
      parameters:
      - name: discipline-scheme
        in: path
        description: Identifier for the discipline scheme for external organizations
        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'
  /external-organizations/disciplines/{discipline-scheme}/search:
    post:
      tags:
      - externalOrganization
      summary: Query operation for disciplines associated with external organizations
      description: Lists disciplines from the discipline scheme associated with external organizations in the Pure instance that matches the provided query.
      operationId: externalOrganization_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'
  /external-organizations/file-uploads:
    put:
      tags:
      - externalOrganization
      summary: Upload file to a specific external organization
      description: Uploads file for the external organization
      operationId: externalOrganization_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'
  /external-organizations/merge:
    post:
      tags:
      - externalOrganization
      summary: Merge external organizations
      description: Merge a list of external organizations together. Note that this operation is irreversible
      operationId: externalOrganization_merge
      requestBody:
        description: References to the entities to merge. The first will be the target. All additional entities will be merged into the target.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalOrganizationRefList'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalOrganization'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /external-organizations/orderings:
    get:
      tags:
      - externalOrganization
      summary: Lists available orderings
      description: Lists all orderings available to the external organization endpoint. These values can be used by the order parameter.
      operationId: externalOrganization_getOrderings
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderingsList'
  /external-organizations/preview-deduplication:
    post:
      tags:
      - externalOrganization
      summary: Preview deduplication of external organizations
      description: Runs through a list external organizations and returns the deduplicated and merged organizations. The operation does not touch the Pure database
      operationId: externalOrganization_previewDeduplication
      requestBody:
        description: The content to deduplicate. The data do not need to exist in the database.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalOrganizationList'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalOrganizationListResult'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /external-organizations/search:
    post:
      tags:
      - externalOrganization
      summary: Query operation for external organizations
      description: Lists external organizations 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: externalOrganization_query
      requestBody:
        description: The query to perform
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalOrganizationsQuery'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalOrganizationListResult'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /external-organizations/{uuid}:
    get:
      tags:
      - externalOrganization
      summary: Get external organization
      description: Get external organization with specific UUID.
      operationId: externalOrganization_get
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired external organization
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalOrganization'
        '301':
          description: The requested content have changed UUID
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - externalOrganization
      summary: Update external organization
      description: Update external organization with specific UUID.
      operationId: externalOrganization_update
      parameters:
      - name: uuid
        in: path
        description: UUID of the external organization to update
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      requestBody:
        description: The content to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalOrganization'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalOrganization'
        '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:
      - externalOrganization
      summary: Delete external organization
      description: Delete external organization with specific UUID.
      operationId: externalOrganization_delete
      parameters:
      - name: uuid
        in: path
        description: UUID of the external organization
        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'
  /external-organizations/{uuid}/actions/lock:
    post:
      tags:
      - externalOrganization
      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: externalOrganization_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'
  /external-organizations/{uuid}/actions/unlock:
    post:
      tags:
      - externalOrganization
      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: externalOrganization_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'
  /external-organizations/{uuid}/dependents:
    get:
      tags:
      - externalOrganization
      summary: Lists all dependents to the external organization
      description: 'Lists all dependents to the external organization with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. '
      operationId: externalOrganization_dependents
      parameters:
      - name: uuid
        in: path
        description: UUID of the external organization to update
        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'
  /external-organizations/{uuid}/disciplines/{discipline-scheme}:
    get:
      tags:
      - externalOrganization
      summary: Get disciplines from the discipline scheme associated with the external organization
      description: Get disciplines from the discipline scheme associated with the external organization with specific UUID.
      operationId: externalOrganization_getDisciplineAssociation
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired external organization
        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:
      - externalOrganization
      summary: Update disciplines from the discipline scheme associated with the external organization
      description: Update disciplines from the discipline scheme associated with the external organization with specific UUID.
      operationId: externalOrganization_putDisciplineAssociation
      parameters:
      - name: uuid
        in: path
        description: UUID of the external organization 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'
  /external-organizations/{uuid}/files/{fileId}:
    get:
      tags:
      - externalOrganization
      summary: Get file from the external organization
      description: Get file from the external organization
      operationId: externalOrganization_getFile
      parameters:
      - name: uuid
        in: path
        description: UUID of the external organization
        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
  /external-organizations/{uuid}/notes:
    get:
      tags:
      - externalOrganization
      summary: Lists notes
      description: Lists notes associated with an external organization ordered by date (nulls last)
      operationId: externalOrganization_listNotes
      parameters:
      - name: uuid
        in: path
        description: UUID of the external organization 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: External organization not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - externalOrganization
      summary: Create note
      description: Create note and associate it with an external organization
      operationId: externalOrganization_createNote
      parameters:
      - name: uuid
        in: path
        description: UUID of the external organization 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:
    DisciplinesAssociation:
      required:
      - disciplineAssignments
      type: object
      properties:
        content:
          $ref: '#/components/schemas/ContentRef'
        disciplineScheme:
          type: string
          description: The discipline scheme these disciplines are assigned from
          readOnly: true
        disciplineAssignments:
          type: array
          description: A collection of assigned disciplines
          items:
            $ref: '#/components/schemas/DisciplinesDisciplineAssignment'
      description: An association between a content and a number of discipline assignments
    Visibility:
      required:
      - key
      type: object
      properties:
        key:
          type: string
          description: Visibility value
          enum:
          - FREE
          - CAMPUS
          - BACKEND
          - CONFIDENTIAL
        description:
          $ref: '#/components/schemas/SystemLocalizedString'
      description: Visibility of an object
    ContentRef:
      required:
      - systemName
      - uuid
      type: object
      properties:
        uuid:
          type: string
          description: UUID of the referred content
          format: uuid
        systemName:
          type: string
      nullable: true
      discriminator:
        propertyName: systemName
        mapping:
          AccessDefinition: '#/components/schemas/AccessDefinitionRef'
          Activity: '#/components/schemas/ActivityRef'
          Application: '#/components/schemas/ApplicationRef'
          AuthorCollaboration: '#/components/schemas/AuthorCollaborationRef'
          Award: '#/components/schemas/AwardRef'
          ClassificationScheme: '#/components/schemas/ClassificationSchemeRef'
          ConferenceSeries: '#/components/schemas/ConferenceSeriesRef'
          DataSet: '#/components/schemas/DataSetRef'
          Equipment: '#/components/schemas/EquipmentRef'
          Event: '#/components/schemas/EventRef'
          ExternalOrganization: '#/components/schemas/ExternalOrganizationRef'
          ExternalPerson: '#/components/schemas/ExternalPersonRef'
          Impact: '#/components/schemas/ImpactRef'
          Journal: '#/components/schemas/JournalRef'
          Organization: '#/components/schemas/OrganizationRef'
          Person: '#/components/schemas/PersonRe

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