Skip to content

Commit

Permalink
Merge pull request #6179 from pkiraly/6178-fixing-implicit-API-refere…
Browse files Browse the repository at this point in the history
…nce-in-metadata-export-documentation

6178 fixing implicit api reference in metadata export documentation
  • Loading branch information
kcondon authored Sep 18, 2019
2 parents 210499a + 633f35b commit 6f8bdeb
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/sphinx-guides/source/admin/metadataexport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Batch exports through the API

In addition to the automated exports, a Dataverse admin can start a batch job through the API. The following 2 API calls are provided:

/api/admin/metadata/exportAll
``curl http://localhost:8080/api/admin/metadata/exportAll``

/api/admin/metadata/reExportAll
``curl http://localhost:8080/api/admin/metadata/reExportAll``

The former will attempt to export all the published, local (non-harvested) datasets that haven't been exported yet.
The latter will *force* a re-export of every published, local dataset, regardless of whether it has already been exported or not.
Expand Down
13 changes: 11 additions & 2 deletions doc/sphinx-guides/source/api/native-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -399,11 +399,20 @@ Get JSON Representation of a Dataset

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

GET http://$SERVER/api/datasets/:persistentId/?persistentId=doi:10.5072/FK2/J8SJZB
curl http://$SERVER/api/datasets/:persistentId/?persistentId=doi:10.5072/FK2/J8SJZB

fully expanded::

curl http://localhost:8080/api/datasets/:persistentId/?persistentId=doi:10.5072/FK2/J8SJZB

Getting its draft version::

GET http://$SERVER/api/datasets/:persistentId/versions/:draft?persistentId=doi:10.5072/FK2/J8SJZB
curl http://$SERVER/api/datasets/:persistentId/versions/:draft?persistentId=doi:10.5072/FK2/J8SJZB

fully expanded::

curl http://localhost:8080/api/datasets/:persistentId/versions/:draft?persistentId=doi:10.5072/FK2/J8SJZB


|CORS| Show the dataset whose id is passed::

Expand Down

0 comments on commit 6f8bdeb

Please sign in to comment.