Skip to content

Commit 9eca4ef

Browse files
committed
add to native api doc
1 parent a24aa7e commit 9eca4ef

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/sphinx-guides/source/api/native-api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4004,6 +4004,7 @@ Restrict Files
40044004
~~~~~~~~~~~~~~
40054005
40064006
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.
40074008
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.
40084009
40094010
A curl example using an ``id``
@@ -4055,6 +4056,8 @@ Note the behavior of the optional parameters:
40554056
- If restrict is false then enableAccessRequest and termsOfAccess are ignored
40564057
- If restrict is true and enableAccessRequest is false then termsOfAccess is required. A status of CONFLICT (409) will be returned if the termsOfAccess is missing
40574058
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+
40584061
The fully expanded example above (without environment variables) looks like this:
40594062
40604063
.. code-block:: bash

0 commit comments

Comments
 (0)