Skip to content

Clarify role_ids and published_states in API docs #12236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Parthsuii wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Clarify role_ids and published_states in API docs #12236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions doc/sphinx-guides/source/api/native-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8867,11 +8867,10 @@
export PUBLISHED_STATES=Unpublished
export PER_PAGE=10

curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/mydata/retrieve?role_ids=$ROLE_IDS&dvobject_types=$DVOBJECT_TYPES&published_states=$PUBLISHED_STATES&per_page=$PER_PAGE"

curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/mydata/retrieve?role_ids=6&role_ids=34&dvobject_types=Dataset&published_states=Published&published_states=Draft&published_states=In+Review&selected_page=1"
Parameters:

Check failure on line 8871 in doc/sphinx-guides/source/api/native-api.rst

View workflow job for this annotation

GitHub Actions / docs 

Explicit markup ends without a blank line; unexpected unindent.

``role_id`` Roles are customizable. Standard roles include:
``role_id`` Roles are customizable. Multiple "role_ids" parameters can be used to filter by several roles. Standard roles include:

- ``1`` = Admin
- ``2`` = File Downloader
Expand All @@ -8884,7 +8883,7 @@

``dvobject_types`` Type of object, several possible values among: ``DataFile`` , ``Dataset`` & ``Dataverse`` .

``published_states`` State of the object, several possible values among:``Published`` , ``Unpublished`` , ``Draft`` , ``Deaccessioned`` & ``In+Review`` .
``published_states`` State of the object. Multiple "published_states" parameters can be used. Several possible values among: ``Published`` , ``Unpublished`` , ``Draft`` , ``Deaccessioned`` & ``In+Review``

``per_page`` Number of results returned per page.

Expand All @@ -8896,7 +8895,7 @@

``order`` The order in which to sort. Can either be "asc" or "desc".

``fq`` A filter query to filter the list returned. Multiple "fq" parameters can be used.
``fq`` A filter query (Solr syntax) to narrow the list returned. Multiple "fq" parameters can be used.

MyData Collection List
~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading