Skip to content

Commit

Permalink
Merge branch '9852-files-api-deaccessioned-datasets' of github.com:IQ…
Browse files Browse the repository at this point in the history
…SS/dataverse into 9852-files-api-deaccessioned-datasets
  • Loading branch information
GPortas committed Oct 2, 2023
2 parents 02003f1 + 5c7830c commit 567fcb8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/sphinx-guides/source/api/native-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1020,9 +1020,9 @@ Usage example:
Please note that both filtering and ordering criteria values are case sensitive and must be correctly typed for the endpoint to recognize them.

By default, deaccessioned dataset versions are not supported by this endpoint and will be ignored in the search when applying the :latest or :latest-published identifiers. Additionally, when filtering by a specific version tag, you will get a not found error if the version is deaccessioned and you do not enable the option described below.
By default, deaccessioned dataset versions are not included in the search when applying the :latest or :latest-published identifiers. Additionally, when filtering by a specific version tag, you will get a "not found" error if the version is deaccessioned and you do not enable the ``includeDeaccessioned`` option described below.

If you want to consider deaccessioned dataset versions, you must specify this through the ``includeDeaccessioned`` query parameter.
If you want to consider deaccessioned dataset versions, you must set ``includeDeaccessioned`` query parameter to ``true``.

Usage example:

Expand Down

0 comments on commit 567fcb8

Please sign in to comment.