Merge pull request #11668 from IQSS/11634-api-get-available-file-categories

11634 api get available file categories

Author: ofahimIQSS

doc/release-notes/11634-get-dataset-file-available-categories-api.md

@@ -0,0 +1,4 @@
+### Get Dataset File Available Categories API
+
+- This  new endpoint allows the user to get all of the available file categories for a dataset, both built-in and custom.
+

doc/sphinx-guides/source/api/native-api.rst

@@ -3592,6 +3592,21 @@ See :ref:`:CustomDatasetSummaryFields` in the Installation Guide for how the lis
 
   curl "$SERVER_URL/api/datasets/summaryFieldNames"
 
+.. _get-available-dataset-file-categories:
+
+Get Available Dataset File Categories
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This api returns a list of Categories that may be applied to the files of a given dataset.
+
+.. code-block:: bash
+
+  export SERVER_URL=https://demo.dataverse.org
+  export PERSISTENT_IDENTIFIER=doi:10.5072/FK2/YD5QDG
+
+  curl "$SERVER_URL/api/datasets/:persistentId/availableFileCategories?persistentId=$PERSISTENT_IDENTIFIER"
+
+
 .. _guestbook-at-request-api:
 
 Configure When a Dataset Guestbook Appears (If Enabled)