You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/sphinx-guides/source/api/native-api.rst
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4004,6 +4004,7 @@ Restrict Files
4004
4004
~~~~~~~~~~~~~~
4005
4005
4006
4006
Restrict or unrestrict an existing file where ``id`` is the database id of the file or ``pid`` is the persistent id (DOI or Handle) of the file to restrict. Note that some Dataverse installations do not allow the ability to restrict files (see :ref:`:PublicInstall`).
4007
+
Restricting or Unrestricting a file, not in a draft version of the Dataset, will result in a new Draft version being created.
4007
4008
Optionally the API can receive a JSON string with additional parameters related to the ability to request access to the file and the terms of that access.
4008
4009
4009
4010
A curl example using an ``id``
@@ -4055,6 +4056,8 @@ Note the behavior of the optional parameters:
4055
4056
- If restrict is falsethen enableAccessRequest and termsOfAccess are ignored
4056
4057
- If restrict is true and enableAccessRequest is falsethen termsOfAccess is required. A status of CONFLICT (409) will be returned if the termsOfAccess is missing
4057
4058
4059
+
The enableAccessRequest and termsOfAccess are applied to the Draft version of the Dataset and affect all of the restricted files in said Draft version.
4060
+
4058
4061
The fully expanded example above (without environment variables) looks like this:
0 commit comments