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
The My Data API now supports the `metadata_fields`, `sort` and `order`, `show_collections` and `fq` parameters, which enhances its functionality and brings it in line with the search API.
This release removes an undocumented restriction on the API calls to get, set, and delete archival status. They did not work on deaccessioned dataset versions and now do. (See https://guides.dataverse.org/en/latest/api/native-api.html#get-the-archival-status-of-a-dataset-by-version )
Handles from hdl.handle.net with urls of `/citation` instead of `/dataset.xhtml` were not properly redirecting. This fix adds a lookup for alternate PID so `/citation` endpoint will redirect to `/dataset.xhtml`
You must have Edit Dataverse permission within the given dataverse collection to invoke this api.
1685
+
1642
1686
1643
1687
Dataverse Role Assignment History
1644
1688
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -8690,6 +8734,16 @@ Parameters:
8690
8734
8691
8735
``per_page`` Number of results returned per page.
8692
8736
8737
+
``metadata_fields`` Includes the requested fields for each dataset in the response. Multiple "metadata_fields" parameters can be used to include several fields. See :doc:`search` for further information on this parameter.
8738
+
8739
+
``show_collections`` Whether or not to include a list of parent and linked collections for each dataset search result.
8740
+
8741
+
``sort`` The sort field. Supported values include "name", "date" and "relevance".
8742
+
8743
+
``order`` The order in which to sort. Can either be "asc" or "desc".
8744
+
8745
+
``fq`` A filter query to filter the list returned. Multiple "fq" parameters can be used.
Copy file name to clipboardExpand all lines: doc/sphinx-guides/source/api/search.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Name Type Description
27
27
q string The search term or terms. Using "title:data" will search only the "title" field. "*" can be used as a wildcard either alone or adjacent to a term (i.e. "bird*"). For example, https://demo.dataverse.org/api/search?q=title:data . For a list of fields to search, please see https://github.com/IQSS/dataverse/issues/2558 (for now).
28
28
type string Can be either "dataverse", "dataset", or "file". Multiple "type" parameters can be used to include multiple types (i.e. ``type=dataset&type=file``). If omitted, all types will be returned. For example, https://demo.dataverse.org/api/search?q=*&type=dataset
29
29
subtree string The identifier of the Dataverse collection to which the search should be narrowed. The subtree of this Dataverse collection and all its children will be searched. Multiple "subtree" parameters can be used to include multiple Dataverse collections. For example, https://demo.dataverse.org/api/search?q=data&subtree=birds&subtree=cats .
30
-
sort string The sort field. Supported values include "name"and "date". See example under "order".
30
+
sort string The sort field. Supported values include "name", "date" and "relevance". See example under "order".
31
31
order string The order in which to sort. Can either be "asc" or "desc". For example, https://demo.dataverse.org/api/search?q=data&sort=name&order=asc
32
32
per_page int The number of results to return per request. The default is 10. The max is 1000. See :ref:`iteration example <iteration-example>`.
33
33
start int A cursor for paging through search results. See :ref:`iteration example <iteration-example>`.
0 commit comments