Skip to content

Commit

Permalink
Merge pull request #9690 from KimJinYeon/KimJinYeon-Basic-File-Access…
Browse files Browse the repository at this point in the history
…-Edited-(FilePIDsEnabled)

Clarify note about Basic File Access in API Guide
  • Loading branch information
kcondon authored Sep 19, 2023
2 parents 4e1bc5b + 6b3c583 commit e5f4e82
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/sphinx-guides/source/api/dataaccess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Basic access URI:

``/api/access/datafile/$id``

.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``.
.. note:: Files can be accessed using persistent identifiers. This is done by passing the constant ``:persistentId`` where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name ``persistentId``. However, this file access method is only effective when the FilePIDsEnabled option is enabled, which can be authorized by the admin. For further information, refer to :ref:`:FilePIDsEnabled`.

Example: Getting the file whose DOI is *10.5072/FK2/J8SJZB* ::

Expand Down

0 comments on commit e5f4e82

Please sign in to comment.