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: em: type: object indexService: $ref: '#/components/schemas/IndexServiceBean' solrIndexService: $ref: '#/components/schemas/SolrIndexServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' datasetService: $ref: '#/components/schemas/DatasetServiceBean' dvObjectService: $ref: '#/components/schemas/DvObjectServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' contentInDatabaseButStaleInOrMissingFromSolr: type: object contentInSolrButNotDatabase: type: object permissionsInDatabaseButStaleInOrMissingFromSolr: type: object permissionsInSolrButNotDatabase: type: object AuxiliaryFile: type: object properties: id: format: int64 type: integer dataFile: $ref: '#/components/schemas/DataFile' formatTag: type: string formatVersion: type: string origin: type: string isPublic: type: boolean contentType: type: string fileSize: format: int64 type: integer checksum: type: string type: type: string typeFriendly: type: string Dataverse: required: - dataverseType type: object properties: mergeable: type: boolean id: format: int64 type: integer 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' released: type: boolean instanceofDataverse: type: boolean instanceofDataset: type: boolean instanceofDataFile: type: boolean dataverseContext: $ref: '#/components/schemas/Dataverse' authorString: type: string targetUrl: type: string yearPublishedCreated: type: string storageDriver: type: string metadataLanguage: type: string guestbookAtRequest: type: boolean pidGeneratorSpecs: type: string pidGenerator: $ref: '#/components/schemas/PidProvider' storageUse: $ref: '#/components/schemas/StorageUse' datasetFileCountLimit: format: int32 type: integer externalLabelSetName: type: string owner: $ref: '#/components/schemas/Dataverse' effectivelyPermissionRoot: type: boolean effectiveStorageDriverId: type: string storageDriverId: type: string effectiveMetadataLanguage: type: string effectiveGuestbookEntryAtRequest: type: boolean guestbookEntryAtRequest: type: string effectiveCurationLabelSetName: type: string curationLabelSetName: type: string pidGeneratorId: type: string effectivePidGenerator: $ref: '#/components/schemas/PidProvider' effectiveDatasetFileCountLimit: format: int32 type: integer name: type: string alias: maxLength: 60 type: string description: type: string dataverseType: $ref: '#/components/schemas/DataverseType' permissionRoot: type: boolean affiliation: type: string roles: uniqueItems: true type: array items: $ref: '#/components/schemas/DataverseRole' defaultContributorRole: $ref: '#/components/schemas/DataverseRole' metadataBlockRoot: type: boolean facetRoot: type: boolean themeRoot: type: boolean templateRoot: type: boolean dataverseTheme: $ref: '#/components/schemas/DataverseTheme' dataverseContacts: type: array items: $ref: '#/components/schemas/DataverseContact' metadataBlocks: type: array items: $ref: '#/components/schemas/MetadataBlock' dataverseFacets: type: array items: $ref: '#/components/schemas/DataverseFacet' citationDatasetFieldTypes: type: array items: $ref: '#/components/schemas/DatasetFieldType' dataverseSubjects: uniqueItems: true type: array items: $ref: '#/components/schemas/ControlledVocabularyValue' dataverseFeaturedDataverses: type: array items: $ref: '#/components/schemas/DataverseFeaturedDataverse' dataverseFeaturingDataverses: type: array items: $ref: '#/components/schemas/DataverseFeaturedDataverse' dataverseLinkingDataverses: type: array items: $ref: '#/components/schemas/DataverseLinkingDataverse' dataverseLinkedDataverses: type: array items: $ref: '#/components/schemas/DataverseLinkingDataverse' datasetLinkingDataverses: type: array items: $ref: '#/components/schemas/DatasetLinkingDataverse' dataverseFieldTypeInputLevels: type: array items: $ref: '#/components/schemas/DataverseFieldTypeInputLevel' defaultTemplate: $ref: '#/components/schemas/Template' savedSearches: type: array items: $ref: '#/components/schemas/SavedSearch' templates: type: array items: $ref: '#/components/schemas/Template' guestbooks: type: array items: $ref: '#/components/schemas/Guestbook' harvestingClientConfigs: type: array items: $ref: '#/components/schemas/HarvestingClient' metadataBlockFacetRoot: type: boolean metadataBlockFacets: type: array items: $ref: '#/components/schemas/DataverseMetadataBlockFacet' guestbookRoot: type: boolean requireFilesToPublishDataset: type: boolean filePIDsEnabled: type: boolean friendlyCategoryName: type: string friendlyCategoryKey: type: string indexableCategoryName: type: string parentGuestbooks: type: array items: $ref: '#/components/schemas/Guestbook' availableGuestbooks: type: array items: $ref: '#/components/schemas/Guestbook' parentTemplates: type: array items: $ref: '#/components/schemas/Template' metadataRootId: format: int64 type: integer guestbookRootDataverseName: type: string templateRootDataverseName: type: string themeRootDataverseName: type: string metadataRootDataverseName: type: string facetRootDataverseName: type: string logoOwnerId: type: string facetRootId: format: int64 type: integer contactEmails: type: string owners: type: array items: $ref: '#/components/schemas/Dataverse' effectiveRequiresFilesToPublishDataset: type: boolean depositTermsOfUse: type: string displayName: type: string currentName: type: string localURL: type: string DatasetVersionDifference: type: object properties: newVersion: $ref: '#/components/schemas/DatasetVersion' originalVersion: $ref: '#/components/schemas/DatasetVersion' detailDataByBlock: type: array items: type: array items: type: object properties: id: format: int64 type: integer datasetFieldType: $ref: '#/components/schemas/DatasetFieldType' datasetVersion: $ref: '#/components/schemas/DatasetVersion' template: $ref: '#/components/schemas/Template' parentDatasetFieldCompoundValue: $ref: '#/components/schemas/DatasetFieldCompoundValue' datasetFieldCompoundValues: type: array items: $ref: '#/components/schemas/DatasetFieldCompoundValue' datasetFieldValues: type: array items: $ref: '#/components/schemas/DatasetFieldValue' controlledVocabularyValues: type: array items: $ref: '#/components/schemas/ControlledVocabularyValue' validationMessage: type: string required: type: boolean hasRequiredChildren: type: boolean include: type: boolean singleValue: $ref: '#/components/schemas/DatasetFieldValue' singleControlledVocabularyValue: $ref: '#/components/schemas/ControlledVocabularyValue' value: type: string displayValue: type: string rawValue: type: string compoundDisplayValue: type: string compoundRawValue: type: string values: type: array items: type: string rawValuesList: type: array items: type: string values_nondisplay: type: array items: type: string displayValues: type: array items: type: string valuesWithoutNaValues: type: array items: type: string empty: type: boolean emptyForDisplay: type: boolean hasRequiredChildrenDV: type: boolean dataverse: $ref: '#/components/schemas/Dataverse' datasetFilesDiffList: type: array items: $ref: '#/components/schemas/datasetFileDifferenceItem' datasetFilesReplacementList: type: array items: $ref: '#/components/schemas/datasetReplaceFileItem' addedFiles: type: array items: $ref: '#/components/schemas/FileMetadata' removedFiles: type: array items: $ref: '#/components/schemas/FileMetadata' changedFileMetadata: type: array items: $ref: '#/components/schemas/FileMetadata' changedFileMetadataDiff: type: object additionalProperties: type: object additionalProperties: type: array items: type: string changedVariableMetadata: type: array items: $ref: '#/components/schemas/FileMetadata' replacedFiles: type: array items: description: Cyclic reference to edu.harvard.iq.dataverse.FileMetadata type: object changedTermsAccess: type: array items: {} summaryDataForNote: type: array items: $ref: '#/components/schemas/SummaryNote' blockDataForNote: type: array items: $ref: '#/components/schemas/SummaryNote' differenceSummaryGroups: type: array items: $ref: '#/components/schemas/DifferenceSummaryGroup' fileNote: type: string editSummaryForLog: type: string summaryDifferenceAsJson: type: object fileSummaryAsJson: type: object Type: enum: - ASSIGNROLE - REVOKEROLE - CREATEDV - CREATEDS - CREATEACC - SUBMITTEDDS - RETURNEDDS - PUBLISHEDDS - REQUESTFILEACCESS - GRANTFILEACCESS - REJECTFILEACCESS - FILESYSTEMIMPORT - CHECKSUMIMPORT - CHECKSUMFAIL - CONFIRMEMAIL - APIGENERATED - INGESTCOMPLETED - INGESTCOMPLETEDWITHERRORS - PUBLISHFAILED_PIDREG - WORKFLOW_SUCCESS - WORKFLOW_FAILURE - STATUSUPDATED - DATASETCREATED - DATASETMENTIONED - GLOBUSUPLOADCOMPLETED - GLOBUSUPLOADCOMPLETEDWITHERRORS - GLOBUSDOWNLOADCOMPLETED - GLOBUSDOWNLOADCOMPLETEDWITHERRORS - REQUESTEDFILEACCESS - GLOBUSUPLOADREMOTEFAILURE - GLOBUSUPLOADLOCALFAILURE - PIDRECONCILED type: string datasetReplaceFileItem: type: object properties: fdi: $ref: '#/components/schemas/datasetFileDifferenceItem' leftColumn: type: string file1Id: type: string file2Id: type: string file1ChecksumType: $ref: '#/components/schemas/ChecksumType' file2ChecksumType: $ref: '#/components/schemas/ChecksumType' file1ChecksumValue: type: string file2ChecksumValue: type: string Guestbook: type: object properties: id: format: int64 type: integer dataverse: $ref: '#/components/schemas/Dataverse' customQuestions: type: array items: $ref: '#/components/schemas/CustomQuestion' name: type: string enabled: type: boolean nameRequired: type: boolean emailRequired: type: boolean institutionRequired: type: boolean positionRequired: type: boolean createTime: format: date type: string example: '2022-03-10' deletable: type: boolean usageCount: format: int64 type: integer usageCountDataverse: format: int64 type: integer responseCount: format: int64 type: integer responseCountDataverse: format: int64 type: integer createDate: type: string requiredAccountInformation: type: array items: type: string optionalAccountInformation: type: array items: type: string requiredQuestionsList: type: array items: type: string optionalQuestionsList: type: array items: type: string DatasetFieldServiceBean: type: object properties: em: type: object settingsService: $ref: '#/components/schemas/SettingsServiceBean' cvocMap: type: object additionalProperties: {} cvocMapByTermUri: type: object additionalProperties: {} cvocFieldSet: uniqueItems: true type: array items: format: int64 type: integer oldHash: type: string PasswordValidatorServiceBean: type: object properties: goodStrength: format: int32 type: integer maxLength: format: int32 type: integer minLength: format: int32 type: integer numberOfCharacteristics: format: int32 type: integer numberOfConsecutiveDigitsAllowed: format: int32 type: integer characterRules: type: array items: {} dictionaries: type: string messageResolver: type: object systemConfig: $ref: '#/components/schemas/SystemConfig' IngestServiceBean: type: object properties: variableService: $ref: '#/components/schemas/VariableServiceBean' datasetService: $ref: '#/components/schemas/DatasetServiceBean' fieldService: $ref: '#/components/schemas/DatasetFieldServiceBean' fileService: $ref: '#/components/schemas/DataFileServiceBean' auxiliaryFileService: $ref: '#/components/schemas/AuxiliaryFileServiceBean' storageUseService: $ref: '#/components/schemas/StorageUseServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' queue: type: object factory: type: object SolrClientService: type: object properties: systemConfig: $ref: '#/components/schemas/SystemConfig' solrUrl: type: string solrClient: type: object AuthenticationProviderFactory: type: object properties: alias: type: string info: type: string SavedSearchFilterQuery: type: object properties: id: format: int64 type: integer filterQuery: type: string savedSearch: $ref: '#/components/schemas/SavedSearch' SummaryNote: type: object properties: dsfo: $ref: '#/components/schemas/DatasetField' added: format: int32 type: integer deleted: format: int32 type: integer changed: format: int32 type: integer datasetField: $ref: '#/components/schemas/DatasetField' SavedSearchServiceBean: type: object properties: searchService: $ref: '#/components/schemas/SearchServiceFactory' dvObjectService: $ref: '#/components/schemas/DvObjectServiceBean' dsLinkingService: $ref: '#/components/schemas/DatasetLinkingServiceBean' dvLinkingService: $ref: '#/components/schemas/DataverseLinkingServiceBean' commandEngine: $ref: '#/components/schemas/EjbDataverseEngine' systemConfig: $ref: '#/components/schemas/SystemConfig' resultString: type: string em: type: object OAuth2TokenData: type: object properties: id: format: int64 type: integer user: $ref: '#/components/schemas/AuthenticatedUser' oauthProviderId: type: string expiryDate: type: object accessToken: type: string refreshToken: type: string tokenType: type: string rawResponse: type: string SystemConfig: type: object properties: settingsService: $ref: '#/components/schemas/SettingsServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' authenticationService: $ref: '#/components/schemas/AuthenticationServiceBean' buildNumber: type: string version: type: string solrHostColonPort: type: string provCollectionEnabled: type: boolean metricsCacheTimeoutMinutes: format: int32 type: integer minutesUntilConfirmEmailTokenExpires: format: int32 type: integer dataverseSiteUrl: type: string pageURLWithQueryString: type: string guidesBaseUrl: type: string guidesLanguage: type: string guidesVersion: type: string metricsUrl: type: string zipDownloadLimit: format: int64 type: integer zipUploadFilesLimit: format: int32 type: integer loginSessionTimeout: format: int32 type: integer multipleUploadFilesLimit: format: int32 type: integer guestbookResponsesPageDisplayLimit: format: int64 type: integer uploadLogoSizeLimit: format: int64 type: integer thumbnailSizeLimitImage: format: int64 type: integer thumbnailSizeLimitPDF: format: int64 type: integer thumbnailGenerationDisabledForImages: type: boolean thumbnailGenerationDisabledForPDF: type: boolean applicationTermsOfUse: type: string apiTermsOfUse: type: string applicationPrivacyPolicyUrl: type: string filesOnDatasetPageFromSolr: type: boolean searchHighlightFragmentSize: format: int32 type: integer tabularIngestSizeLimit: format: int64 type: integer oAIServerEnabled: type: boolean timerServer: type: boolean footerCopyrightAndYear: type: string fileFixityChecksumAlgorithm: $ref: '#/components/schemas/ChecksumType' defaultAuthProvider: type: string nameOfInstallation: type: string devOAuthAccountType: $ref: '#/components/schemas/DevOAuthAccountType' oAuth2CallbackUrl: type: string shibPassiveLoginEnabled: type: boolean shibAttributeCharacterSetConversionEnabled: type: boolean pVDictionaries: type: string pVGoodStrength: format: int32 type: integer pVMinLength: format: int32 type: integer pVMaxLength: format: int32 type: integer pVCharacterRules: type: array items: {} pVNumberOfCharacteristics: format: int32 type: integer pVNumberOfConsecutiveDigitsAllowed: format: int32 type: integer publicInstall: type: boolean rsyncUpload: type: boolean deprecated: true globusUpload: type: boolean webloaderUpload: type: boolean hTTPUpload: type: boolean rsyncOnly: type: boolean deprecated: true rsyncDownload: type: boolean deprecated: true hTTPDownload: type: boolean globusDownload: type: boolean globusFileDownload: type: boolean globusBatchLookupSize: format: int32 type: integer uploadMethodCount: format: int32 type: integer allowCustomTerms: type: boolean mDCLogPath: type: string datafileValidationOnPublishEnabled: type: boolean externalDataverseValidationEnabled: type: boolean externalDatasetValidationEnabled: type: boolean dataverseValidationExecutable: type: string datasetValidationExecutable: type: string dataverseValidationFailureMsg: type: string dataverseUpdateValidationFailureMsg: type: string datasetValidationFailureMsg: type: string externalValidationAdminOverrideEnabled: type: boolean datasetValidationSizeLimit: format: int64 type: integer fileValidationSizeLimit: format: int64 type: integer curationLabels: type: object additionalProperties: {} storageQuotasEnforced: type: boolean testStorageQuotaLimit: format: int64 type: integer storingIngestedFilesWithHeaders: type: boolean rateLimitsJson: type: string rateLimitingDefaultCapacityTiers: type: string contactFeedbackMessageSizeLimit: format: int64 type: integer DatasetVersionServiceBean: type: object properties: datasetService: $ref: '#/components/schemas/DatasetServiceBean' datafileService: $ref: '#/components/schemas/DataFileServiceBean' settingsService: $ref: '#/components/schemas/SettingsServiceBean' authService: $ref: '#/components/schemas/AuthenticationServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' indexService: $ref: '#/components/schemas/IndexServiceBean' em: type: object unarchivedDatasetVersions: type: array items: $ref: '#/components/schemas/DatasetVersion' MailServiceBean: type: object properties: userNotificationService: $ref: '#/components/schemas/UserNotificationServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' dataFileService: $ref: '#/components/schemas/DataFileServiceBean' datasetService: $ref: '#/components/schemas/DatasetServiceBean' versionService: $ref: '#/components/schemas/DatasetVersionServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' settingsService: $ref: '#/components/schemas/SettingsServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' groupService: $ref: '#/components/schemas/GroupServiceBean' confirmEmailService: $ref: '#/components/schemas/ConfirmEmailServiceBean' session: type: object systemAddress: type: object nullable: true supportAddress: type: object nullable: true DataverseSession: type: object properties: user: $ref: '#/components/schemas/User' permissionsService: $ref: '#/components/schemas/PermissionServiceBean' usersSvc: $ref: '#/components/schemas/BuiltinUserServiceBean' logSvc: $ref: '#/components/schemas/ActionLogServiceBean' settingsWrapper: $ref: '#/components/schemas/SettingsWrapper' headerFragment: $ref: '#/components/schemas/DataverseHeaderFragment' systemConfig: $ref: '#/components/schemas/SystemConfig' bannerMessageService: $ref: '#/components/schemas/BannerMessageServiceBean' authenticationService: $ref: '#/components/schemas/AuthenticationServiceBean' statusDismissed: type: boolean dismissedMessages: type: array items: $ref: '#/components/schemas/BannerMessage' debug: type: boolean localeCode: type: string localeTitle: type: string RoleAssignee: type: object properties: identifier: type: string displayInfo: $ref: '#/components/schemas/RoleAssigneeDisplayInfo' sortByString: type: string DataverseLinkingDataverse: type: object properties: id: format: int64 type: integer dataverse: $ref: '#/components/schemas/Dataverse' linkingDataverse: $ref: '#/components/schemas/Dataverse' linkCreateTime: format: date type: string example: '2022-03-10' MetadataBlock: type: object properties: id: format: int64 type: integer name: type: string displayName: type: string namespaceUri: type: string datasetFieldTypes: type: array items: $ref: '#/components/schemas/DatasetFieldType' localDisplayOnCreate: type: boolean owner: $ref: '#/components/schemas/Dataverse' empty: type: boolean selected: type: boolean hasRequired: type: boolean showDatasetFieldTypes: type: boolean assignedNamespaceUri: type: string jsonLDNamespace: $ref: '#/components/schemas/JsonLDNamespace' displayOnCreate: type: boolean required: type: boolean idString: type: string localeDisplayName: type: string localeDisplayFacet: type: string VarGroup: type: object properties: id: format: int64 type: integer label: type: string fileMetadata: $ref: '#/components/schemas/FileMetadata' varsInGroup: uniqueItems: true type: array items: $ref: '#/components/schemas/DataVariable' Reason: enum: - Ingest - Workflow - InReview - DcmUpload - GlobusUpload - finalizePublication - EditInProgress - FileValidationFailed type: string RoleAssigneeServiceBean: type: object properties: em: type: object authSvc: $ref: '#/components/schemas/AuthenticationServiceBean' groupSvc: $ref: '#/components/schemas/GroupServiceBean' explicitGroupSvc: $ref: '#/components/schemas/ExplicitGroupServiceBean' dataverseRoleService: $ref: '#/components/schemas/DataverseRoleServiceBean' predefinedRoleAssignees: type: object additionalProperties: $ref: '#/components/schemas/RoleAssignee' CategoryMetadata: type: object properties: id: format: int64 type: integer category: $ref: '#/components/schemas/VariableCategory' variableMetadata: $ref: '#/components/schemas/VariableMetadata' wfreq: format: double type: number Permission: enum: - AddDataverse - AddDataset - ViewUnpublishedDataverse - ViewUnpublishedDataset - DownloadFile - EditDataverse - EditDataset - ManageDataversePermissions - ManageDatasetPermissions - ManageFilePermissions - PublishDataverse - PublishDataset - LinkDataverse - LinkDataset - DeleteDataverse - DeleteDatasetDraft type: string TemplateServiceBean: type: object properties: indexService: $ref: '#/components/schemas/IndexServiceBean' em: type: object OAIRecordServiceBean: type: object properties: datasetService: $ref: '#/components/schemas/DatasetServiceBean' settingsService: $ref: '#/components/schemas/SettingsServiceBean' em: type: object earliestDate: format: date-time type: string example: '2022-03-10T16:15:50Z' PidProviderFactoryBean: type: object properties: dataverseService: $ref: '#/components/schemas/DataverseServiceBean' settingsService: $ref: '#/components/schemas/SettingsServiceBean' dvObjectService: $ref: '#/components/schemas/DvObjectServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' loader: type: array items: $ref: '#/components/schemas/PidProviderFactory' pidProviderFactoryMap: type: object additionalProperties: $ref: '#/components/schemas/PidProviderFactory' producer: type: string defaultPidGenerator: $ref: '#/components/schemas/PidProvider' DataAccessRequest: type: object properties: file: $ref: '#/components/schemas/DataFile' requestParameters: type: object additionalProperties: type: string CacheFactoryBean: type: object properties: rateLimitCache: type: array items: type: string systemConfig: $ref: '#/components/schemas/SystemConfig' manager: type: object VariableType: enum: - NUMERIC - CHARACTER type: string VariableMetadataUtil: type: object DataFileTag: type: object properties: id: format: int64 type: integer dataFile: $ref: '#/components/schemas/DataFile' type: $ref: '#/components/schemas/TagType' typeByLabel: type: string typeLabel: type: string geospatialTag: type: boolean DataverseTheme: type: object properties: id: format: int64 type: integer logoFormat: $ref: '#/components/schemas/ImageFormat' logoAlignment: $ref: '#/components/schemas/Alignment' logoBackgroundColor: type: string logo: type: string logoThumbnail: type: string logoFooterAlignment: $ref: '#/components/schemas/Alignment' logoFooterBackgroundColor: type: string logoFooter: type: string tagline: type: string linkUrl: type: string linkColor: type: string textColor: type: string backgroundColor: type: string dataverse: $ref: '#/components/schemas/Dataverse' WorkflowServiceBean: type: object properties: em: type: object datasets: $ref: '#/components/schemas/DatasetServiceBean' dvObjects: $ref: '#/components/schemas/DvObjectServiceBean' settings: $ref: '#/components/schemas/SettingsServiceBean' roleAssignees: $ref: '#/components/schemas/RoleAssigneeServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' userNotificationService: $ref: '#/components/schemas/UserNotificationServiceBean' engine: $ref: '#/components/schemas/EjbDataverseEngine' dvRequestService: $ref: '#/components/schemas/DataverseRequestServiceBean' providers: type: object additionalProperties: $ref: '#/components/schemas/WorkflowStepSPI' BannerMessageText: type: object properties: id: format: int64 type: integer message: type: string lang: type: string bannerMessage: $ref: '#/components/schemas/BannerMessage' DatasetRelPublication: type: object properties: text: type: string idType: type: string idNumber: type: string url: type: string title: type: string description: type: string replicationData: type: boolean displayOrder: format: int32 type: integer relationType: type: string localeTitle: type: string localeDescription: type: string empty: type: boolean BundleDownloadInstance: type: object properties: downloadInfo: $ref: '#/components/schemas/DownloadInfo' fileCitationEndNote: type: string fileCitationRIS: type: string fileDDIXML: type: string fileCitationBibtex: type: string SummaryStatisticType: enum: - MEAN - MEDN - MODE - MIN - MAX - STDEV - VALD - INVD type: string Type1: enum: - RETURN_TO_AUTHOR - WORKFLOW_SUCCESS - WORKFLOW_FAILURE type: string CustomQuestionValue: type: object properties: id: format: int64 type: integer valueString: type: string displayOrder: format: int32 type: integer customQuestion: $ref: '#/components/schemas/CustomQuestion' FailedPIDResolutionLoggingServiceBean: type: object properties: logFileName: type: string FileDownloadHelper: type: object properties: session: $ref: '#/components/schemas/DataverseSession' dvRequestService: $ref: '#/components/schemas/DataverseRequestServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' fileDownloadService: $ref: '#/components/schemas/FileDownloadServiceBean' guestbookResponseService: $ref: '#/components/schemas/GuestbookResponseServiceBean' datafileService: $ref: '#/components/schemas/DataFileServiceBean' globusService: $ref: '#/components/schemas/GlobusServiceBean' fileDownloadPermissionMap: type: object additionalProperties: type: boolean filesForRequestAccess: type: array items: $ref: '#/components/schemas/DataFile' selectedFileId: type: string ShibGroupProvider: type: object properties: shibGroupService: $ref: '#/components/schemas/ShibGroupServiceBean' groupProviderAlias: type: string groupProviderInfo: type: string DataverseRole: type: object properties: id: format: int64 type: integer name: pattern: .+ type: string description: maxLength: 255 type: string alias: maxLength: 16 pattern: '[a-zA-Z0-9\_\-]+' type: string permissionBits: format: int64 type: integer owner: $ref: '#/components/schemas/DvObject' permissionsBits: format: int64 type: integer UserBannerMessage: type: object properties: id: format: int64 type: integer user: $ref: '#/components/schemas/AuthenticatedUser' bannerMessage: $ref: '#/components/schemas/BannerMessage' bannerDismissalTime: format: date type: string example: '2022-03-10' DatasetLinkingDataverse: type: object properties: id: format: int64 type: integer dataset: $ref: '#/components/schemas/Dataset' linkingDataverse: $ref: '#/components/schemas/Dataverse' linkCreateTime: format: date type: string example: '2022-03-10' DatasetField: type: object properties: id: format: int64 type: integer datasetFieldType: $ref: '#/components/schemas/DatasetFieldType' datasetVersion: $ref: '#/components/schemas/DatasetVersion' template: $ref: '#/components/schemas/Template' parentDatasetFieldCompoundValue: $ref: '#/components/schemas/DatasetFieldCompoundValue' datasetFieldCompoundValues: type: array items: $ref: '#/components/schemas/DatasetFieldCompoundValue' datasetFieldValues: type: array items: $ref: '#/components/schemas/DatasetFieldValue' controlledVocabularyValues: type: array items: $ref: '#/components/schemas/ControlledVocabularyValue' validationMessage: type: string required: type: boolean hasRequiredChildren: type: boolean include: type: boolean singleValue: $ref: '#/components/schemas/DatasetFieldValue' singleControlledVocabularyValue: $ref: '#/components/schemas/ControlledVocabularyValue' value: type: string displayValue: type: string rawValue: type: string compoundDisplayValue: type: string compoundRawValue: type: string values: type: array items: type: string rawValuesList: type: array items: type: string values_nondisplay: type: array items: type: string displayValues: type: array items: type: string valuesWithoutNaValues: type: array items: type: string empty: type: boolean emptyForDisplay: type: boolean hasRequiredChildrenDV: type: boolean dataverse: $ref: '#/components/schemas/Dataverse' SettingsWrapper: type: object properties: settingsService: $ref: '#/components/schemas/SettingsServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' fieldService: $ref: '#/components/schemas/DatasetFieldServiceBean' mdbService: $ref: '#/components/schemas/MetadataBlockServiceBean' mailServiceBean: $ref: '#/components/schemas/MailServiceBean' settingsMap: type: object additionalProperties: type: string guidesBaseUrl: type: string embargoDateChecked: type: boolean maxEmbargoDate: format: date type: string example: '2022-03-10' retentionDateChecked: type: boolean minRetentionDate: format: date type: string example: '2022-03-10' siteUrl: type: string rootDataverse: $ref: '#/components/schemas/Dataverse' guidesVersion: type: string appVersion: type: string appVersionWithBuildNumber: type: string shibPassiveLoginEnabled: type: boolean footerCopyrightAndYear: type: string cachedCvocMap: type: object additionalProperties: {} cachedCvocByTermFieldMap: type: object additionalProperties: {} cvocFieldSet: uniqueItems: true type: array items: format: int64 type: integer zipDownloadLimit: format: int64 type: integer publicInstall: type: boolean uploadMethodsCount: format: int32 type: integer rsyncUpload: type: boolean rsyncDownload: type: boolean globusUpload: type: boolean globusDownload: type: boolean globusFileDownload: type: boolean globusAppUrl: type: string globusStoreList: type: array items: type: string httpUpload: type: boolean rsyncOnly: type: boolean webloaderUpload: type: boolean metricsUrl: type: string dataFilePIDSequentialDependent: type: boolean customLicenseAllowed: type: boolean systemMetadataBlocks: type: array items: $ref: '#/components/schemas/MetadataBlock' alwaysMuted: uniqueItems: true type: array items: $ref: '#/components/schemas/Type' neverMuted: uniqueItems: true type: array items: $ref: '#/components/schemas/Type' configuredLocales: type: object additionalProperties: type: string anonymizedFieldTypes: type: array items: type: string languageMap: type: object additionalProperties: type: string allowedExternalStatuses: type: array items: type: string alwaysMutedSet: uniqueItems: true type: array items: $ref: '#/components/schemas/Type' neverMutedSet: uniqueItems: true type: array items: $ref: '#/components/schemas/Type' showMuteOptions: type: boolean dataverseSiteUrl: type: string hTTPUpload: type: boolean supportTeamName: type: string supportTeamEmail: type: string rootDataverseThemeDisabled: type: boolean dropBoxKey: type: string hasDropBoxKey: type: boolean localesConfigured: type: boolean makeDataCountDisplayEnabled: type: boolean mDCStartDate: format: date type: string example: '2022-03-10' minEmbargoDate: format: date type: string example: '2022-03-10' embargoAllowed: type: boolean maxRetentionDate: format: date type: string example: '2022-03-10' retentionAllowed: type: boolean defaultMetadataLanguage: type: string ConfirmEmailServiceBean: type: object properties: authenticationService: $ref: '#/components/schemas/AuthenticationServiceBean' mailService: $ref: '#/components/schemas/MailServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' em: type: object DataverseFieldTypeInputLevel: type: object properties: id: format: int64 type: integer dataverse: $ref: '#/components/schemas/Dataverse' datasetFieldType: $ref: '#/components/schemas/DatasetFieldType' include: type: boolean required: type: boolean displayOnCreate: type: boolean TagType: enum: - Survey - TimeSeries - Panel - Event - Genomics - Network - Geospatial type: string AuthenticatedUserLookup: type: object properties: id: format: int64 type: integer authenticationProviderId: type: string persistentUserId: type: string authenticatedUser: $ref: '#/components/schemas/AuthenticatedUser' DataverseFeaturedItemServiceBean: type: object properties: em: type: object fileService: $ref: '#/components/schemas/DataFileServiceBean' datasetService: $ref: '#/components/schemas/DatasetServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' GlobusServiceBean: type: object properties: datasetSvc: $ref: '#/components/schemas/DatasetServiceBean' settingsSvc: $ref: '#/components/schemas/SettingsServiceBean' session: $ref: '#/components/schemas/DataverseSession' dataverseRequestSvc: $ref: '#/components/schemas/DataverseRequestServiceBean' authSvc: $ref: '#/components/schemas/AuthenticationServiceBean' commandEngine: $ref: '#/components/schemas/EjbDataverseEngine' userNotificationService: $ref: '#/components/schemas/UserNotificationServiceBean' privateUrlService: $ref: '#/components/schemas/PrivateUrlServiceBean' fileDownloadService: $ref: '#/components/schemas/FileDownloadServiceBean' dataFileSvc: $ref: '#/components/schemas/DataFileServiceBean' permissionSvc: $ref: '#/components/schemas/PermissionServiceBean' ingestSvc: $ref: '#/components/schemas/IngestServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' em: type: object rulesCache: type: object downloadCache: type: object executor: type: object DataverseFeaturedDataverse: type: object properties: id: format: int64 type: integer dataverse: $ref: '#/components/schemas/Dataverse' featuredDataverse: $ref: '#/components/schemas/Dataverse' displayOrder: format: int32 type: integer MailDomainGroupServiceBean: type: object properties: em: type: object confirmEmailSvc: $ref: '#/components/schemas/ConfirmEmailServiceBean' actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' provider: $ref: '#/components/schemas/MailDomainGroupProvider' simpleGroups: type: array items: $ref: '#/components/schemas/MailDomainGroup' regexGroups: type: object additionalProperties: {} RunResultType: enum: - COMPLETED - COMPLETED_WITH_FAILURES - FAILURE - IN_PROGRESS - INTERRUPTED type: string SolrType: enum: - STRING - TEXT_EN - INTEGER - FLOAT - DATE - EMAIL type: string DifferenceSummaryGroup: type: object properties: displayName: type: string type: type: string differenceSummaryItems: type: array items: $ref: '#/components/schemas/DifferenceSummaryItem' CustomQuestionResponse: type: object properties: id: format: int64 type: integer guestbookResponse: $ref: '#/components/schemas/GuestbookResponse' customQuestion: $ref: '#/components/schemas/CustomQuestion' response: type: string responseSelectItems: type: array items: {} AuthenticationServiceBean: type: object properties: authProvidersRegistrationService: $ref: '#/components/schemas/AuthenticationProvidersRegistrationServiceBean' builtinUserServiceBean: $ref: '#/components/schemas/BuiltinUserServiceBean' indexService: $ref: '#/components/schemas/IndexServiceBean' actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' userNotificationService: $ref: '#/components/schemas/UserNotificationServiceBean' confirmEmailService: $ref: '#/components/schemas/ConfirmEmailServiceBean' passwordResetServiceBean: $ref: '#/components/schemas/PasswordResetServiceBean' userService: $ref: '#/components/schemas/UserServiceBean' passwordValidatorService: $ref: '#/components/schemas/PasswordValidatorServiceBean' dvObjSvc: $ref: '#/components/schemas/DvObjectServiceBean' roleAssigneeSvc: $ref: '#/components/schemas/RoleAssigneeServiceBean' gbRespSvc: $ref: '#/components/schemas/GuestbookResponseServiceBean' datasetVersionService: $ref: '#/components/schemas/DatasetVersionServiceBean' explicitGroupService: $ref: '#/components/schemas/ExplicitGroupServiceBean' savedSearchService: $ref: '#/components/schemas/SavedSearchServiceBean' privateUrlService: $ref: '#/components/schemas/PrivateUrlServiceBean' affiliationBean: $ref: '#/components/schemas/AffiliationServiceBean' em: type: object oAuth2Providers: uniqueItems: true type: array items: $ref: '#/components/schemas/AbstractOAuth2AuthenticationProvider' authenticationProviderIds: uniqueItems: true type: array items: type: string authenticationProviders: type: array items: $ref: '#/components/schemas/AuthenticationProvider' orcidEnabled: type: boolean adminUser: $ref: '#/components/schemas/AuthenticatedUser' currentTimestamp: type: object availableOidcProviders: type: array items: $ref: '#/components/schemas/OIDCAuthProvider' orcidAuthenticationProvider: $ref: '#/components/schemas/OrcidOAuth2AP' PasswordResetServiceBean: type: object properties: dataverseUserService: $ref: '#/components/schemas/BuiltinUserServiceBean' mailService: $ref: '#/components/schemas/MailServiceBean' passwordValidatorService: $ref: '#/components/schemas/PasswordValidatorServiceBean' authService: $ref: '#/components/schemas/AuthenticationServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' em: type: object RoleAssigneeDisplayInfo: type: object properties: title: type: string emailAddress: type: string affiliation: type: string AffiliationGroupProvider: type: object properties: affiliationGroupService: $ref: '#/components/schemas/AffiliationGroupServiceBean' groupProviderAlias: type: string groupProviderInfo: type: string affiliationGroups: type: array items: $ref: '#/components/schemas/AffiliationGroup' affiliationGroupsCount: format: int64 type: integer ExternalTool: type: object properties: id: format: int64 type: integer displayName: type: string toolName: type: string description: type: string externalToolTypes: type: array items: $ref: '#/components/schemas/ExternalToolType' scope: $ref: '#/components/schemas/Scope' toolUrl: type: string toolParameters: type: string contentType: type: string displayNameLang: type: string allowedApiCalls: type: string requirements: type: string exploreTool: type: boolean queryTool: type: boolean previewTool: type: boolean descriptionLang: type: string PermissionServiceBean: type: object properties: userService: $ref: '#/components/schemas/BuiltinUserServiceBean' authenticationService: $ref: '#/components/schemas/AuthenticationServiceBean' roleService: $ref: '#/components/schemas/DataverseRoleServiceBean' roleAssigneeService: $ref: '#/components/schemas/RoleAssigneeServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' dvObjectServiceBean: $ref: '#/components/schemas/DvObjectServiceBean' workflowService: $ref: '#/components/schemas/WorkflowServiceBean' em: type: object groupService: $ref: '#/components/schemas/GroupServiceBean' session: $ref: '#/components/schemas/DataverseSession' dvRequestService: $ref: '#/components/schemas/DataverseRequestServiceBean' datasetVersionFilesServiceBean: $ref: '#/components/schemas/DatasetVersionFilesServiceBean' ExplicitGroupProvider: type: object properties: explicitGroupSvc: $ref: '#/components/schemas/ExplicitGroupServiceBean' roleAssigneeSvc: $ref: '#/components/schemas/RoleAssigneeServiceBean' groupProviderAlias: type: string groupProviderInfo: type: string AuthenticatedUser: required: - userIdentifier - email - lastName - firstName type: object properties: id: format: int64 type: integer userIdentifier: type: string email: type: string affiliation: type: string localizedAffiliation: type: string position: type: string lastName: pattern: \S type: string firstName: pattern: \S type: string emailConfirmed: type: object createdTime: type: object lastLoginTime: type: object lastApiUseTime: type: object cart: $ref: '#/components/schemas/Cart' superuser: type: boolean deactivated: type: boolean deactivatedTime: type: object mutedEmails: type: string mutedNotifications: type: string mutedEmailsSet: uniqueItems: true type: array items: $ref: '#/components/schemas/Type' mutedNotificationsSet: uniqueItems: true type: array items: $ref: '#/components/schemas/Type' rateLimitTier: format: int32 minimum: 1 type: integer authenticatedOrcid: type: string shibIdentityProvider: type: string notifications: type: array items: $ref: '#/components/schemas/UserNotification' requests: type: array items: $ref: '#/components/schemas/UserNotification' datasetLocks: type: array items: $ref: '#/components/schemas/DatasetLock' oAuth2TokenDatas: type: array items: $ref: '#/components/schemas/OAuth2TokenData' fileAccessRequests: type: array items: $ref: '#/components/schemas/FileAccessRequest' roles: type: string authProviderId: type: string authProviderFactoryAlias: type: string authenticatedUserLookup: $ref: '#/components/schemas/AuthenticatedUserLookup' identifier: type: string userNotifications: type: array items: $ref: '#/components/schemas/UserNotification' userRequests: type: array items: $ref: '#/components/schemas/UserNotification' userRequestss: type: array items: $ref: '#/components/schemas/UserNotification' requestedDataFiles: type: array items: $ref: '#/components/schemas/DataFile' displayInfo: $ref: '#/components/schemas/AuthenticatedUserDisplayInfo' authenticated: type: boolean name: type: string sortByString: type: string SolrIndexServiceBean: type: object properties: dvObjectService: $ref: '#/components/schemas/DvObjectServiceBean' searchPermissionsService: $ref: '#/components/schemas/SearchPermissionsServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' datasetService: $ref: '#/components/schemas/DatasetServiceBean' datasetVersionService: $ref: '#/components/schemas/DatasetVersionServiceBean' rolesSvc: $ref: '#/components/schemas/DataverseRoleServiceBean' solrClientService: $ref: '#/components/schemas/SolrClientIndexService' em: type: object FileDownloadServiceBean: type: object properties: em: type: object guestbookResponseService: $ref: '#/components/schemas/GuestbookResponseServiceBean' datasetService: $ref: '#/components/schemas/DatasetServiceBean' datasetVersionService: $ref: '#/components/schemas/DatasetVersionServiceBean' datafileService: $ref: '#/components/schemas/DataFileServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' userNotificationService: $ref: '#/components/schemas/UserNotificationServiceBean' authService: $ref: '#/components/schemas/AuthenticationServiceBean' settingsService: $ref: '#/components/schemas/SettingsServiceBean' mailService: $ref: '#/components/schemas/MailServiceBean' session: $ref: '#/components/schemas/DataverseSession' commandEngine: $ref: '#/components/schemas/EjbDataverseEngine' dvRequestService: $ref: '#/components/schemas/DataverseRequestServiceBean' fileDownloadHelper: $ref: '#/components/schemas/FileDownloadHelper' mdcLogService: $ref: '#/components/schemas/MakeDataCountLoggingServiceBean' JsonLDTerm: type: object properties: namespace: $ref: '#/components/schemas/JsonLDNamespace' term: type: string url: type: string label: type: string ImageFormat: enum: - SQUARE - RECTANGLE type: string AuthenticationProvidersRegistrationServiceBean: type: object properties: builtinUserServiceBean: $ref: '#/components/schemas/BuiltinUserServiceBean' passwordValidatorService: $ref: '#/components/schemas/PasswordValidatorServiceBean' actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' authenticationService: $ref: '#/components/schemas/AuthenticationServiceBean' settingsService: $ref: '#/components/schemas/SettingsServiceBean' providerFactories: type: object additionalProperties: $ref: '#/components/schemas/AuthenticationProviderFactory' authenticationProviders: type: object additionalProperties: $ref: '#/components/schemas/AuthenticationProvider' oAuth2authenticationProviders: type: object additionalProperties: $ref: '#/components/schemas/AbstractOAuth2AuthenticationProvider' em: type: object orcidProvider: $ref: '#/components/schemas/AuthenticationProvider' oAuth2AuthProvidersMap: type: object additionalProperties: $ref: '#/components/schemas/AbstractOAuth2AuthenticationProvider' authenticationProvidersMap: type: object additionalProperties: $ref: '#/components/schemas/AuthenticationProvider' providerFactoriesMap: type: object additionalProperties: $ref: '#/components/schemas/AuthenticationProviderFactory' StorageIODataFile: type: object properties: isReadAccess: type: boolean isWriteAccess: type: boolean req: $ref: '#/components/schemas/DataAccessRequest' in: format: binary type: string out: type: object channel: type: object dvObject: $ref: '#/components/schemas/DataFile' driverId: type: string size: format: int64 type: integer offset: format: int64 type: integer mimeType: type: string fileName: type: string varHeader: type: string errorMessage: type: string temporarySwiftUrl: type: string tempUrlExpiry: type: string tempUrlSignature: type: string swiftContainerName: type: string isLocalFile: type: boolean noVarHeader: type: boolean isZippedStream: type: boolean isDownloadSupported: type: boolean isSubsetSupported: type: boolean swiftFileName: type: string remoteUrl: type: string remoteStoreName: type: string remoteStoreUrl: type: object storageLocation: type: string fileSystemPath: type: array writeChannel: type: object readChannel: type: object dataFile: $ref: '#/components/schemas/DataFile' dataset: $ref: '#/components/schemas/Dataset' dataverse: $ref: '#/components/schemas/Dataverse' request: $ref: '#/components/schemas/DataAccessRequest' inputStream: format: binary type: string outputStream: type: object localFile: type: boolean directAccess: type: boolean downloadSupported: type: boolean subsetSupported: type: boolean zippedStream: type: boolean belowIngestSizeLimit: type: boolean dataverseAccessible: type: boolean DataverseMetadataBlockFacet: type: object properties: id: format: int64 type: integer dataverse: $ref: '#/components/schemas/Dataverse' metadataBlock: $ref: '#/components/schemas/MetadataBlock' DatasetFieldType: type: object properties: id: format: int64 type: integer name: type: string title: type: string description: type: string fieldType: $ref: '#/components/schemas/FieldType' allowControlledVocabulary: type: boolean watermark: type: string validationFormat: type: string dataverseFacets: uniqueItems: true type: array items: $ref: '#/components/schemas/DataverseFacet' dataverseFieldTypeInputLevels: uniqueItems: true type: array items: $ref: '#/components/schemas/DataverseFieldTypeInputLevel' searchValue: type: string listValues: type: array items: type: string controlledVocabularyValuesByStrValue: type: object additionalProperties: $ref: '#/components/schemas/ControlledVocabularyValue' requiredDV: type: boolean include: type: boolean optionSelectItems: type: array items: {} displayOrder: format: int32 type: integer displayFormat: type: string allowMultiples: type: boolean facetable: type: boolean displayOnCreate: type: boolean localDisplayOnCreate: type: boolean metadataBlock: $ref: '#/components/schemas/MetadataBlock' uri: type: string controlledVocabularyValues: type: array items: $ref: '#/components/schemas/ControlledVocabularyValue' childDatasetFieldTypes: type: array items: $ref: '#/components/schemas/DatasetFieldType' parentDatasetFieldType: $ref: '#/components/schemas/DatasetFieldType' required: type: boolean advancedSearchFieldType: type: boolean datasetFields: type: array items: $ref: '#/components/schemas/DatasetField' datasetFieldDefaultValues: type: array items: $ref: '#/components/schemas/DatasetFieldDefaultValue' sanitizeHtml: type: boolean escapeOutputText: type: boolean controlledVocabulary: type: boolean jsonLDTerm: $ref: '#/components/schemas/JsonLDTerm' primitive: type: boolean compound: type: boolean child: type: boolean subField: type: boolean hasChildren: type: boolean hasRequiredChildren: type: boolean hasParent: type: boolean displayName: type: string facetDisplayName: type: string solrField: $ref: '#/components/schemas/SolrField' localeTitle: type: string localeDescription: type: string localeWatermark: type: string tmpNullFieldTypeIdentifier: type: string VariableRangeType: enum: - MIN - MAX - MIN_EXCLUSIVE - MAX_EXCLUSIVE - POINT type: string DatasetFieldsValidator: type: object properties: datasetFieldService: $ref: '#/components/schemas/DatasetFieldServiceBean' DataverseServiceBean: type: object properties: indexService: $ref: '#/components/schemas/IndexServiceBean' solrIndexService: $ref: '#/components/schemas/SolrIndexServiceBean' authService: $ref: '#/components/schemas/AuthenticationServiceBean' datasetService: $ref: '#/components/schemas/DatasetServiceBean' dataverseLinkingService: $ref: '#/components/schemas/DataverseLinkingServiceBean' datasetLinkingService: $ref: '#/components/schemas/DatasetLinkingServiceBean' groupService: $ref: '#/components/schemas/GroupServiceBean' rolesService: $ref: '#/components/schemas/DataverseRoleServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' dataverseFieldTypeInputLevelService: $ref: '#/components/schemas/DataverseFieldTypeInputLevelServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' session: $ref: '#/components/schemas/DataverseSession' em: type: object datasetSchemaPreface: type: string startOfMDB: type: string reqValTemplate: type: string minItemsTemplate: type: string endOfReqVal: type: string endOfjson: type: string rootDataverseName: type: string rootDataverseExists: type: boolean dataverseCount: format: int64 type: integer GuestbookResponse: type: object properties: id: format: int64 type: integer guestbook: $ref: '#/components/schemas/Guestbook' dataFile: $ref: '#/components/schemas/DataFile' dataset: $ref: '#/components/schemas/Dataset' datasetVersion: $ref: '#/components/schemas/DatasetVersion' authenticatedUser: $ref: '#/components/schemas/AuthenticatedUser' fileAccessRequests: type: array items: $ref: '#/components/schemas/FileAccessRequest' customQuestionResponses: type: array items: $ref: '#/components/schemas/CustomQuestionResponse' name: maxLength: 255 type: string email: maxLength: 255 type: string institution: maxLength: 255 type: string position: maxLength: 255 type: string responseTime: format: date type: string example: '2022-03-10' sessionId: type: string eventType: type: string writeResponse: type: boolean selectedFileIds: type: string fileFormat: type: string externalTool: $ref: '#/components/schemas/ExternalTool' responseDate: type: string customQuestionResponsesSorted: type: array items: $ref: '#/components/schemas/CustomQuestionResponse' fileAccessRequest: type: array items: $ref: '#/components/schemas/FileAccessRequest' ControlledVocabularyValue: type: object properties: id: format: int64 type: integer strValue: type: string identifier: type: string displayOrder: format: int32 type: integer datasetFieldType: $ref: '#/components/schemas/DatasetFieldType' controlledVocabAlternates: type: array items: $ref: '#/components/schemas/ControlledVocabAlternate' localeStrValue: type: string PidProvider: type: object properties: providerInformation: type: array items: type: string urlPrefix: type: string separator: type: string protocol: type: string providerType: type: string id: type: string label: type: string authority: type: string shoulder: type: string identifierGenerationStyle: type: string pidProviderServiceBean: $ref: '#/components/schemas/PidProviderFactoryBean' datafilePidFormat: type: string managedSet: uniqueItems: true type: array items: type: string excludedSet: uniqueItems: true type: array items: type: string providerSpecification: type: object Embargo: type: object properties: id: format: int64 type: integer dateAvailable: format: date type: string example: '2022-03-10' reason: type: string dataFiles: type: array items: $ref: '#/components/schemas/DataFile' formattedDateAvailable: type: string DatasetTypeServiceBean: type: object properties: em: type: object Template: type: object properties: id: format: int64 type: integer name: maxLength: 255 type: string usageCount: format: int64 type: integer createTime: format: date type: string example: '2022-03-10' termsOfUseAndAccess: $ref: '#/components/schemas/TermsOfUseAndAccess' datasetFields: type: array items: $ref: '#/components/schemas/DatasetField' instructions: type: string instructionsMap: type: object additionalProperties: type: string metadataBlocksForView: type: object additionalProperties: type: array items: $ref: '#/components/schemas/DatasetField' metadataBlocksForEdit: type: object additionalProperties: type: array items: $ref: '#/components/schemas/DatasetField' isDefaultForDataverse: type: boolean dataversesHasAsDefault: type: array items: $ref: '#/components/schemas/Dataverse' dataverse: $ref: '#/components/schemas/Dataverse' createDate: type: string metadataValueBlocks: type: array items: $ref: '#/components/schemas/MetadataBlock' flatDatasetFields: type: array items: $ref: '#/components/schemas/DatasetField' DataTable: type: object properties: id: format: int64 type: integer unf: type: string caseQuantity: format: int64 type: integer varQuantity: format: int64 type: integer recordsPerCase: format: int64 type: integer dataFile: $ref: '#/components/schemas/DataFile' dataVariables: type: array items: $ref: '#/components/schemas/DataVariable' originalFileFormat: type: string originalFormatVersion: type: string originalFileSize: format: int64 type: integer originalFileName: type: string storedWithVariableHeader: type: boolean DatasetAuthor: type: object properties: datasetVersion: $ref: '#/components/schemas/DatasetVersion' name: $ref: '#/components/schemas/DatasetField' displayOrder: format: int32 type: integer affiliation: $ref: '#/components/schemas/DatasetField' idType: type: string idValue: type: string empty: type: boolean identifierAsUrl: type: string ExplicitGroupServiceBean: type: object properties: roleAssigneeSvc: $ref: '#/components/schemas/RoleAssigneeServiceBean' em: type: object provider: $ref: '#/components/schemas/ExplicitGroupProvider' VariableMetadata: type: object properties: id: format: int64 type: integer dataVariable: $ref: '#/components/schemas/DataVariable' fileMetadata: $ref: '#/components/schemas/FileMetadata' label: type: string literalquestion: type: string postquestion: type: string interviewinstruction: type: string universe: type: string notes: type: string isweightvar: type: boolean weighted: type: boolean categoriesMetadata: type: array items: $ref: '#/components/schemas/CategoryMetadata' weightvariable: $ref: '#/components/schemas/DataVariable' EjbDataverseEngineInner: type: object properties: ejbCtxt: type: object DefaultValueSet: type: object properties: id: format: int64 type: integer name: type: string datasetFieldDefaultValues: type: array items: $ref: '#/components/schemas/DatasetFieldDefaultValue' AuthenticationProvider: type: object properties: id: type: string info: $ref: '#/components/schemas/AuthenticationProviderDisplayInfo' order: format: int32 type: integer passwordUpdateAllowed: type: boolean userInfoUpdateAllowed: type: boolean userDeletionAllowed: type: boolean oAuthProvider: type: boolean emailVerified: type: boolean friendlyName: type: string JsonLDNamespace: type: object properties: prefix: type: string url: type: string MakeDataCountLoggingServiceBean: type: object properties: systemConfig: $ref: '#/components/schemas/SystemConfig' logFileName: type: string Scope: enum: - DATASET - FILE type: string Command: type: object properties: affectedDvObjects: type: object additionalProperties: $ref: '#/components/schemas/DvObject' request: $ref: '#/components/schemas/DataverseRequest' requiredPermissions: type: object additionalProperties: uniqueItems: true type: array items: $ref: '#/components/schemas/Permission' IndexAsync: type: object properties: solrIndexService: $ref: '#/components/schemas/SolrIndexServiceBean' DataverseFeaturedItem: required: - type type: object properties: id: format: int64 type: integer dataverse: $ref: '#/components/schemas/Dataverse' dvobject: $ref: '#/components/schemas/DvObject' content: maxLength: 15000 type: string displayOrder: format: int32 minimum: 0 type: integer type: pattern: \S type: string imageFileName: type: string imageFileUrl: type: string dvObject: $ref: '#/components/schemas/DvObject' DatasetDistributor: type: object properties: displayOrder: format: int32 type: integer name: $ref: '#/components/schemas/DatasetField' version: format: int64 type: integer url: $ref: '#/components/schemas/DatasetField' logo: $ref: '#/components/schemas/DatasetField' affiliation: $ref: '#/components/schemas/DatasetField' abbreviation: $ref: '#/components/schemas/DatasetField' empty: type: boolean UserServiceBean: type: object properties: em: type: object indexService: $ref: '#/components/schemas/IndexServiceBean' superUserCount: format: int64 type: integer totalUserCount: format: int64 type: integer LicenseServiceBean: type: object properties: em: type: object actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' default: $ref: '#/components/schemas/License' OrcidOAuth2AP: type: object properties: passwordUpdateAllowed: type: boolean userDeletionAllowed: type: boolean emailVerified: type: boolean friendlyName: type: string id: type: string title: type: string subTitle: type: string clientId: type: string clientSecret: type: string baseUserEndpoint: type: string redirectUrl: type: string scope: type: array items: type: string userInfoUpdateAllowed: type: boolean order: format: int32 type: integer iconHtml: type: string nullable: true spacedScope: type: string oAuthProvider: type: boolean apiInstance: type: object info: $ref: '#/components/schemas/AuthenticationProviderDisplayInfo' persistentIdUrlPrefix: type: string production: type: boolean DataVariable: type: object properties: id: format: int64 type: integer dataTable: $ref: '#/components/schemas/DataTable' name: type: string label: type: string weighted: type: boolean fileStartPosition: format: int64 type: integer fileEndPosition: format: int64 type: integer interval: $ref: '#/components/schemas/VariableInterval' type: $ref: '#/components/schemas/VariableType' format: type: string formatCategory: type: string recordSegmentNumber: format: int64 type: integer invalidRanges: type: array items: $ref: '#/components/schemas/VariableRange' invalidRangeItems: type: array items: $ref: '#/components/schemas/VariableRangeItem' summaryStatistics: type: array items: $ref: '#/components/schemas/SummaryStatistic' unf: type: string categories: type: array items: $ref: '#/components/schemas/VariableCategory' orderedFactor: type: boolean factor: type: boolean fileOrder: format: int32 type: integer numberOfDecimalPoints: format: int64 type: integer variableMetadatas: type: array items: $ref: '#/components/schemas/VariableMetadata' intervalLabel: type: string intervalDiscrete: type: boolean intervalContinuous: type: boolean intervalNominal: type: boolean intervalDichotomous: type: boolean typeNumeric: type: boolean typeCharacter: type: boolean categorical: type: boolean orderedCategorical: type: boolean WorkflowComment: type: object properties: id: format: int64 type: integer datasetVersion: $ref: '#/components/schemas/DatasetVersion' type: $ref: '#/components/schemas/Type1' message: type: string authenticatedUser: $ref: '#/components/schemas/AuthenticatedUser' created: type: object toBeShown: type: boolean DataverseRequestServiceBean: type: object properties: dataverseSessionSvc: $ref: '#/components/schemas/DataverseSession' request: type: object dataverseRequest: $ref: '#/components/schemas/DataverseRequest' FieldType: enum: - TEXT - TEXTBOX - STRING - DATE - EMAIL - URL - FLOAT - INT - NONE type: string GroupProvider: type: object properties: groupProviderAlias: type: string groupProviderInfo: type: string IngestRequest: type: object properties: id: format: int64 type: integer dataFile: $ref: '#/components/schemas/DataFile' textEncoding: type: string controlCard: type: string labelsFile: type: string forceTypeCheck: type: boolean ActionLogServiceBean: type: object properties: em: type: object EjbDataverseEngine: type: object properties: datasetService: $ref: '#/components/schemas/DatasetServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' rolesService: $ref: '#/components/schemas/DataverseRoleServiceBean' usersService: $ref: '#/components/schemas/BuiltinUserServiceBean' indexService: $ref: '#/components/schemas/IndexServiceBean' indexBatchService: $ref: '#/components/schemas/IndexBatchServiceBean' solrIndexService: $ref: '#/components/schemas/SolrIndexServiceBean' searchServiceFactory: $ref: '#/components/schemas/SearchServiceFactory' ingestService: $ref: '#/components/schemas/IngestServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' dvObjectService: $ref: '#/components/schemas/DvObjectServiceBean' dataverseFacetService: $ref: '#/components/schemas/DataverseFacetServiceBean' featuredDataverseService: $ref: '#/components/schemas/FeaturedDataverseServiceBean' dataFileService: $ref: '#/components/schemas/DataFileServiceBean' templateService: $ref: '#/components/schemas/TemplateServiceBean' savedSearchService: $ref: '#/components/schemas/SavedSearchServiceBean' fieldTypeInputLevels: $ref: '#/components/schemas/DataverseFieldTypeInputLevelServiceBean' pidProviderFactory: $ref: '#/components/schemas/PidProviderFactoryBean' settings: $ref: '#/components/schemas/SettingsServiceBean' guestbookService: $ref: '#/components/schemas/GuestbookServiceBean' responses: $ref: '#/components/schemas/GuestbookResponseServiceBean' metadataBlockService: $ref: '#/components/schemas/MetadataBlockServiceBean' datasetTypeService: $ref: '#/components/schemas/DatasetTypeServiceBean' dvLinking: $ref: '#/components/schemas/DataverseLinkingServiceBean' dsLinking: $ref: '#/components/schemas/DatasetLinkingServiceBean' dsField: $ref: '#/components/schemas/DatasetFieldServiceBean' explicitGroups: $ref: '#/components/schemas/ExplicitGroupServiceBean' groups: $ref: '#/components/schemas/GroupServiceBean' roleAssignees: $ref: '#/components/schemas/RoleAssigneeServiceBean' userNotificationService: $ref: '#/components/schemas/UserNotificationServiceBean' authentication: $ref: '#/components/schemas/AuthenticationServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' privateUrlService: $ref: '#/components/schemas/PrivateUrlServiceBean' datasetVersionService: $ref: '#/components/schemas/DatasetVersionServiceBean' dataCaptureModule: $ref: '#/components/schemas/DataCaptureModuleServiceBean' em: type: object logSvc: $ref: '#/components/schemas/ActionLogServiceBean' workflowService: $ref: '#/components/schemas/WorkflowServiceBean' fileDownloadService: $ref: '#/components/schemas/FileDownloadServiceBean' confirmEmailService: $ref: '#/components/schemas/ConfirmEmailServiceBean' storageUseService: $ref: '#/components/schemas/StorageUseServiceBean' dataverseFeaturedItemServiceBean: $ref: '#/components/schemas/DataverseFeaturedItemServiceBean' licenseServiceBean: $ref: '#/components/schemas/LicenseServiceBean' datasetFieldsValidator: $ref: '#/components/schemas/DatasetFieldsValidator' innerEngine: $ref: '#/components/schemas/EjbDataverseEngineInner' cacheFactory: $ref: '#/components/schemas/CacheFactoryBean' ejbCtxt: type: object ctxt: $ref: '#/components/schemas/CommandContext' context: $ref: '#/components/schemas/CommandContext' DataverseFacetServiceBean: type: object properties: em: type: object dataverses: $ref: '#/components/schemas/DataverseServiceBean' SettingsServiceBean: type: object properties: em: type: object actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' configuredLanguages: uniqueItems: true type: array items: type: string DataverseRequest: type: object properties: user: $ref: '#/components/schemas/User' sourceAddress: $ref: '#/components/schemas/IpAddress' invocationId: type: string httpServletRequest: type: object authenticatedUser: $ref: '#/components/schemas/AuthenticatedUser' wFInvocationId: type: string MailDomainGroupProvider: type: object properties: emailGroupSvc: $ref: '#/components/schemas/MailDomainGroupServiceBean' groupProviderAlias: type: string groupProviderInfo: type: string DatasetType: type: object properties: id: format: int64 type: integer name: type: string metadataBlocks: type: array items: $ref: '#/components/schemas/MetadataBlock' licenses: type: array items: $ref: '#/components/schemas/License' IpGroupProvider: type: object properties: ipGroupsService: $ref: '#/components/schemas/IpGroupsServiceBean' groupProviderAlias: type: string groupProviderInfo: type: string RoleAssignment: type: object properties: id: format: int64 type: integer assigneeIdentifier: type: string role: $ref: '#/components/schemas/DataverseRole' definitionPoint: $ref: '#/components/schemas/DvObject' privateUrlToken: type: string privateUrlAnonymizedAccess: type: boolean anonymizedAccess: type: boolean CommandContext: type: object properties: commandsCalled: type: array items: $ref: '#/components/schemas/Command' Dataset: type: object properties: mergeable: type: boolean id: format: int64 type: integer 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' released: type: boolean instanceofDataverse: type: boolean instanceofDataset: type: boolean instanceofDataFile: type: boolean dataverseContext: $ref: '#/components/schemas/Dataverse' authorString: type: string yearPublishedCreated: type: string storageDriver: type: string metadataLanguage: type: string guestbookAtRequest: type: boolean pidGeneratorSpecs: type: string pidGenerator: $ref: '#/components/schemas/PidProvider' storageUse: $ref: '#/components/schemas/StorageUse' datasetFileCountLimit: format: int32 type: integer externalLabelSetName: type: string owner: $ref: '#/components/schemas/Dataverse' effectivelyPermissionRoot: type: boolean effectiveStorageDriverId: type: string storageDriverId: type: string effectiveMetadataLanguage: type: string effectiveGuestbookEntryAtRequest: type: boolean guestbookEntryAtRequest: type: string effectiveCurationLabelSetName: type: string curationLabelSetName: type: string pidGeneratorId: type: string effectivePidGenerator: $ref: '#/components/schemas/PidProvider' effectiveDatasetFileCountLimit: format: int32 type: integer files: type: array items: $ref: '#/components/schemas/DataFile' lastExportTime: format: date type: string example: '2022-03-10' versions: type: array items: $ref: '#/components/schemas/DatasetVersion' datasetLocks: uniqueItems: true type: array items: $ref: '#/components/schemas/DatasetLock' thumbnailFile: $ref: '#/components/schemas/DataFile' datasetMetrics: type: array items: $ref: '#/components/schemas/DatasetMetrics' datasetExternalCitations: type: array items: $ref: '#/components/schemas/DatasetExternalCitations' useGenericThumbnail: type: boolean datasetType: $ref: '#/components/schemas/DatasetType' guestbook: $ref: '#/components/schemas/Guestbook' datasetLinkingDataverses: type: array items: $ref: '#/components/schemas/DatasetLinkingDataverse' fileAccessRequest: type: boolean dataFileCategories: type: array items: $ref: '#/components/schemas/DataFileCategory' citationDateDatasetFieldType: $ref: '#/components/schemas/DatasetFieldType' embargoCitationDate: type: object template: $ref: '#/components/schemas/Template' harvestedFrom: $ref: '#/components/schemas/HarvestingClient' harvestIdentifier: type: string locks: uniqueItems: true type: array items: $ref: '#/components/schemas/DatasetLock' locked: type: boolean persistentURL: type: string deaccessioned: type: boolean latestVersion: $ref: '#/components/schemas/DatasetVersion' latestVersionForCopy: $ref: '#/components/schemas/DatasetVersion' orCreateEditVersion: $ref: '#/components/schemas/DatasetVersion' mostRecentMajorVersionReleaseDate: format: date type: string example: '2022-03-10' releasedVersion: $ref: '#/components/schemas/DatasetVersion' categories: type: array items: $ref: '#/components/schemas/DataFileCategory' fileCategories: type: array items: $ref: '#/components/schemas/DataFileCategory' categoriesByName: type: array items: type: string categoryNames: type: array items: type: string fileSystemDirectory: type: array deprecated: true alternativePersistentIdentifier: type: string protocolForFileStorage: type: string authorityForFileStorage: type: string identifierForFileStorage: type: string nextMajorVersionString: type: string nextMinorVersionString: type: string versionNumber: format: int32 type: integer minorVersionNumber: format: int32 type: integer citation: type: string publicationDateFormattedYYYYMMDD: type: string citationDate: type: object citationDateFormattedYYYYMMDD: type: string harvested: type: boolean localURL: type: string remoteArchiveURL: type: string harvestingDescription: type: string displayName: type: string currentName: type: string permissionRoot: type: boolean targetUrl: type: string Alignment: enum: - LEFT - CENTER - RIGHT type: string DownloadInfo: type: object properties: dataFile: $ref: '#/components/schemas/DataFile' authUserName: type: string authMethod: type: string accessGranted: type: boolean accessPermissionsApply: type: boolean accessRestrictionsApply: type: boolean passAccessPermissions: type: boolean passAccessRestrictions: type: boolean optionalServicesAvailable: type: array items: $ref: '#/components/schemas/OptionalAccessService' accessRestrictionsAply: type: boolean mimeType: type: string dataFileId: format: int64 type: integer fileName: type: string servicesAvailable: type: array items: $ref: '#/components/schemas/OptionalAccessService' DataverseHeaderFragment: type: object properties: dataverseService: $ref: '#/components/schemas/DataverseServiceBean' groupService: $ref: '#/components/schemas/GroupServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' datasetVersionService: $ref: '#/components/schemas/DatasetVersionServiceBean' datafileService: $ref: '#/components/schemas/DataFileServiceBean' bannerMessageService: $ref: '#/components/schemas/BannerMessageServiceBean' dataverseSession: $ref: '#/components/schemas/DataverseSession' settingsWrapper: $ref: '#/components/schemas/SettingsWrapper' navigationWrapper: $ref: '#/components/schemas/NavigationWrapper' userNotificationService: $ref: '#/components/schemas/UserNotificationServiceBean' breadcrumbs: type: array items: $ref: '#/components/schemas/Breadcrumb' bannerMessages: type: array items: $ref: '#/components/schemas/BannerMessage' unreadNotificationCount: format: int64 type: integer signupAllowed: type: boolean loginRedirectPage: type: string Retention: type: object properties: id: format: int64 type: integer dateUnavailable: format: date type: string example: '2022-03-10' reason: type: string dataFiles: type: array items: $ref: '#/components/schemas/DataFile' formattedDateUnavailable: type: string ShibGroupServiceBean: type: object properties: em: type: object roleAssigneeSvc: $ref: '#/components/schemas/RoleAssigneeServiceBean' groupService: $ref: '#/components/schemas/GroupServiceBean' actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' settingService: $ref: '#/components/schemas/SettingsServiceBean' FileAccessRequest: type: object properties: id: format: int64 type: integer dataFile: $ref: '#/components/schemas/DataFile' user: $ref: '#/components/schemas/AuthenticatedUser' guestbookResponse: $ref: '#/components/schemas/GuestbookResponse' requestState: $ref: '#/components/schemas/RequestState' creationTime: format: date type: string example: '2022-03-10' requester: $ref: '#/components/schemas/AuthenticatedUser' state: $ref: '#/components/schemas/RequestState' stateLabel: type: string stateCreated: type: boolean stateGranted: type: boolean stateRejected: type: boolean FileVersionDifference: type: object properties: newFileMetadata: $ref: '#/components/schemas/FileMetadata' originalFileMetadata: $ref: '#/components/schemas/FileMetadata' details: type: boolean same: type: boolean differenceSummaryGroups: type: array items: $ref: '#/components/schemas/FileDifferenceSummaryGroup' differenceDetailItems: type: array items: $ref: '#/components/schemas/FileDifferenceDetailItem' DatasetFieldValue: type: object properties: id: format: int64 type: integer value: type: string displayOrder: format: int32 type: integer datasetField: $ref: '#/components/schemas/DatasetField' validationMessage: type: string valueForEdit: type: string displayValue: type: string unsanitizedDisplayValue: type: string AuthenticatedUserDisplayInfo: type: object properties: title: type: string emailAddress: type: string lastName: type: string firstName: type: string position: type: string affiliation: type: string orcid: type: string orcidForDisplay: type: string BannerMessageServiceBean: type: object properties: em: type: object DataverseContact: type: object properties: id: format: int64 type: integer dataverse: $ref: '#/components/schemas/Dataverse' contactEmail: type: string displayOrder: format: int32 type: integer GuestbookServiceBean: type: object properties: em: type: object EmbargoServiceBean: type: object properties: em: type: object actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' DevOAuthAccountType: enum: - PRODUCTION - RANDOM_EMAIL0 - RANDOM_EMAIL1 - RANDOM_EMAIL2 - RANDOM_EMAIL3 type: string Cart: type: object properties: contents: type: array items: {} SolrField: type: object properties: nameSearchable: type: string nameFacetable: type: string solrType: $ref: '#/components/schemas/SolrType' allowedToBeMultivalued: type: boolean facetable: type: boolean HarvestingClient: type: object properties: id: format: int64 type: integer dataverse: $ref: '#/components/schemas/Dataverse' harvestedDatasets: type: array items: $ref: '#/components/schemas/Dataset' name: maxLength: 30 type: string harvestType: type: string harvestStyle: type: string harvestingUrl: type: string sourceName: type: string archiveUrl: type: string archiveDescription: type: string harvestingSet: type: string metadataPrefix: type: string customHttpHeaders: type: string allowHarvestingMissingCVV: type: boolean useListRecords: type: boolean useOaiIdAsPid: type: boolean harvestHistory: type: array items: $ref: '#/components/schemas/ClientHarvestRun' scheduled: type: boolean schedulePeriod: type: string scheduleHourOfDay: format: int32 type: integer scheduleDayOfWeek: format: int32 type: integer harvestingNow: type: boolean deleted: type: boolean oai: type: boolean metadataSource: type: string useListrecords: type: boolean useOaiIdentifiersAsPids: type: boolean runHistory: type: array items: $ref: '#/components/schemas/ClientHarvestRun' lastResult: type: string lastRun: $ref: '#/components/schemas/ClientHarvestRun' lastSuccessfulRun: $ref: '#/components/schemas/ClientHarvestRun' lastNonEmptyRun: $ref: '#/components/schemas/ClientHarvestRun' lastHarvestTime: format: date type: string example: '2022-03-10' lastSuccessfulHarvestTime: format: date type: string example: '2022-03-10' lastNonEmptyHarvestTime: format: date type: string example: '2022-03-10' lastHarvestedDatasetCount: format: int64 type: integer lastFailedDatasetCount: format: int64 type: integer lastDeletedDatasetCount: format: int64 type: integer scheduleDescription: type: string deleteInProgress: type: boolean GuestbookResponseServiceBean: type: object properties: dataverseService: $ref: '#/components/schemas/DataverseServiceBean' em: type: object totalDownloadCount: format: int64 type: integer IngestReport: type: object properties: id: format: int64 type: integer dataFile: $ref: '#/components/schemas/DataFile' report: type: string type: format: int32 type: integer status: format: int32 type: integer startTime: format: date type: string example: '2022-03-10' endTime: format: date type: string example: '2022-03-10' failure: type: boolean IpGroupsServiceBean: type: object properties: em: type: object actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' roleAssigneeSvc: $ref: '#/components/schemas/RoleAssigneeServiceBean' DataverseLinkingServiceBean: type: object properties: em: type: object dataverseService: $ref: '#/components/schemas/DataverseServiceBean' FileDifferenceSummaryItem: type: object properties: name: type: string added: format: int32 type: integer changed: format: int32 type: integer deleted: format: int32 type: integer replaced: format: int32 type: integer multiple: type: boolean DataFileServiceBean: type: object properties: dvObjectService: $ref: '#/components/schemas/DvObjectServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' userService: $ref: '#/components/schemas/UserServiceBean' settingsService: $ref: '#/components/schemas/SettingsServiceBean' ingestService: $ref: '#/components/schemas/IngestServiceBean' embargoService: $ref: '#/components/schemas/EmbargoServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' storageUseService: $ref: '#/components/schemas/StorageUseServiceBean' em: type: object DatasetMetrics: required: - dataset type: object properties: id: format: int64 type: integer dataset: $ref: '#/components/schemas/Dataset' monthYear: type: string viewsTotalRegular: format: int64 type: integer viewsUniqueRegular: format: int64 type: integer viewsTotalMachine: format: int64 type: integer viewsUniqueMachine: format: int64 type: integer downloadsTotalRegular: format: int64 type: integer downloadsUniqueRegular: format: int64 type: integer downloadsTotalMachine: format: int64 type: integer downloadsUniqueMachine: format: int64 type: integer countryCode: type: string viewsUnique: format: int64 type: integer viewsTotal: format: int64 type: integer downloadsUnique: format: int64 type: integer downloadsTotal: format: int64 type: integer month: type: string NavigationWrapper: type: object properties: session: $ref: '#/components/schemas/DataverseSession' redirectPage: type: string pageFromContext: type: string DataverseRoleServiceBean: type: object properties: em: type: object roleAssigneeService: $ref: '#/components/schemas/RoleAssigneeServiceBean' dataverseService: $ref: '#/components/schemas/DataverseServiceBean' indexService: $ref: '#/components/schemas/IndexServiceBean' solrIndexService: $ref: '#/components/schemas/SolrIndexServiceBean' indexAsync: $ref: '#/components/schemas/IndexAsync' DatasetLinkingServiceBean: type: object properties: em: type: object RequestState: enum: - CREATED - GRANTED - REJECTED type: string SavedSearch: type: object properties: id: format: int64 type: integer query: type: string savedSearchFilterQueries: type: array items: $ref: '#/components/schemas/SavedSearchFilterQuery' definitionPoint: $ref: '#/components/schemas/Dataverse' creator: $ref: '#/components/schemas/AuthenticatedUser' filterQueriesAsStrings: type: array items: type: string GroupServiceBean: type: object properties: ipGroupsService: $ref: '#/components/schemas/IpGroupsServiceBean' shibGroupService: $ref: '#/components/schemas/ShibGroupServiceBean' explicitGroupService: $ref: '#/components/schemas/ExplicitGroupServiceBean' affiliationGroupService: $ref: '#/components/schemas/AffiliationGroupServiceBean' mailDomainGroupService: $ref: '#/components/schemas/MailDomainGroupServiceBean' groupProviders: type: object additionalProperties: $ref: '#/components/schemas/GroupProvider' ipGroupProvider: $ref: '#/components/schemas/IpGroupProvider' shibGroupProvider: $ref: '#/components/schemas/ShibGroupProvider' explicitGroupProvider: $ref: '#/components/schemas/ExplicitGroupProvider' affiliationGroupProvider: $ref: '#/components/schemas/AffiliationGroupProvider' mailDomainGroupProvider: $ref: '#/components/schemas/MailDomainGroupProvider' roleAssigneeSvc: $ref: '#/components/schemas/RoleAssigneeServiceBean' CurationStatus: type: object properties: id: format: int64 type: integer label: type: string datasetVersion: $ref: '#/components/schemas/DatasetVersion' authenticatedUser: $ref: '#/components/schemas/AuthenticatedUser' createTime: format: date type: string example: '2022-03-10' noStatus: type: boolean PidProviderFactory: type: object properties: type: type: string DatasetVersionFilesServiceBean: type: object properties: em: type: object TermsOfUseAndAccess: type: object properties: id: format: int64 type: integer datasetVersion: $ref: '#/components/schemas/DatasetVersion' template: $ref: '#/components/schemas/Template' license: $ref: '#/components/schemas/License' termsOfUse: type: string termsOfAccess: type: string confidentialityDeclaration: type: string specialPermissions: type: string restrictions: type: string citationRequirements: type: string depositorRequirements: type: string conditions: type: string disclaimer: type: string dataAccessPlace: type: string originalArchive: type: string availabilityStatus: type: string contactForAccess: type: string sizeOfCollection: type: string studyCompletion: type: string fileAccessRequest: type: boolean validationMessage: type: string DatasetFieldDefaultValue: type: object properties: id: format: int64 type: integer datasetField: $ref: '#/components/schemas/DatasetFieldType' defaultValueSet: $ref: '#/components/schemas/DefaultValueSet' childDatasetFieldDefaultValues: type: array items: $ref: '#/components/schemas/DatasetFieldDefaultValue' parentDatasetFieldDefaultValue: $ref: '#/components/schemas/DatasetFieldDefaultValue' strValue: type: string displayOrder: format: int32 type: integer parentDatasetFieldValue: $ref: '#/components/schemas/DatasetFieldDefaultValue' empty: type: boolean AuxiliaryFileServiceBean: type: object properties: em: type: object systemConfig: $ref: '#/components/schemas/SystemConfig' storageUseService: $ref: '#/components/schemas/StorageUseServiceBean' AbstractOAuth2AuthenticationProvider: type: object properties: passwordUpdateAllowed: type: boolean userDeletionAllowed: type: boolean emailVerified: type: boolean friendlyName: type: string id: type: string title: type: string subTitle: type: string clientId: type: string clientSecret: type: string baseUserEndpoint: type: string redirectUrl: type: string scope: type: array items: type: string apiInstance: type: object userInfoUpdateAllowed: type: boolean info: $ref: '#/components/schemas/AuthenticationProviderDisplayInfo' order: format: int32 type: integer iconHtml: type: string nullable: true spacedScope: type: string oAuthProvider: type: boolean VariableServiceBean: type: object properties: em: type: object BannerMessage: type: object properties: id: format: int64 type: integer dismissibleByUser: type: boolean active: type: boolean bannerMessageTexts: type: array items: $ref: '#/components/schemas/BannerMessageText' userBannerMessages: type: array items: $ref: '#/components/schemas/UserBannerMessage' displayValue: type: string VersionState: enum: - DRAFT - RELEASED - ARCHIVED - DEACCESSIONED type: string SummaryStatistic: type: object properties: id: format: int64 type: integer dataVariable: $ref: '#/components/schemas/DataVariable' type: $ref: '#/components/schemas/SummaryStatisticType' value: type: string typeLabel: type: string typeByLabel: type: string typeMean: type: boolean typeMedian: type: boolean typeMode: type: boolean typeMin: type: boolean typeMax: type: boolean typeStdDev: type: boolean typeValid: type: boolean typeInvalid: type: boolean Type2: enum: - EXPLORE - CONFIGURE - PREVIEW - QUERY type: string AffiliationServiceBean: type: object properties: ipGroupsService: $ref: '#/components/schemas/IpGroupsServiceBean' session: $ref: '#/components/schemas/DataverseSession' affiliationFromIPAddress: type: string License: type: object properties: id: format: int64 type: integer name: type: string shortDescription: type: string uri: type: string iconUrl: type: string active: type: boolean isDefault: type: boolean sortOrder: format: int64 type: integer rightsIdentifier: type: string rightsIdentifierScheme: type: string schemeUri: type: string languageCode: type: string termsOfUseAndAccess: type: array items: $ref: '#/components/schemas/TermsOfUseAndAccess' default: type: boolean datasetFileDifferenceItem: type: object properties: fileId: type: string fileChecksumType: $ref: '#/components/schemas/ChecksumType' fileChecksumValue: type: string fileName1: type: string fileType1: type: string fileSize1: type: string fileCat1: type: string fileDesc1: type: string fileProvFree1: type: string fileRest1: type: string fileName2: type: string fileType2: type: string fileSize2: type: string fileCat2: type: string fileDesc2: type: string fileProvFree2: type: string fileRest2: type: string file1Empty: type: boolean file2Empty: type: boolean StorageUse: type: object properties: id: format: int64 type: integer dvObjectContainer: $ref: '#/components/schemas/DvObject' sizeInBytes: format: int64 type: integer AuthenticationProviderDisplayInfo: type: object properties: title: type: string subtitle: type: string id: type: string VariableRange: type: object properties: id: format: int64 type: integer dataVariable: $ref: '#/components/schemas/DataVariable' beginValue: type: string endValue: type: string beginValueType: $ref: '#/components/schemas/VariableRangeType' endValueType: $ref: '#/components/schemas/VariableRangeType' beginValueTypeMin: type: boolean beginValueTypeMax: type: boolean beginValueTypeMinExcl: type: boolean beginValueTypeMaxExcl: type: boolean beginValueTypePoint: type: boolean endValueTypeMin: type: boolean endValueTypeMax: type: boolean endValueTypeMinExcl: type: boolean endValueTypeMaxExcl: type: boolean endValueTypePoint: type: boolean AffiliationGroup: type: object properties: sortByString: type: string id: format: int64 type: integer persistedGroupAlias: type: string displayName: type: string description: type: string emaildomain: type: string alias: type: string displayInfo: $ref: '#/components/schemas/RoleAssigneeDisplayInfo' identifier: type: string provider: $ref: '#/components/schemas/AffiliationGroupProvider' editable: type: boolean groupProvider: $ref: '#/components/schemas/GroupProvider' MailDomainGroup: required: - emailDomains type: object properties: sortByString: type: string id: format: int64 type: integer persistedGroupAlias: type: string displayName: type: string description: type: string emaildomain: type: string alias: type: string displayInfo: $ref: '#/components/schemas/RoleAssigneeDisplayInfo' identifier: type: string emailDomains: minLength: 1 type: string isRegEx: type: boolean provider: $ref: '#/components/schemas/MailDomainGroupProvider' emailDomainsAsList: type: array items: type: string regEx: type: boolean groupProvider: $ref: '#/components/schemas/MailDomainGroupProvider' editable: type: boolean PrivateUrlServiceBean: type: object properties: em: type: object datasetServiceBean: $ref: '#/components/schemas/DatasetServiceBean' systemConfig: $ref: '#/components/schemas/SystemConfig' IpAddress: type: object properties: localhost: type: boolean AlternativePersistentIdentifier: type: object properties: id: format: int64 type: integer dvObject: $ref: '#/components/schemas/DvObject' protocol: type: string authority: type: string globalIdCreateTime: format: date type: string example: '2022-03-10' identifier: type: string identifierRegistered: type: boolean storageLocationDesignator: type: boolean DataCaptureModuleServiceBean: type: object FileMetadata: type: object properties: label: pattern: ^[^:<>;#/"\*\|\?\\]*$ type: string directoryLabel: type: string description: type: string restricted: type: boolean datasetVersion: $ref: '#/components/schemas/DatasetVersion' dataFile: $ref: '#/components/schemas/DataFile' provFreeForm: type: string variableMetadatas: type: array items: $ref: '#/components/schemas/VariableMetadata' varGroups: type: array items: $ref: '#/components/schemas/VarGroup' fileCategories: type: array items: $ref: '#/components/schemas/DataFileCategory' id: format: int64 type: integer version: format: int64 type: integer inPriorVersion: type: boolean selected: type: boolean restrictedUI: type: boolean fileVersionDifference: $ref: '#/components/schemas/FileVersionDifference' contributorNames: type: string categories: type: array items: $ref: '#/components/schemas/DataFileCategory' categoriesByName: type: array items: type: string categoryNamesAsJsonArrayBuilder: type: object fileDateToDisplay: type: string fileCitation: type: string ControlledVocabAlternate: type: object properties: id: format: int64 type: integer strValue: type: string datasetFieldType: $ref: '#/components/schemas/DatasetFieldType' controlledVocabularyValue: $ref: '#/components/schemas/ControlledVocabularyValue' User: type: object properties: identifier: type: string displayInfo: $ref: '#/components/schemas/RoleAssigneeDisplayInfo' sortByString: type: string authenticated: type: boolean superuser: type: boolean deactivated: type: boolean DataFile: required: - contentType type: object properties: mergeable: type: boolean id: format: int64 type: integer 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' released: type: boolean instanceofDataverse: type: boolean instanceofDataset: type: boolean instanceofDataFile: type: boolean dataverseContext: $ref: '#/components/schemas/Dataverse' authorString: type: string yearPublishedCreated: type: string contentType: pattern: ^.*/.*$ type: string checksumType: $ref: '#/components/schemas/ChecksumType' checksumValue: type: string rootDataFileId: format: int64 type: integer previousDataFileId: format: int64 type: integer filesize: format: int64 type: integer restricted: type: boolean provEntityName: type: string dataTables: type: array items: $ref: '#/components/schemas/DataTable' auxiliaryFiles: type: array items: $ref: '#/components/schemas/AuxiliaryFile' ingestReports: type: array items: $ref: '#/components/schemas/IngestReport' ingestRequest: $ref: '#/components/schemas/IngestRequest' dataFileTags: type: array items: $ref: '#/components/schemas/DataFileTag' fileMetadatas: type: array items: $ref: '#/components/schemas/FileMetadata' guestbookResponses: type: array items: $ref: '#/components/schemas/GuestbookResponse' fileAccessRequests: type: array items: $ref: '#/components/schemas/FileAccessRequest' fileAccessRequesters: type: array items: $ref: '#/components/schemas/AuthenticatedUser' ingestStatus: format: byte type: string thumbnailForDataset: $ref: '#/components/schemas/Dataset' embargo: $ref: '#/components/schemas/Embargo' retention: $ref: '#/components/schemas/Retention' deleted: type: boolean markedAsDuplicate: type: boolean duplicateFilename: type: string effectivelyPermissionRoot: type: boolean dataTable: $ref: '#/components/schemas/DataTable' tags: type: array items: $ref: '#/components/schemas/DataFileTag' tagLabels: type: array items: type: string tagLabelsAsJsonArrayBuilder: type: object ingestReport: $ref: '#/components/schemas/IngestReport' ingestReportMessage: type: string tabularData: type: boolean originalFileFormat: type: string originalFileSize: format: int64 type: integer originalFileName: type: string derivedOriginalFileName: type: string originalFormatLabel: type: string friendlyType: type: string owner: $ref: '#/components/schemas/Dataset' description: type: string draftFileMetadata: $ref: '#/components/schemas/FileMetadata' fileMetadata: $ref: '#/components/schemas/FileMetadata' latestFileMetadata: $ref: '#/components/schemas/FileMetadata' latestPublishedFileMetadata: $ref: '#/components/schemas/FileMetadata' friendlySize: type: string originalChecksumType: type: string storageIO: $ref: '#/components/schemas/StorageIODataFile' shapefileType: type: boolean image: type: boolean filePackage: type: boolean ingestScheduled: type: boolean ingestInProgress: type: boolean ingestProblem: type: boolean asThumbnailForDataset: $ref: '#/components/schemas/Dataset' unf: type: string harvested: type: boolean remoteArchiveURL: type: string harvestingDescription: type: string displayName: type: string directoryLabel: type: string currentName: type: string publicationDateFormattedYYYYMMDD: type: string createDateFormattedYYYYMMDD: type: string targetUrl: type: string deaccessioned: type: boolean MetadataBlockServiceBean: type: object properties: em: type: object FeaturedDataverseServiceBean: type: object properties: em: type: object dataverseService: $ref: '#/components/schemas/DataverseServiceBean' ChecksumType: enum: - MD5 - SHA1 - SHA256 - SHA512 type: string SearchServiceFactory: type: object properties: beanManager: type: object settingsService: $ref: '#/components/schemas/SettingsServiceBean' solrSearchService: $ref: '#/components/schemas/SearchService' serviceMap: type: object additionalProperties: $ref: '#/components/schemas/SearchService' defaultSearchService: $ref: '#/components/schemas/SearchService' availableServices: type: object additionalProperties: $ref: '#/components/schemas/SearchService' DatasetServiceBean: type: object properties: indexService: $ref: '#/components/schemas/IndexServiceBean' settingsService: $ref: '#/components/schemas/SettingsServiceBean' versionService: $ref: '#/components/schemas/DatasetVersionServiceBean' dvObjectService: $ref: '#/components/schemas/DvObjectServiceBean' authentication: $ref: '#/components/schemas/AuthenticationServiceBean' fileService: $ref: '#/components/schemas/DataFileServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' recordService: $ref: '#/components/schemas/OAIRecordServiceBean' commandEngine: $ref: '#/components/schemas/EjbDataverseEngine' systemConfig: $ref: '#/components/schemas/SystemConfig' fprLogService: $ref: '#/components/schemas/FailedPIDResolutionLoggingServiceBean' globusServiceBean: $ref: '#/components/schemas/GlobusServiceBean' userNotificationService: $ref: '#/components/schemas/UserNotificationServiceBean' em: type: object datasetCount: format: int64 type: integer SearchPermissionsServiceBean: type: object properties: userServiceBean: $ref: '#/components/schemas/AuthenticationServiceBean' dvObjectService: $ref: '#/components/schemas/DvObjectServiceBean' permissionService: $ref: '#/components/schemas/PermissionServiceBean' roleAssigneeService: $ref: '#/components/schemas/RoleAssigneeServiceBean' rolesSvc: $ref: '#/components/schemas/DataverseRoleServiceBean' authSvc: $ref: '#/components/schemas/AuthenticationServiceBean' groupService: $ref: '#/components/schemas/GroupServiceBean' settingsService: $ref: '#/components/schemas/SettingsServiceBean' FileDifferenceDetailItem: type: object properties: displayName: type: string originalValue: type: string newValue: type: string AffiliationGroupServiceBean: type: object properties: em: type: object actionLogSvc: $ref: '#/components/schemas/ActionLogServiceBean' roleAssigneeSvc: $ref: '#/components/schemas/RoleAssigneeServiceBean' affiliationGroupsCount: format: int64 type: integer VariableInterval: enum: - DISCRETE - CONTINUOUS - NOMINAL - DICHOTOMOUS type: string DownloadInstance: type: object properties: extraArguments: type: array items: {} downloadInfo: $ref: '#/components/schemas/DownloadInfo' conversionParam: type: string conversionParamValue: type: string auxiliaryFile: $ref: '#/components/schemas/AuxiliaryFile' command: $ref: '#/components/schemas/EjbDataverseEngine' dataverseRequestService: $ref: '#/components/schemas/DataverseRequestServiceBean' gbr: $ref: '#/components/schemas/GuestbookResponse' requestUriInfo: type: object requestHttpHeaders: type: object