Queen's University at Kingston Access API

openapi: 3.0.3
info:
  title: Dataverse Access API
  description: Open source research data repository software.
  version: v6.8.1-SP
servers:
- url: https://borealisdata.ca/api
  description: Borealis (Canadian Dataverse Repository) hosting the Queen University Dataverse
tags:
- name: Access
paths:
  /access/datafile/bundle/{fileId}:
    get:
      operationId: Access_datafileBundle
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      - name: fileMetadataId
        in: query
        schema:
          format: int64
          type: integer
      - name: gbrecs
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/zip:
              schema:
                $ref: '#/components/schemas/BundleDownloadInstance'
      tags:
      - Access
  /access/datafile/{fileId}:
    get:
      operationId: Access_datafile
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          pattern: .+
          type: string
      - name: gbrecs
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{fileId}/auxiliary:
    get:
      operationId: Access_listDatafileMetadataAux
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}:
    get:
      operationId: Access_downloadAuxiliaryFile
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      - name: formatTag
        in: path
        required: true
        schema:
          type: string
      - name: formatVersion
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DownloadInstance'
      tags:
      - Access
    delete:
      operationId: Access_deleteAuxiliaryFileWithVersion
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: formatTag
        in: path
        required: true
        schema:
          type: string
      - name: formatVersion
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{fileId}/auxiliary/{origin}:
    get:
      operationId: Access_listDatafileMetadataAuxByOrigin
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      - name: origin
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{fileId}/metadata:
    get:
      operationId: Access_tabularDatafileMetadata
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      - name: exclude
        in: query
        schema:
          type: string
      - name: fileMetadataId
        in: query
        schema:
          format: int64
          type: integer
      - name: include
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/xml:
              schema:
                type: string
      tags:
      - Access
  /access/datafile/{fileId}/metadata/ddi:
    get:
      operationId: Access_tabularDatafileMetadataDDI
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      - name: exclude
        in: query
        schema:
          type: string
      - name: fileMetadataId
        in: query
        schema:
          format: int64
          type: integer
      - name: include
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/xml:
              schema:
                type: string
      tags:
      - Access
  /access/datafile/{id}/grantAccess/{identifier}:
    put:
      operationId: Access_grantFileAccess
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: identifier
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{id}/listRequests:
    get:
      operationId: Access_listFileAccessRequests
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{id}/rejectAccess/{identifier}:
    put:
      operationId: Access_rejectFileAccess
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: identifier
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{id}/requestAccess:
    put:
      operationId: Access_requestFileAccess
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{id}/revokeAccess/{identifier}:
    delete:
      operationId: Access_revokeFileAccess
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: identifier
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{id}/userFileAccessRequested:
    get:
      operationId: Access_getUserFileAccessRequested
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafile/{id}/userPermissions:
    get:
      operationId: Access_getUserPermissionsOnFile
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafiles:
    post:
      operationId: Access_postDownloadDatafiles
      parameters:
      - name: gbrecs
        in: query
        schema:
          type: boolean
      requestBody:
        content:
          text/plain:
            schema:
              type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/datafiles/{fileIds}:
    get:
      operationId: Access_datafiles
      parameters:
      - name: fileIds
        in: path
        required: true
        schema:
          type: string
      - name: gbrecs
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/dataset/{id}:
    get:
      operationId: Access_downloadAllFromLatest
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: gbrecs
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/dataset/{id}/versions/{versionId}:
    get:
      operationId: Access_downloadAllFromVersion
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: versionId
        in: path
        required: true
        schema:
          type: string
      - name: gbrecs
        in: query
        schema:
          type: boolean
      - name: key
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
  /access/dataverseFeaturedItemImage/{itemId}:
    get:
      operationId: Access_getDataverseFeatureItemImage
      parameters:
      - name: itemId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: OK
          content:
            image/png:
              schema:
                format: binary
                type: string
      tags:
      - Access
  /access/dsCardImage/{versionId}:
    get:
      operationId: Access_dsCardImage
      parameters:
      - name: versionId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: OK
          content:
            image/png:
              schema:
                format: binary
                type: string
      tags:
      - Access
  /access/dvCardImage/{dataverseId}:
    get:
      operationId: Access_dvCardImage
      parameters:
      - name: dataverseId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: OK
          content:
            image/png:
              schema:
                format: binary
                type: string
      tags:
      - Access
  /access/fileCardImage/{fileId}:
    get:
      operationId: Access_fileCardImage
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: OK
          content:
            image/png:
              schema:
                format: binary
                type: string
      tags:
      - Access
  /access/{id}/allowAccessRequest:
    put:
      operationId: Access_allowAccessRequest
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Access
components:
  schemas:
    DatasetLock:
      type: object
      properties:
        id:
          format: int64
          type: integer
        startTime:
          format: date
          type: string
          example: '2022-03-10'
        dataset:
          $ref: '#/components/schemas/Dataset'
        user:
          $ref: '#/components/schemas/AuthenticatedUser'
        reason:
          $ref: '#/components/schemas/Reason'
        info:
          type: string
    BuiltinUserServiceBean:
      type: object
      properties:
        indexService:
          $ref: '#/components/schemas/IndexServiceBean'
        passwordResetService:
          $ref: '#/components/schemas/PasswordResetServiceBean'
        em:
          type: object
    ExternalToolType:
      type: object
      properties:
        id:
          format: int64
          type: integer
        type:
          $ref: '#/components/schemas/Type2'
        externalTool:
          $ref: '#/components/schemas/ExternalTool'
    DatasetVersionUser:
      type: object
      properties:
        id:
          format: int64
          type: integer
        authenticatedUser:
          $ref: '#/components/schemas/AuthenticatedUser'
        datasetVersion:
          $ref: '#/components/schemas/DatasetVersion'
        lastUpdateDate:
          type: object
    DatasetExternalCitations:
      required:
      - dataset
      type: object
      properties:
        id:
          format: int64
          type: integer
        dataset:
          $ref: '#/components/schemas/Dataset'
        citedByUrl:
          type: string
    WorkflowStepSPI:
      type: object
    ClientHarvestRun:
      type: object
      properties:
        id:
          format: int64
          type: integer
        harvestingClient:
          $ref: '#/components/schemas/HarvestingClient'
        harvestResult:
          $ref: '#/components/schemas/RunResultType'
        startTime:
          format: date
          type: string
          example: '2022-03-10'
        finishTime:
          format: date
          type: string
          example: '2022-03-10'
        harvestedDatasetCount:
          format: int64
          type: integer
        failedDatasetCount:
          format: int64
          type: integer
        deletedDatasetCount:
          format: int64
          type: integer
        result:
          $ref: '#/components/schemas/RunResultType'
        resultLabel:
          type: string
        detailedResultLabel:
          type: string
        completed:
          type: boolean
        completedWithFailures:
          type: boolean
        failed:
          type: boolean
        inProgress:
          type: boolean
        interrupted:
          type: boolean
    Breadcrumb:
      type: object
      properties:
        breadcrumbText:
          type: string
        dvObject:
          $ref: '#/components/schemas/DvObject'
        url:
          type: string
        optionalUrlExtension:
          type: string
    DatasetFieldCompoundValue:
      type: object
      properties:
        id:
          format: int64
          type: integer
        displayOrder:
          format: int32
          type: integer
        parentDatasetField:
          $ref: '#/components/schemas/DatasetField'
        childDatasetFields:
          type: array
          items:
            $ref: '#/components/schemas/DatasetField'
        linkMap:
          type: object
          additionalProperties:
            type: boolean
        linkScheme:
          type: string
        linkValue:
          type: string
        displayValueMap:
          type: object
          additionalProperties:
            type: string
        link:
          type: string
        linkableField:
          type: boolean
        linkComponents:
          type: object
    VariableCategory:
      type: object
      properties:
        id:
          format: int64
          type: integer
        dataVariable:
          $ref: '#/components/schemas/DataVariable'
        value:
          type: string
        label:
          type: string
        missing:
          type: boolean
        catOrder:
          format: int32
          type: integer
        frequency:
          format: double
          type: number
        order:
          format: int32
          type: integer
    DataFileCategory:
      type: object
      properties:
        id:
          format: int64
          type: integer
        dataset:
          $ref: '#/components/schemas/Dataset'
        name:
          type: string
        fileMetadatas:
          type: array
          items:
            $ref: '#/components/schemas/FileMetadata'
    DataverseFieldTypeInputLevelServiceBean:
      type: object
      properties:
        em:
          type: object
    DataverseType:
      enum:
      - RESEARCHERS
      - RESEARCH_PROJECTS
      - JOURNALS
      - ORGANIZATIONS_INSTITUTIONS
      - TEACHING_COURSES
      - UNCATEGORIZED
      - LABORATORY
      - RESEARCH_GROUP
      - DEPARTMENT
      type: string
    DvObject:
      type: object
      properties:
        mergeable:
          type: boolean
        id:
          format: int64
          type: integer
        owner:
          $ref: '#/components/schemas/DvObject'
        publicationDate:
          type: object
        releaseUser:
          $ref: '#/components/schemas/AuthenticatedUser'
        createDate:
          type: object
        modificationTime:
          type: object
        indexTime:
          type: object
        permissionModificationTime:
          type: object
        permissionIndexTime:
          type: object
        storageIdentifier:
          type: string
        dtype:
          type: string
        dataverseFeaturedItems:
          type: array
          items:
            $ref: '#/components/schemas/DataverseFeaturedItem'
        protocol:
          type: string
        authority:
          type: string
        separator:
          type: string
        globalIdCreateTime:
          format: date
          type: string
          example: '2022-03-10'
        identifier:
          type: string
        identifierRegistered:
          type: boolean
        alternativePersistentIndentifiers:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/AlternativePersistentIdentifier'
        previewImageAvailable:
          type: boolean
        storageQuota:
          $ref: '#/components/schemas/StorageQuota'
        previewImageFail:
          type: boolean
        creator:
          $ref: '#/components/schemas/AuthenticatedUser'
        roleAssignments:
          type: array
          items:
            $ref: '#/components/schemas/RoleAssignment'
        effectivelyPermissionRoot:
          type: boolean
        released:
          type: boolean
        displayName:
          type: string
        currentName:
          type: string
        instanceofDataverse:
          type: boolean
        instanceofDataset:
          type: boolean
        instanceofDataFile:
          type: boolean
        dataverseContext:
          $ref: '#/components/schemas/Dataverse'
        authorString:
          type: string
        targetUrl:
          type: string
        yearPublishedCreated:
          type: string
    DatasetVersion:
      type: object
      properties:
        id:
          format: int64
          type: integer
        UNF:
          type: string
        version:
          format: int64
          type: integer
        versionNumber:
          format: int64
          type: integer
        minorVersionNumber:
          format: int64
          type: integer
        deaccessionNote:
          maxLength: 1000
          minLength: 0
          type: string
        versionNote:
          maxLength: 1000
          minLength: 0
          type: string
        versionState:
          $ref: '#/components/schemas/VersionState'
        dataset:
          $ref: '#/components/schemas/Dataset'
        fileMetadatas:
          type: array
          items:
            $ref: '#/components/schemas/FileMetadata'
        termsOfUseAndAccess:
          $ref: '#/components/schemas/TermsOfUseAndAccess'
        datasetFields:
          type: array
          items:
            $ref: '#/components/schemas/DatasetField'
        createTime:
          format: date
          type: string
          example: '2022-03-10'
        lastUpdateTime:
          format: date
          type: string
          example: '2022-03-10'
        releaseTime:
          format: date
          type: string
          example: '2022-03-10'
        archiveTime:
          format: date
          type: string
          example: '2022-03-10'
        archivalCopyLocation:
          type: string
        deaccessionLink:
          maxLength: 1260
          minLength: 0
          type: string
        contributorNames:
          type: string
        dataverseSiteUrl:
          type: string
        jsonLd:
          type: string
        datasetVersionUsers:
          type: array
          items:
            $ref: '#/components/schemas/DatasetVersionUser'
        workflowComments:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowComment'
        curationStatuses:
          type: array
          items:
            $ref: '#/components/schemas/CurationStatus'
        dvd:
          $ref: '#/components/schemas/DatasetVersionDifference'
        archivalStatus:
          type: object
        uNF:
          type: string
        fileMetadatasSorted:
          type: array
          items:
            $ref: '#/components/schemas/FileMetadata'
        fileMetadatasSortedByLabelAndFolder:
          type: array
          items:
            $ref: '#/components/schemas/FileMetadata'
        inReview:
          type: boolean
        archivalCopyLocationStatus:
          type: string
        archivalCopyLocationMessage:
          type: string
        deaccessionLinkAsURLString:
          type: string
        versionDate:
          type: string
        versionYear:
          type: string
        userDatasets:
          type: array
          items:
            $ref: '#/components/schemas/DatasetVersionUser'
        versionContributorIdentifiers:
          type: array
          items:
            type: string
        defaultVersionDifference:
          $ref: '#/components/schemas/DatasetVersionDifference'
        priorVersionState:
          $ref: '#/components/schemas/VersionState'
        friendlyVersionNumber:
          type: string
        released:
          type: boolean
        published:
          type: boolean
        draft:
          type: boolean
        workingCopy:
          type: boolean
        archived:
          type: boolean
        deaccessioned:
          type: boolean
        retiredCopy:
          type: boolean
        minorUpdate:
          type: boolean
        hasPackageFile:
          type: boolean
        hasNonPackageFile:
          type: boolean
        hasRestrictedFile:
          type: boolean
        mostRecentlyReleasedVersion:
          $ref: '#/components/schemas/DatasetVersion'
        largestMinorRelease:
          $ref: '#/components/schemas/DatasetVersion'
        latestVersion:
          type: boolean
        title:
          type: string
        productionDate:
          type: string
        description:
          type: string
        descriptions:
          type: array
          items:
            type: string
        descriptionPlainText:
          type: string
        descriptionsPlainTextTruncated:
          type: string
        descriptionHtmlEscaped:
          type: string
        datasetContacts:
          type: array
          items: {}
        datasetProducers:
          type: array
          items: {}
        datasetAuthors:
          type: array
          items:
            $ref: '#/components/schemas/DatasetAuthor'
        funders:
          type: array
          items:
            type: string
        timePeriodsCovered:
          type: array
          items:
            type: string
        datesOfCollection:
          type: array
          items:
            type: string
        datasetAuthorNames:
          type: array
          items:
            type: string
        datasetSubjects:
          type: array
          items:
            type: string
        topicClassifications:
          type: array
          items:
            type: string
        kindOfData:
          type: array
          items:
            type: string
        languages:
          type: array
          items:
            type: string
        spatialCoverages:
          type: array
          items:
            type: string
        keywords:
          type: array
          items:
            type: string
        relatedMaterial:
          type: array
          items:
            type: string
        dataSource:
          type: array
          items:
            type: string
        geographicCoverage:
          type: array
          items: {}
        relatedPublications:
          type: array
          items:
            $ref: '#/components/schemas/DatasetRelPublication'
        uniqueGrantAgencyValues:
          type: array
          items:
            type: string
        seriesTitles:
          type: array
          items:
            type: string
        datasetProducerNames:
          type: array
          items:
            type: string
        citation:
          type: string
        citationDate:
          format: date
          type: string
          example: '2022-03-10'
        distributionDate:
          type: string
        distributorName:
          type: string
        datasetDistributors:
          type: array
          items:
            $ref: '#/components/schemas/DatasetDistributor'
        distributorNames:
          type: string
        authorsStr:
          type: string
        flatDatasetFields:
          type: array
          items:
            $ref: '#/components/schemas/DatasetField'
        semanticVersion:
          type: string
        valid:
          type: boolean
        publicationDateAsString:
          type: string
        localeLastUpdateTime:
          type: string
        currentCurationStatus:
          $ref: '#/components/schemas/CurationStatus'
    IndexServiceBean:
      type: object
      properties:
        em:
          type: object
        dvObjectService:
          $ref: '#/components/schemas/DvObjectServiceBean'
        dataverseService:
          $ref: '#/components/schemas/DataverseServiceBean'
        datasetService:
          $ref: '#/components/schemas/DatasetServiceBean'
        datasetVersionService:
          $ref: '#/components/schemas/DatasetVersionServiceBean'
        dataverseUserServiceBean:
          $ref: '#/components/schemas/BuiltinUserServiceBean'
        permissionService:
          $ref: '#/components/schemas/PermissionServiceBean'
        userServiceBean:
          $ref: '#/components/schemas/AuthenticationServiceBean'
        systemConfig:
          $ref: '#/components/schemas/SystemConfig'
        searchPermissionsService:
          $ref: '#/components/schemas/SearchPermissionsServiceBean'
        solrIndexService:
          $ref: '#/components/schemas/SolrIndexServiceBean'
        dsLinkingService:
          $ref: '#/components/schemas/DatasetLinkingServiceBean'
        dvLinkingService:
          $ref: '#/components/schemas/DataverseLinkingServiceBean'
        settingsService:
          $ref: '#/components/schemas/SettingsServiceBean'
        solrClientService:
          $ref: '#/components/schemas/SolrClientService'
        solrClientIndexService:
          $ref: '#/components/schemas/SolrClientIndexService'
        dataFileService:
          $ref: '#/components/schemas/DataFileServiceBean'
        datasetFieldService:
          $ref: '#/components/schemas/DatasetFieldServiceBean'
        datasetVersionFilesServiceBean:
          $ref: '#/components/schemas/DatasetVersionFilesServiceBean'
        rootDataverseCached:
          $ref: '#/components/schemas/Dataverse'
        variableMetadataUtil:
          $ref: '#/components/schemas/VariableMetadataUtil'
        indexPermitWaitTimer:
          type: object
        indexTimer:
          type: object
    OptionalAccessService:
      type: object
      properties:
        serviceName:
          type: string
        serviceDescription:
          type: string
        contentMimeType:
          type: string
        serviceArguments:
          type: string
        mimeType:
          type: string
    StorageQuota:
      type: object
      properties:
        id:
          format: int64
          type: integer
        definitionPoint:
          $ref: '#/components/schemas/DvObject'
        allocation:
          format: int64
          type: integer
    StorageUseServiceBean:
      type: object
      properties:
        em:
          type: object
    DvObjectServiceBean:
      type: object
      properties:
        em:
          type: object
        pidProviderFactoryBean:
          $ref: '#/components/schemas/PidProviderFactoryBean'
        allHarvestedDataverseIds:
          type: array
          items:
            format: int64
            type: integer
    DataverseFacet:
      type: object
      properties:
        id:
          format: int64
          type: integer
        dataverse:
          $ref: '#/components/schemas/Dataverse'
        datasetFieldType:
          $ref: '#/components/schemas/DatasetFieldType'
        displayOrder:
          format: int32
          type: integer
    UserNotificationServiceBean:
      type: object
      properties:
        mailService:
          $ref: '#/components/schemas/MailServiceBean'
        em:
          type: object
        settingsService:
          $ref: '#/components/schemas/SettingsServiceBean'
    CustomQuestion:
      required:
      - questionString
      type: object
      properties:
        id:
          format: int64
          type: integer
        guestbook:
          $ref: '#/components/schemas/Guestbook'
        customQuestionResponses:
          type: array
          items:
            $ref: '#/components/schemas/CustomQuestionResponse'
        customQuestionValues:
          type: array
          items:
            $ref: '#/components/schemas/CustomQuestionValue'
        questionType:
          type: string
        questionString:
          pattern: \S
          type: string
        required:
          type: boolean
        hidden:
          type: boolean
        displayOrder:
          format: int32
          type: integer
        customQuestionValueString:
          type: string
    VariableRangeItem:
      type: object
      properties:
        id:
          format: int64
          type: integer
        value:
          type: number
        dataVariable:
          $ref: '#/components/schemas/DataVariable'
    OIDCAuthProvider:
      type: object
      properties:
        passwordUpdateAllowed:
          type: boolean
        userDeletionAllowed:
          type: boolean
        emailVerified:
          type: boolean
        friendlyName:
          type: string
        subTitle:
          type: string
        clientId:
          type: string
        clientSecret:
          type: string
        baseUserEndpoint:
          type: string
        redirectUrl:
          type: string
        userInfoUpdateAllowed:
          type: boolean
        info:
          $ref: '#/components/schemas/AuthenticationProviderDisplayInfo'
        order:
          format: int32
          type: integer
        iconHtml:
          type: string
          nullable: true
        spacedScope:
          type: string
        oAuthProvider:
          type: boolean
        id:
          type: string
        title:
          type: string
        scope:
          type: array
          items:
            type: string
        issuer:
          type: object
        clientAuth:
          type: object
        idpMetadata:
          type: object
        pkceEnabled:
          type: boolean
        pkceMethod:
          type: object
        verifierCache:
          type: object
        metadata:
          type: object
        apiInstance:
          type: object
    UserNotification:
      type: object
      properties:
        id:
          format: int64
          type: integer
        user:
          $ref: '#/components/schemas/AuthenticatedUser'
        requestor:
          $ref: '#/components/schemas/AuthenticatedUser'
        sendDate:
          type: object
        readNotification:
          type: boolean
        type:
          $ref: '#/components/schemas/Type'
        objectId:
          format: int64
          type: integer
        additionalInfo:
          type: string
        displayAsRead:
          type: boolean
        roleString:
          type: string
        emailed:
          type: boolean
        theObject: {}
        sendDateTimestamp:
          type: object
        localeSendDate:
          type: string
    SearchService:
      type: object
      properties:
        serviceName:
          type: string
        displayName:
          type: string
        solrSearchService:
          $ref: '#/components/schemas/SearchService'
    DifferenceSummaryItem:
      type: object
      properties:
        displayName:
          type: string
        changed:
          format: int32
          type: integer
        added:
          format: int32
          type: integer
        deleted:
          format: int32
          type: integer
        replaced:
          format: int32
          type: integer
        multiple:
          type: boolean
    SolrClientIndexService:
      type: object
      properties:
        systemConfig:
          $ref: '#/components/schemas/SystemConfig'
        solrUrl:
          type: string
        solrClient:
          type: object
    FileDifferenceSummaryGroup:
      type: object
      properties:
        name:
          type: string
        fileDifferenceSummaryItems:
          type: array
          items:
            $ref: '#/components/schemas/FileDifferenceSummaryItem'
    IndexBatchServiceBean:
      type: object
      properties:


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