Skip to content

API: Restricted Files & Terms of Access in the dataset #11772

@ChengShi-1

Description

@ChengShi-1

Overview of the Feature Request
For edit dataset terms, we have a section Restricted Files + Terms of Access applying for all files in a dataset.

  • restricted/unrestricted files with terms of access
    • with following fields
TermsOfAccess {
  fileAccessRequest: boolean
  termsOfAccessForRestrictedFiles?: string
  dataAccessPlace?: string
  originalArchive?: string
  availabilityStatus?: string
  contactForAccess?: string
  sizeOfCollection?: string
  studyCompletion?: string
  termsOfUse?: string
  confidentialityDeclaration?: string
  specialPermissions?: string
  restrictions?: string
  citationRequirements?: string
  depositorRequirements?: string
  conditions?: string
  disclaimer?: string
}
  • an update of terms of access to dataset metadata related api results is also needed

For restricted files, we have an api restrict files, only works for a single file.
However, in the description, it said

Note that some Dataverse installations do not allow the ability to restrict files (see :PublicInstall).
We may still need the API, but disallow it in the setting

Image

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
API User

What inspired the request?
IQSS/dataverse-frontend#799

Metadata

Metadata

Assignees

Labels

FY26 Sprint 5FY26 Sprint 5 (2025-08-27 - 2025-09-10)FY26 Sprint 6FY26 Sprint 6 (2025-09-10 - 2025-09-24)FY26 Sprint 7FY26 Sprint 7 (2025-09-24 - 2025-10-08)FY26 Sprint 8FY26 Sprint 8 (2025-10-08 - 2025-10-22)GREI Re-archIssues related to the GREI Dataverse rearchitectureOriginal size: 20SPAThese changes are required for the Dataverse SPASPA.Q3.2025.3Dataset Page: Edit TermsSize: 10A percentage of a sprint. 7 hours.Type: Featurea feature request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions