HDRUK Gateway API
- API version: 2.0.0
- Build date: 2026-07-31T14:18:38.823591782Z[Etc/UTC]
- Generator version: 7.24.0
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Automatically generated by the OpenAPI Generator
Building the API client library requires:
- Java 1.8+
- Maven (3.8.3+)/Gradle (7.2+)
To install the API client library to your local Maven repository, simply execute:
mvn clean installTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deployRefer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>uk.ac.hdruk.gatewayapi</groupId>
<artifactId>gateway-api-sdk</artifactId>
<version>0.0.0-test4</version>
<scope>compile</scope>
</dependency>Add this dependency to your project's build file:
repositories {
mavenCentral() // Needed if the 'gateway-api-sdk' jar has been published to maven central.
mavenLocal() // Needed if the 'gateway-api-sdk' jar has been published to the local maven repo.
}
dependencies {
implementation "uk.ac.hdruk.gatewayapi:gateway-api-sdk:0.0.0-test4"
}At first generate the JAR by executing:
mvn clean packageThen manually install the following JARs:
target/gateway-api-sdk-0.0.0-test4.jartarget/lib/*.jar
Please follow the installation instruction and execute the following Java code:
// Import classes:
import uk.ac.hdruk.gatewayapi.ApiClient;
import uk.ac.hdruk.gatewayapi.ApiException;
import uk.ac.hdruk.gatewayapi.Configuration;
import uk.ac.hdruk.gatewayapi.model.*;
import uk.ac.hdruk.gatewayapi.api.AdminDataCustodianNetworksApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
AdminDataCustodianNetworksApi apiInstance = new AdminDataCustodianNetworksApi(defaultClient);
Integer perPage = 1; // Integer | per page
try {
apiInstance.fetchAdminDataCustodianNetworks(perPage);
} catch (ApiException e) {
System.err.println("Exception when calling AdminDataCustodianNetworksApi#fetchAdminDataCustodianNetworks");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminDataCustodianNetworksApi | fetchAdminDataCustodianNetworks | GET /api/v2/admin/data_custodian_networks | DataCustodianNetworks@adminIndex |
| AdminSearchApi | createAdminSearchReindex | POST /api/v1/admin/search/reindex | Queue a drop+recreate+import of a search entity's Typesense collection |
| AdminSearchApi | fetchAdminSearchStatus | GET /api/v1/admin/search/status | Get Typesense collection status for every onboarded search entity |
| AdminSearchApi | updateAdminSearchFeature | POST /api/v1/admin/search/feature | Activate or deactivate a search-related Pennant feature flag |
| AliasApi | createAliases | POST /api/v1/aliases | AliasController@store |
| AliasApi | deleteAliases | DELETE /api/v1/aliases/{id} | AliasController@destroy |
| AliasApi | editAliases | PATCH /api/v1/aliases/{id} | AliasController@edit |
| AliasApi | fetchAliases | GET /api/v1/aliases/{id} | Return a single alias |
| AliasApi | fetchAllAliases | GET /api/v1/aliases | List of aliases |
| AliasApi | updateAliases | PUT /api/v1/aliases/{id} | AliasController@update |
| ApplicationApi | createApplications | POST /api/v1/applications | ApplicationController@store |
| ApplicationApi | deleteApplications | DELETE /api/v1/applications/{id} | ApplicationController@delete |
| ApplicationApi | editApplications | PATCH /api/v1/applications/{id} | ApplicationController@edit |
| ApplicationApi | fetchAllApplications | GET /api/v1/applications | ApplicationController@index |
| ApplicationApi | fetchAllSitemap | GET /api/v1/sitemap | SiteMapController@index |
| ApplicationApi | fetchApplications | GET /api/v1/applications/{id} | ApplicationController@show |
| ApplicationApi | patchApplicationsClientId | PATCH /api/v1/applications/{id}/clientid | ApplicationController@generateClientIdById |
| ApplicationApi | updateApplications | PUT /api/v1/applications/{id} | ApplicationController@update |
| AuthenticationApi | authentication | POST /api/v1/auth | AuthController@checkAuthorization |
| AuthenticationApi | login | POST /api/v1/auth/login | AuthController@login |
| AuthenticationApi | refreshToken | POST /api/v1/refresh_token | AuthController@refreshToken |
| AuthenticationApi | register | POST /api/v1/auth/register | AuthController@register |
| CancerTypeFilterApi | getCancerTypeFilter | GET /api/v1/cancer-type-filters/{filter_id} | Get a single cancer type filter |
| CancerTypeFilterApi | getCancerTypeFilters | GET /api/v1/cancer-type-filters | Get all cancer type filters |
| CategoryApi | createCategories | POST /api/v1/categories | Category@store |
| CategoryApi | deleteCategories | DELETE /api/v1/categories/{id} | Category@destroy |
| CategoryApi | editCategories | PATCH /api/v1/categories/{id} | Category@update |
| CategoryApi | fetchAllCategories | GET /api/v1/categories | Category@index |
| CategoryApi | fetchCategories | GET /api/v1/categories/{id} | Category@show |
| CategoryApi | updateCategories | PUT /api/v1/categories/{id} | Category@update |
| CollectionsApi | countTeamUniqueFieldsCollectionV2 | GET /api/v2/teams/{teamId}/collections/count/{field} | TeamCollectionController@count |
| CollectionsApi | countUniqueFieldsCollections | GET /api/v1/collections/count/{field} | CollectionController@count |
| CollectionsApi | countUniqueFieldsCollectionsV2 | GET /api/v2/collections/count/{field} | CollectionController@count |
| CollectionsApi | countUserUniqueFieldsCollectionV2 | GET /api/v2/users/{userId}/collections/count/{field} | UserCollectionController@count |
| CollectionsApi | createCollections | POST /api/v2/collections | CollectionController@store |
| CollectionsApi | createTeamCollections | POST /api/v1/teams/{teamId}/collections | CollectionController@store |
| CollectionsApi | createTeamCollectionsV2 | POST /api/v2/teams/{teamId}/collections | TeamCollectionController@store |
| CollectionsApi | createUserCollections | POST /api/v2/users/collections | UserCollectionController@store |
| CollectionsApi | deleteCollectionsV2 | DELETE /api/v2/collections/{id} | Delete a collection |
| CollectionsApi | deleteTeamCollections | DELETE /api/v1/teams/{teamId}/collections/{id} | Delete a collection |
| CollectionsApi | deleteTeamCollectionsV2 | DELETE /api/v2/teams/{teamId}/collections/{id} | Delete a collection |
| CollectionsApi | deleteUserCollectionsV2 | DELETE /api/v2/users/{userId}/collections/{id} | Delete a collection |
| CollectionsApi | editCollectionsV2 | PATCH /api/v2/collections/{id} | Edit a collection |
| CollectionsApi | editTeamCollections | PATCH /api/v1/teams/{teamId}/collections/{id} | Edit a collection |
| CollectionsApi | editTeamCollectionsV2 | PATCH /api/v2/teams/{teamId}/collections/{id} | Edit a collection |
| CollectionsApi | editUserCollectionsV2 | PATCH /api/v2/users/{userId}/collections/{id} | Edit a collection |
| CollectionsApi | fetchAllCollections | GET /api/v1/collections | CollectionController@index |
| CollectionsApi | fetchAllCollectionsV2 | GET /api/v2/collections | CollectionController@index |
| CollectionsApi | fetchCollections | GET /api/v1/collections/{id} | CollectionController@show |
| CollectionsApi | fetchCollectionsV2 | GET /api/v2/collections/{id} | CollectionController@show |
| CollectionsApi | fetchTeamActiveCollectionsV2 | GET /api/v2/teams/{teamId}/collections/status/active | TeamCollectionController@indexActive |
| CollectionsApi | fetchTeamArchivedCollectionsV2 | GET /api/v2/teams/{teamId}/collections/status/archived | TeamCollectionController@indexArchived |
| CollectionsApi | fetchTeamCollectionV2 | GET /api/v2/teams/{teamId}/collections/{id} | TeamCollectionController@show |
| CollectionsApi | fetchTeamDraftCollectionsV2 | GET /api/v2/teams/{teamId}/collections/status/draft | TeamCollectionController@indexDraft |
| CollectionsApi | fetchUserArchivedCollectionsV2 | GET /api/v2/users/{userId}/collections/status/archived | UserCollectionController@indexArchived |
| CollectionsApi | fetchUserCollectionV2 | GET /api/v2/users/{userId}/collections/{id} | CollectionController@show |
| CollectionsApi | fetchUserCollectionsV2 | GET /api/v2/users/{userId}/collections/status/active | UserCollectionController@indexActive |
| CollectionsApi | fetchUserDraftCollectionsV2 | GET /api/v2/users/{userId}/collections/status/draft | UserCollectionController@indexDraft |
| CollectionsApi | updateCollectionsV2 | PUT /api/v2/collections/{id} | Update a collection |
| CollectionsApi | updateTeamCollections | PUT /api/v1/teams/{teamId}/collections/{id} | Update a collection |
| CollectionsApi | updateTeamCollectionsV2 | PUT /api/v2/teams/{teamId}/collections/{id} | Update a collection |
| CollectionsApi | updateUserCollectionsV2 | PUT /api/v2/users/{userId}/collections/{id} | Update a collection |
| CustomerSatisfactionApi | createCsat | POST /api/v1/csat | Create Customer Satisfaction Score |
| CustomerSatisfactionApi | editCsat | PATCH /api/v1/csat/{id} | Update Customer Satisfaction Description |
| DarIntegrationApi | createDarIntegration | POST /api/v1/dar-integration/{id} | DarIntegration@store |
| DarIntegrationApi | deleteDarIntegration | DELETE /api/v1/dar-integrations/{id} | DarIntegration@destroy |
| DarIntegrationApi | editDarIntegration | PATCH /api/v1/dar-integration/{id} | DarIntegration@edit |
| DarIntegrationApi | fetchAllDarIntegrations | GET /api/v1/dar-integration | DarIntegration@index |
| DarIntegrationApi | fetchDarIntegration | GET /api/v1/dar-integration/{id} | DarIntegration@show |
| DarIntegrationApi | updateDarIntegration | PUT /api/v1/dar-integration/{id} | DarIntegration@update |
| DataAccessApplicationApi | createDarApplications | POST /api/v1/dar/applications | DataAccessApplication@store |
| DataAccessApplicationApi | deleteDarApplicationFiles | DELETE /api/v1/dar/applications/{id}/files/{fileId} | DataAccessApplication@destroyFile |
| DataAccessApplicationApi | deleteDarApplications | DELETE /api/v1/dar/applications/{id} | DataAccessApplication@destroy |
| DataAccessApplicationApi | deleteTeamDarApplicationFile | DELETE /api/v1/teams/{teamId}/dar/applications/{id}/files/{fileId} | DataAccessApplication@destroyFile |
| DataAccessApplicationApi | deleteUserDarApplication | DELETE /api/v1/users/{userId}/dar/applications/{id} | DataAccessApplication@destroy |
| DataAccessApplicationApi | deleteUserDarApplicationFile | DELETE /api/v1/users/{userId}/dar/applications/{id}/files/{fileId} | DataAccessApplication@destroyFile |
| DataAccessApplicationApi | fetchTeamDarApplicationAnswers | GET /api/v1/teams/{teamId}/dar/applications/{id}/answers | DataAccessApplication@showAnswers |
| DataAccessApplicationApi | fetchTeamDarApplicationDownloadZip | GET /api/v1/teams/{teamId}/dar/applications/{id}/download | DataAccessApplication@download |
| DataAccessApplicationApi | fetchTeamDarApplicationFile | GET /api/v1/teams/{teamId}/dar/applications/{id}/files/{fileId}/download | DataAccessApplication@downloadFile |
| DataAccessApplicationApi | fetchTeamDarApplicationFiles | GET /api/v1/teams/{teamId}/dar/applications/{id}/files | DataAccessApplication@showFiles |
| DataAccessApplicationApi | fetchTeamDarApplicationStatusHistory | GET /api/v1/teams/{teamId}/dar/applications/{id}/status | DataAccessApplication@status |
| DataAccessApplicationApi | fetchUserDarApplicationFile | GET /api/v1/users/{userId}/dar/applications/{id}/files/{fileId}/download | DataAccessApplication@downloadFile |
| DataAccessApplicationApi | fetchUserDarApplicationFiles | GET /api/v1/users/{userId}/dar/applications/{id}/files | DataAccessApplication@showFiles |
| DataAccessApplicationApi | patchUserDarApplication | PATCH /api/v1/users/{userId}/dar/applications/{id} | DataAccessApplication@update |
| DataAccessApplicationApi | updateTeamDarApplication | PATCH /api/v1/teams/{teamId}/dar/applications/{id} | DataAccessApplication@update |
| DataAccessApplicationApi | updateUserDarApplication | PUT /api/v1/users/{userId}/dar/applications/{id} | DataAccessApplication@update |
| DataAccessApplicationReviewApi | createTeamDarApplicationQuestionReview | POST /api/v1/teams/{team_id}/dar/applications/{id}/questions/{questionId}/reviews | DataAccessApplicationReview@store |
| DataAccessApplicationReviewApi | createTeamDarApplicationReview | POST /api/v1/teams/{team_id}/dar/applications/{id}/reviews | DataAccessApplicationReview@storeGlobal |
| DataAccessApplicationReviewApi | deleteTeamDarApplicationQuestionReview | DELETE /api/v1/teams/{team_id}/dar/applications/{id}/questions/{questionId}/reviews/{reviewId} | DataAccessApplicationReview@destroy |
| DataAccessApplicationReviewApi | deleteTeamDarApplicationReview | DELETE /api/v1/teams/{team_id}/dar/applications/{id}/reviews/{reviewId} | DataAccessApplicationReview@destroyGlobal |
| DataAccessApplicationReviewApi | deleteTeamDarApplicationReviewFile | DELETE /api/v1/teams/{teamId}/dar/applications/{id}/reviews/{reviewId}/files/{fileId} | DataAccessApplicationReview@destroyFile |
| DataAccessApplicationReviewApi | fetchTeamDarApplicationReviewFile | GET /ap1/v1/teams/{teamId}/dar/applications/{id}/reviews/{reviewId}/download/{fileId} | DataAccessApplicationReview@downloadFile |
| DataAccessApplicationReviewApi | fetchTeamDarApplicationReviews | GET /api/v1/teams/{team_id}/dar/applications/{id}/reviews | DataAccessApplicationReview@index |
| DataAccessApplicationReviewApi | fetchUserDarApplicationReviewFile | GET /ap1/v1/users/{userId}/dar/applications/{id}/reviews/{reviewId}/download/{fileId} | DataAccessApplicationReview@downloadUserFile |
| DataAccessApplicationReviewApi | fetchUserDarApplicationReviews | GET /api/v1/users/{userId}/dar/applications/{id}/reviews | DataAccessApplicationReview@index |
| DataAccessApplicationReviewApi | updateTeamDarApplicationQuestionReview | PUT /api/v1/teams/{team_id}/dar/applications/{id}/questions/{questionId}/reviews/{reviewId} | DataAccessApplicationReview@update |
| DataAccessApplicationReviewApi | updateTeamDarApplicationReview | PUT /api/v1/teams/{team_id}/dar/applications/{id}/reviews/{reviewId} | DataAccessApplicationReview@updateGlobal |
| DataAccessApplicationReviewApi | updateUserDarApplicationQuestionReview | PUT /api/v1/users/{userId}/dar/applications/{id}/questions/{questionId}/reviews/{reviewId} | DataAccessApplicationReview@userUpdate |
| DataAccessApplicationReviewApi | updateUserDarApplicationReview | PUT /api/v1/users/{userId}/dar/applications/{id}/reviews/{reviewId} | DataAccessApplicationReview@userUpdateGlobal |
| DataAccessSectionApi | createDarSection | POST /api/v1/dar/sections | DataAccessSection@store |
| DataAccessSectionApi | deleteDarSection | DELETE /api/v1/dar/sections/{id} | DataAccessSection@destroy |
| DataAccessSectionApi | fetchDarSection | GET /api/v1/dar/sections/{id} | DataAccessSection@show |
| DataAccessSectionApi | fetchDarSections | GET /api/v1/dar/sections | DataAccessSection@index |
| DataAccessSectionApi | patchDarSection | PATCH /api/v1/dar/sections/{id} | DataAccessSection@update |
| DataAccessSectionApi | updateDarSection | PUT /api/v1/dar/sections/{id} | DataAccessSection@update |
| DataAccessTemplateApi | createDarTemplate | POST /api/v1/dar/templates | DataAccessTemplate@store |
| DataAccessTemplateApi | deleteDarTemplate | DELETE /api/v1/dar/templates/{id} | DataAccessTemplate@destroy |
| DataAccessTemplateApi | downloadDarTemplateFile | GET /api/v1/dar/templates/{id}/download | DataAccessTemplate@downloadFile |
| DataAccessTemplateApi | fetchDarTemplate | GET /api/v1/dar/templates/{id} | DataAccessTemplate@show |
| DataAccessTemplateApi | fetchDarTemplates | GET /api/v1/dar/templates | DataAccessTemplate@index |
| DataAccessTemplateApi | patchDarTemplate | PATCH /api/v1/dar/templates/{id} | DataAccessTemplate@update |
| DataAccessTemplateApi | updateDarTemplate | PUT /api/v1/dar/templates/{id} | DataAccessTemplate@update |
| DataAccessTemplatesApi | darTemplateCountUniqueFields | GET /api/v1/dar/templates/count/{field} | DataAccessTemplateController@count |
| DataCustodianNetworksApi | createDataCustodianNetwork | POST /api/v2/data_custodian_networks | DataCustodianNetworks@store |
| DataCustodianNetworksApi | deleteDataCustodianNetwork | DELETE /api/v2/data_custodian_networks/{id} | DataCustodianNetworks@destroy |
| DataCustodianNetworksApi | editDataCustodianNetwork | PATCH /api/v2/data_custodian_networks/{id} | DataCustodianNetworks@edit |
| DataCustodianNetworksApi | fetchDataCustodianNetwork | GET /api/v2/data_custodian_networks/{id} | DataCustodianNetworks@show |
| DataCustodianNetworksApi | fetchDataCustodianNetworkCustodiansSummary | GET /api/v2/data_custodian_networks/{id}/custodians_summary | DataCustodianNetworks@showCustodiansSummary |
| DataCustodianNetworksApi | fetchDataCustodianNetworkDatasetsSummary | GET /api/v2/data_custodian_networks/{id}/datasets_summary | DataCustodianNetworks@showDatasetsSummary |
| DataCustodianNetworksApi | fetchDataCustodianNetworkEntitiesSummary | GET /api/v2/data_custodian_networks/{id}/entities_summary | DataCustodianNetworks@showSummary |
| DataCustodianNetworksApi | fetchDataCustodianNetworkInfo | GET /api/v2/data_custodian_networks/{id}/info | DataCustodianNetworks@showInfoSummary |
| DataCustodianNetworksApi | fetchDataCustodianNetworks | GET /api/v2/data_custodian_networks | DataCustodianNetworks@index |
| DataCustodianNetworksApi | updateDataCustodianNetwork | PUT /api/v2/data_custodian_networks/{id} | DataCustodianNetworks@update |
| DataProviderCollApi | createDataProviderColl | POST /api/v1/data_provider_colls | DataProviderColl@store |
| DataProviderCollApi | deleteDataProviderColl | DELETE /api/v1/data_provider_colls/{id} | DataProviderColl@destroy |
| DataProviderCollApi | editDataProviderColl | PATCH /api/v1/data_provider_colls/{id} | DataProviderColl@edit |
| DataProviderCollApi | fetchDataProviderColl | GET /api/v1/data_provider_colls/{id} | DataProviderColl@show |
| DataProviderCollApi | fetchDataProviderCollSummary | GET /api/v1/data_provider_colls/{id}/summary | DataProviderColl@showSummary |
| DataProviderCollApi | fetchDataProviderColls | GET /api/v1/data_provider_colls | DataProviderColl@index |
| DataProviderCollApi | updateDataProviderColl | PUT /api/v1/data_provider_colls/{id} | DataProviderColl@update |
| DataUseRegistersApi | countTeamUniqueFieldsDurV2 | GET /api/v2/teams/{teamId}/dur/count/{field} | TeamDurController@count |
| DataUseRegistersApi | createDur | POST /api/v1/dur | DurController@store |
| DataUseRegistersApi | createDurByTeamV2 | POST /api/v2/teams/{teamId}/dur | TeamDurController@store |
| DataUseRegistersApi | deleteDur | DELETE /api/v1/dur/{id} | Delete a dur |
| DataUseRegistersApi | deleteDursV2ByTeamId | DELETE /api/v2/teams/{teamId}/dur/{id} | TeamDurController@destroy |
| DataUseRegistersApi | editDur | PATCH /api/v1/dur/{id} | Edit a dur |
| DataUseRegistersApi | editDursV2ByTeamId | PATCH /api/v2/teams/{teamId}/dur/{id} | TeamDurController@edit |
| DataUseRegistersApi | exportDurTemplate | GET /api/v1/dur/template | DurController@exportTemplate |
| DataUseRegistersApi | exportDurTemplateV2 | GET /api/v2/dur/template | DurController@exportTemplate |
| DataUseRegistersApi | exportDurV2 | GET /api/v2/dur/export | DurController@export |
| DataUseRegistersApi | fetchAllDur | GET /api/v1/dur | DurController@index |
| DataUseRegistersApi | fetchAllDurV2 | GET /api/v2/dur | DurController@indexActive |
| DataUseRegistersApi | fetchAllTeamDurStatus | GET /api/v2/teams/{teamId}/dur/status/{status} | TeamDurController@indexStatus |
| DataUseRegistersApi | fetchDurById | GET /api/v1/dur/{id} | DurController@show |
| DataUseRegistersApi | fetchDurByIdV2 | GET /api/v2/dur/{id} | DurController@showActive |
| DataUseRegistersApi | fetchDurByTeamAndByIdV2 | GET /api/v1/teams/{teamId}/dur/{id} | TeamDurController@show |
| DataUseRegistersApi | updateDur | PUT /api/v1/dur/{id} | Update a dur by id |
| DataUseRegistersApi | updateDurV2ByTeamId | PUT /api/v2/teams/{teamId}/dur/{id} | TeamDurController@update |
| DataUseRegistersApi | uploadDur | POST /api/v1/dur/upload | DurController@upload |
| DatasetsApi | countTeamUniqueFieldsDatasetsV2 | GET /api/v2/teams/{teamId}/datasets/count/{field} | TeamDatasetController@count |
| DatasetsApi | countUniqueFields | GET /api/v1/datasets/count/{field} | DatasetController@count |
| DatasetsApi | createDatasets | POST /api/v1/datasets | DatasetController@store |
| DatasetsApi | createDatasetsIntegrations | POST /api/v1/integrations/datasets | IntegrationDatasetController@store |
| DatasetsApi | createDatasetsLinkageExtraction | POST /api/v1/datasets/admin_ctrl/trigger/linkage_extraction | Trigger Term Extraction for Datasets |
| DatasetsApi | createDatasetsTermExtraction | POST /api/v1/datasets/admin_ctrl/trigger/term_extraction | Trigger Term Extraction for Datasets |
| DatasetsApi | createDatasetsV2 | POST /api/v2/datasets | DatasetController@store |
| DatasetsApi | createTeamDatasetsV2 | POST /api/v2/teams/{teamId}/datasets | TeamDatasetController@store |
| DatasetsApi | deleteDatasets | DELETE /api/v1/datasets/{id} | DatasetController@destroy |
| DatasetsApi | deleteDatasetsIntegrations | DELETE /api/v1/integrations/datasets/{id} | IntegrationDatasetController@destroy |
| DatasetsApi | deleteDatasetsV2 | DELETE /api/v2/datasets/{id} | Delete a dataset |
| DatasetsApi | deleteTeamDatasetsV2 | DELETE /api/v2/teams/{teamId}/datasets/{id} | TeamDatasetController@destroy |
| DatasetsApi | exportDatasetMetadata | GET /api/v1/datasets/export_metadata/{id} | DatasetController@exportMetadata |
| DatasetsApi | exportDatasets | GET /api/v1/datasets/export | DatasetController@export |
| DatasetsApi | exportDur | GET /api/v1/dur/export | DurController@export |
| DatasetsApi | exportMockDataset | GET /api/v1/datasets/export/mock | DatasetController@exportMock |
| DatasetsApi | exportMockDatasetV2 | GET /api/v2/datasets/export/mock | DatasetController@exportMock |
| DatasetsApi | fetchAllDatasets | GET /api/v1/datasets | DatasetController@index |
| DatasetsApi | fetchAllDatasetsIntegrations | GET /api/v1/integrations/datasets | IntegrationDatasetController@index |
| DatasetsApi | fetchAllDatasetsV2 | GET /api/v2/datasets | DatasetController@index |
| DatasetsApi | fetchDatasets | GET /api/v1/datasets/{id} | DatasetController@show |
| DatasetsApi | fetchDatasetsIntegrations | GET /api/v1/integrations/datasets/{id} | IntegrationDatasetController@show |
| DatasetsApi | fetchDatasetsV2 | GET /api/v2/datasets/{id} | DatasetController@showActive |
| DatasetsApi | fetchTeamDatasetsStatus | GET /api/v2/teams/{teamId}/datasets/status/{status} | TeamDatasetController@indexStatus |
| DatasetsApi | fetchTeamDatasetsV2 | GET /api/v2/teams/{teamId}/datasets/{id} | TeamDatasetController@show |
| DatasetsApi | patchDatasets | PATCH /api/v1/datasets/{id} | DatasetController@edit |
| DatasetsApi | patchDatasetsIntegrations | PATCH /api/v1/integrations/datasets/{id} | IntegrationDatasetController@edit |
| DatasetsApi | patchDatasetsV2 | PATCH /api/v2/datasets/{id} | DatasetController@edit |
| DatasetsApi | patchTeamDatasetsV2 | PATCH /api/v2/teams/{teamId}/datasets/{id} | TeamDatasetController@edit |
| DatasetsApi | updateDatasets | PUT /api/v1/datasets/{id} | DatasetController@update |
| DatasetsApi | updateDatasetsIntegrations | PUT /api/v1/integrations/datasets/{id} | IntegrationDatasetController@update |
| DatasetsApi | updateDatasetsV2 | PUT /api/v2/datasets/{id} | DatasetController@update |
| DatasetsApi | updateTeamDatasetsV2 | PUT /api/v2/teams/{teamId}/datasets/{id} | TeamDatasetController@update |
| DatasetsTestApi | datasetsTest | POST /api/v1/datasets/test | DatasetController@datasetTest |
| EnquiryThreadApi | createEnquiryThreads | POST /api/v1/enquiry_threads | EnquiryThread@store |
| EnquiryThreadApi | fetchAllEnquiryThreads | GET /api/v1/enquiry_threads | EnquiryThread@index |
| EnquiryThreadApi | fetchEnquiryThreads | GET /api/v1/enquiry_threads/{id} | EnquiryThread@show |
| FormHydrationApi | getFormSchema | GET /api/v1/form_hydration/schema | Retrieve form schema data |
| FormHydrationApi | onboardingFormHydration | GET /api/v1/form_hydration | Retrieve form schema data |
| IntegrationCollectionsApi | createCollectionsIntegrations | POST /api/v1/integrations/collections | IntegrationCollectionController@store |
| IntegrationCollectionsApi | deleteCollectionsIntegrations | DELETE /api/v1/integrations/collections/{id} | Delete a collection |
| IntegrationCollectionsApi | editCollectionsIntegrations | PATCH /api/v1/integrations/collections/{id} | Edit a collection |
| IntegrationCollectionsApi | fetchAllCollectionsIntegrations | GET /api/v1/integrations/collections | IntegrationCollectionController@index |
| IntegrationCollectionsApi | fetchCollectionsIntegrations | GET /api/v1/integrations/collections/{id} | IntegrationCollectionController@show |
| IntegrationCollectionsApi | updateCollectionsIntegrations | PUT /api/v1/integrations/collections/{id} | Update a collection |
| IntegrationDataUseRegistersApi | createDurIntegrations | POST /api/v1/integrations/dur | IntegrationDurController@store |
| IntegrationDataUseRegistersApi | deleteDurIntegrations | DELETE /api/v1/integrations/dur/{id} | Delete a dur |
| IntegrationDataUseRegistersApi | editDurIntegrations | PATCH /api/v1/integrations/dur/{id} | Edit a dur |
| IntegrationDataUseRegistersApi | fetchAllDurIntegrations | GET /api/v1/integrations/dur | IntegrationDurController@index |
| IntegrationDataUseRegistersApi | fetchDurByIdIntegrations | GET /api/v1/integrations/dur/{id} | IntegrationDurController@show |
| IntegrationDataUseRegistersApi | updateDurIntegrations | PUT /api/v1/integrations/dur/{id} | Update a dur by id |
| IntegrationsDatasetsTestApi | integrationsDatasetsTest | POST /api/v1/integrations/datasets/test | IntegrationDatasetController@datasetTest |
| KeywordApi | createKeywords | POST /api/v1/keywords | KeywordController@store |
| KeywordApi | deleteKeywords | DELETE /api/v1/keywords/{id} | KeywordController@destroy |
| KeywordApi | editKeywords | PATCH /api/v1/keywords/{id} | KeywordController@update |
| KeywordApi | fetchAllKeywords | GET /api/v1/keywords | KeywordController@index |
| KeywordApi | fetchKeywords | GET /api/v1/keywords/{id} | KeywordController@show |
| KeywordApi | updateKeywords | PUT /api/v1/keywords/{id} | KeywordController@update |
| LibraryApi | createLibraries | POST /api/v1/libraries | Library@store |
| LibraryApi | deleteLibraries | DELETE /api/v1/libraries/{id} | Library@destroy |
| LibraryApi | editLibraries | PATCH /api/v1/libraries/{id} | Library@update |
| LibraryApi | fetchLibraries | GET /api/v1/libraries/{id} | Return a single library |
| LibraryApi | listLibraries | GET /api/v1/libraries | Retrieve a list of libraries |
| LibraryApi | updateLibraries | PUT /api/v1/libraries/{id} | Library@update |
| LicenseApi | createLicenses | POST /api/v1/licenses | License@store |
| LicenseApi | deleteLicenses | DELETE /api/v1/licenses/{id} | License@destroy |
| LicenseApi | editLicenses | PATCH /api/v1/licenses/{id} | License@edit |
| LicenseApi | fetchAllLicenses | GET /api/v1/licenses | License@index |
| LicenseApi | fetchLicenses | GET /api/v1/licenses/{id} | License@show |
| LicenseApi | updateLicenses | PUT /api/v1/licenses/{id} | License@update |
| LogoutApi | logout | POST /api/v1/logout | LogoutController@logout |
| MetricsApi | fetchKeyMetricsV2 | GET /api/v2/metrics | KeyMetricController@index |
| NotificationApi | createNotifications | POST /api/v1/notifications | Notification@store |
| NotificationApi | deleteNotifications | DELETE /api/v1/notifications/{id} | Notification@destroy |
| NotificationApi | editNotifications | PATCH /api/v1/notifications/{id} | Notification@edit |
| NotificationApi | fetchAllNotifications | GET /api/v1/notifications | Notification@index |
| NotificationApi | fetchNotifications | GET /api/v1/notifications/{id} | Notification@show |
| NotificationApi | updateNotifications | PUT /api/v1/notifications/{id} | Notification@update |
| ProgrammingLanguageApi | createProgrammingLanguages | POST /api/v1/programming_languages | ProgrammingLanguage@store |
| ProgrammingLanguageApi | deleteProgrammingLanguages | DELETE /api/v1/programming_languages/{id} | ProgrammingLanguage@destroy |
| ProgrammingLanguageApi | editProgrammingLanguages | PATCH /api/v1/programming_languages/{id} | ProgrammingLanguage@update |
| ProgrammingLanguageApi | fetchAllProgrammingLanguages | GET /api/v1/programming_languages | ProgrammingLanguage@index |
| ProgrammingLanguageApi | fetchProgrammingLanguages | GET /api/v1/programming_languages/{id} | ProgrammingLanguage@show |
| ProgrammingLanguageApi | updateProgrammingLanguages | PUT /api/v1/programming_languages/{id} | ProgrammingLanguage@update |
| ProgrammingPackageApi | createProgrammingPackages | POST /api/v1/programming_packages | ProgrammingPackage@store |
| ProgrammingPackageApi | deleteProgrammingPackages | DELETE /api/v1/programming_packages/{id} | ProgrammingPackage@destroy |
| ProgrammingPackageApi | editProgrammingPackages | PATCH /api/v1/programming_packages/{id} | ProgrammingPackage@update |
| ProgrammingPackageApi | fetchAllProgrammingPackages | GET /api/v1/programming_packages | ProgrammingPackage@index |
| ProgrammingPackageApi | fetchProgrammingPackages | GET /api/v1/programming_packages/{id} | ProgrammingPackage@show |
| ProgrammingPackageApi | updateProgrammingPackages | PUT /api/v1/programming_packages/{id} | ProgrammingPackage@update |
| ProjectGrantApi | fetchAllProjectGrants | GET /api/v1/project_grants | ProjectGrantController@index |
| ProjectGrantApi | fetchProjectGrant | GET /api/v1/project_grants/{id} | ProjectGrantController@show |
| PublicationApi | countTeamUniqueFieldsPublicationV2 | GET /api/v2/teams/{teamId}/publications/count/{field} | TeamPublicationController@count |
| PublicationApi | countUniqueFieldsPublications | GET /api/v1/publication/count/{field} | PublicationController@count |
| PublicationApi | countUserUniqueFieldsPublicationV2 | GET /api/v2/users/{userId}/publications/count/{field} | UserPublicationController@count |
| PublicationApi | createPublications | POST /api/v1/publications | PublicationController@store |
| PublicationApi | createPublicationsV2ByTeamId | POST /api/v2/teams/{teamId}/publications | TeamPublicationController@store |
| PublicationApi | createPublicationsV2ByUserId | POST /api/v2/users/{userId}/publications | UserPublicationController@store |
| PublicationApi | deletePublications | DELETE /api/v1/publications/{id} | PublicationController@destroy |
| PublicationApi | deletePublicationsV2ByTeamId | DELETE /api/v2/teams/{teamId}/publications/{id} | TeamPublicationController@destroy |
| PublicationApi | deletePublicationsV2ByUserId | DELETE /api/v2/users/{userId}/publications/{id} | UserPublicationController@destroy |
| PublicationApi | editPublications | PATCH /api/v1/publications/{id} | PublicationController@edit |
| PublicationApi | editPublicationsV2ByTeamId | PATCH /api/v2/teams/{teamId}/publications/{id} | TeamPublicationController@edit |
| PublicationApi | editPublicationsV2ByUserId | PATCH /api/v2/users/{userId}/publications/{id} | UserPublicationController@edit |
| PublicationApi | fetchAllPublications | GET /api/v1/publications | PublicationController@index |
| PublicationApi | fetchAllPublicationsByTeamAndStatusV2 | GET /api/v2/teams/{teamId}/publications/status/{status} | TeamPublicationController@indexStatus |
| PublicationApi | fetchAllPublicationsByUserAndStatusV2 | GET /api/v2/users/{userId}/publications/{status} | UserPublicationController@indexStatus |
| PublicationApi | fetchAllPublicationsV2 | GET /api/v2/publications | PublicationController@indexActive |
| PublicationApi | fetchPublications | GET /api/v1/publications/{id} | PublicationController@show |
| PublicationApi | fetchPublicationsByTeamAndByIdV2 | GET /api/v2/teams/{teamId}/publications/{id} | TeamPublicationController@show |
| PublicationApi | fetchPublicationsByUserAndByIdV2 | GET /api/v2/users/{userId}/publications/{id} | UserPublicationController@show |
| PublicationApi | fetchPublicationsV2 | GET /api/v2/publications/{id} | PublicationController@showActive |
| PublicationApi | updatePublications | PUT /api/v1/publications/{id} | PublicationController@update |
| PublicationApi | updatePublicationsV2ByTeamId | PUT /api/v2/teams/{teamId}/publications/{id} | TeamPublicationController@update |
| PublicationApi | updatePublicationsV2ByUserId | PUT /api/v2/users/{userId}/publications/{id} | UserPublicationController@update |
| QuestionBankApi | createQuestionBankQuestion | POST /api/v1/questions | QuestionBank@store |
| QuestionBankApi | deleteQuestionBankQuestion | DELETE /api/v1/questions/{id} | QuestionBank@destroy |
| QuestionBankApi | downloadQuestionBankQuestionFile | GET /api/v1/questions/{id}/files/{fileId} | QuestionBank@destroyFile |
| QuestionBankApi | editQuestionBankQuestion | PATCH /api/v1/questions/{id} | QuestionBank@update |
| QuestionBankApi | fetchArchivedQuestionBankQuestions | GET /api/v1/questions/archived | QuestionBank@indexArchived |
| QuestionBankApi | fetchCustomQuestionBankQuestions | GET /api/v1/questions/custom | QuestionBank@indexCustom |
| QuestionBankApi | fetchQuestionBankQuestion | GET /api/v1/questions/{id} | QuestionBank@show |
| QuestionBankApi | fetchQuestionBankQuestionVersion | GET /api/v1/questions/version/{id} | QuestionBank@showVersion |
| QuestionBankApi | fetchQuestionBankQuestions | GET /api/v1/questions | QuestionBank@index |
| QuestionBankApi | fetchStandardQuestionBankQuestions | GET /api/v1/questions/standard | QuestionBank@indexStandard |
| QuestionBankApi | fetchTeamQuestionBankQuestionsBySection | GET /api/v1/teams/{teamId}/questions/section/{sectionId} | TeamQuestionBank@indexBySection |
| QuestionBankApi | updateQuestionBankQuestion | PUT /api/v1/questions/{id} | QuestionBank@update |
| QuestionBankApi | updateQuestionBankQuestionStatus | PATCH /api/v1/questions/{id}/{status} | QuestionBank@updateStatus |
| ReviewsApi | createReviews | POST /api/v1/reviews | ReviewController@store |
| ReviewsApi | deleteReviews | DELETE /api/v1/reviews/{id} | Delete a review |
| ReviewsApi | editReviews | PATCH /api/v1/reviews/{id} | Edit a review |
| ReviewsApi | fetchAllReviews | GET /api/v1/reviews | ReviewController@index |
| ReviewsApi | fetchReviews | GET /api/v1/reviews/{id} | ReviewController@show |
| ReviewsApi | updateReviews | PUT /api/v1/reviews/{id} | Update a review |
| SavedSearchApi | createSavedSearches | POST /api/v1/saved_searches | SavedSearch@store |
| SavedSearchApi | deleteSavedSearches | DELETE /api/v1/saved_searches/{id} | SavedSearch@destroy |
| SavedSearchApi | editSavedSearches | PATCH /api/v1/saved_searches/{id} | SavedSearch@update |
| SavedSearchApi | fetchAllSavedSearches | GET /api/v1/saved_searches | SavedSearch@index |
| SavedSearchApi | fetchSavedSearches | GET /api/v1/saved_searches/{id} | SavedSearch@show |
| SavedSearchApi | updateSavedSearches | PUT /api/v1/saved_searches/{id} | SavedSearch@update |
| SearchCollectionsApi | searchCollections | POST /api/v1/search/collections | Search@collections |
| SearchDataCustodianNetworksApi | searchDataCustodianNetworks | POST /api/v1/search/data_custodian_networks | Search@data_custodian_networks |
| SearchDataCustodiansApi | searchDataCustodians | POST /api/v1/search/data_custodians | Search@data_custodians |
| SearchDataUsesApi | searchDataUses | POST /api/v1/search/dur | Search@data_uses |
| SearchDatasetsApi | searchDatasets | POST /api/v1/search/datasets | Search@datasets |
| SearchPublicationsApi | searchPublications | POST /api/v1/search/publications | Search@publications |
| SearchPublicationsApi | searchPublicationsByDoi | POST /api/v1/search/doi | Search@publications |
| SearchSimilarDatasetsApi | searchSimilarDatasets | POST /api/v1/search/similar/datasets | Search@similarDatasets |
| SearchToolsApi | searchTools | POST /api/v1/search/tools | Search@tools |
| TeamDashboardApi | fetchCollectionsViewsV3 | GET /api/v3/teams/{id}/dashboard/collections/views | TeamDashboardController@collectionViews |
| TeamDashboardApi | fetchDarApplicationsApplicationTimelineV3 | GET /api/v3/teams/{id}/dar/dashboard/timeline | DataAccessDashboardController@getApplicationTimeline |
| TeamDashboardApi | fetchDarApplicationsAverageTimeToApprovalV3 | GET /api/v3/teams/{id}/dar/dashboard/average-time | DataAccessDashboardController@getAverageTimeToApproval |
| TeamDashboardApi | fetchDarApplicationsCurrentStatusV3 | GET /api/v3/teams/{id}/dar/dashboard/status | DataAccessDashboardController@getApplicationStatus |
| TeamDashboardApi | fetchDarApplicationsDashboardExportCsvV3 | GET /api/v3/teams/{id}/dar/dashboard/export/csv | DataAccessDashboardController@exportDashboardCsv |
| TeamDashboardApi | fetchDarApplicationsDashboardRequiredActionsExportCsvV3 | GET /api/v3/teams/{id}/dar/dashboard/required-actions/export/csv | DataAccessDashboardController@exportRequiredActionsCsv |
| TeamDashboardApi | fetchDarApplicationsDashboardTimelineExportCsvV3 | GET /api/v3/teams/{id}/dar/dashboard/timeline/export/csv | DataAccessDashboardController@exportDashboardTimelineCsv |
| TeamDashboardApi | fetchDarApplicationsRequiredActionsV3 | GET /api/v3/teams/{id}/dar/dashboard/required-actions | DataAccessDashboardController@getRequiredActions |
| TeamDashboardApi | fetchDarMyApplicationsV3 | GET /api/v3/teams/{id}/dar/dashboard/count | DataAccessDashboardController@getMyApplications |
| TeamDashboardApi | fetchDashboardDownloadCsvV3 | GET /api/v3/teams/{id}/dashboard/download/csv | TeamDashboardController@downloadCsv |
| TeamDashboardApi | fetchDataCustodiansViewsV3 | GET /api/v3/teams/{id}/dashboard/datacustodians/views | TeamDashboardController@datacustodianViews |
| TeamDashboardApi | fetchDatasetViews360V3 | GET /api/v3/teams/{id}/dashboard/datasets/views/360 | TeamDashboardController@datasetViews360 |
| TeamDashboardApi | fetchDatasetViewsTopV3 | GET /api/v3/teams/{id}/dashboard/datasets/views/top | TeamDashboardController@datasetViewsTop |
| TeamDashboardApi | fetchEntitiesCountV3 | GET /api/v3/teams/{id}/dashboard/{entity}/count | TeamDashboardController@entityCount |
| TeamDataAccessApplicationApi | countTeamDarApplications | GET /api/v1/teams/{teamId}/dar/applications/count | TeamDataAccessApplicationController@allCounts |
| TeamDataAccessApplicationApi | countUniqueFieldsDarApplications | GET /api/v1/teams/{teamId}/dar/applications/count/{field} | TeamDataAccessApplicationController@count |
| TeamDataAccessApplicationApi | fetchTeamDarApplication | GET /api/v1/teams/{teamId}/dar/applications/{id} | TeamDataAccessApplicationController@show |
| TeamDataAccessApplicationApi | fetchTeamDarApplicationHeader | GET /api/v1/teams/{teamId}/dar/applications/{id}/showHeader | TeamDataAccessApplicationController@showHeader |
| TeamDataAccessApplicationApi | fetchTeamDarApplications | GET /api/v1/teams/{teamId}/dar/applications | TeamDataAccessApplicationController@index |
| TeamDataAccessTemplateApi | deleteTeamDarTemplateFile | DELETE /api/v1/teams/{teamId}/dar/templates/{id}/files/{fileId} | TeamDataAccessTemplateController@destroyFile |
| TeamDataAccessTemplateApi | fetchTeamDarTemplates | GET /api/v1/teams/{teamId}/dar/templates | TeamDataAccessTemplateController@index |
| TeamDataAccessTemplateApi | teamDarTemplateCountUniqueFields | GET /api/v1/teams/{teamId}/dar/templates/count/{field} | TeamDataAccessTemplateController@count |
| TeamFederationsApi | createFederationTeam | POST /api/v1/teams/{teamId}/federations | FederationController@store |
| TeamFederationsApi | deleteFederation | DELETE /api/v1/teams/{teamId}/federations/{federationId} | FederationController@destroy |
| TeamFederationsApi | editFederationTeam | PATCH /api/v1/teams/{teamId}/federations/{federationId} | FederationController@edit |
| TeamFederationsApi | getFederationByFederationIdAndTeamId | GET /api/v1/teams/{teamId}/federations/{federationId} | FederationController@show |
| TeamFederationsApi | getFederationHistory | GET /api/v1/teams/{teamId}/federations/{federationId}/history | FederationController@history |
| TeamFederationsApi | getFederationTeamId | GET /api/v1/teams/{teamId}/federations | FederationController@index |
| TeamFederationsApi | runFederation | GET /api/v1/teams/{teamId}/federations/{federationId}/run | FederationController@runNow |
| TeamFederationsApi | testFederation | POST /api/v1/teams/{teamId}/federations/test | FederationController@testFederation |
| TeamFederationsApi | updateFederationTeam | PUT /api/v1/teams/{teamId}/federations/{federationId} | FederationController@update |
| ToolsApi | countTeamUniqueFieldsToolsV2 | GET /api/v2/teams/{teamId}/tools/count/{field} | TeamToolController@count |
| ToolsApi | countUniqueFieldsTools | GET /api/v1/tools/count/{field} | ToolController@count |
| ToolsApi | countUserUniqueFieldsToolsV2 | GET /api/v2/users/{userId}/tools/count/{field} | UserToolController@count |
| ToolsApi | createTools | POST /api/v1/tools | ToolController@store |
| ToolsApi | createToolsByTeamV2 | POST /api/v2/teams/{teamId}/tools | ToolController@store |
| ToolsApi | createToolsByUserV2 | POST /api/v2/users/{userId}/tools | UserToolController@store |
| ToolsApi | createToolsIntegrations | POST /api/v1/integrations/tools | IntegrationToolController@store |
| ToolsApi | deleteTools | DELETE /api/v1/tools/{id} | ToolController@destroy |
| ToolsApi | deleteToolsByTeamidV2 | DELETE /api/v2/teams/{teamId}/tools/{id} | TeamToolController@destroy |
| ToolsApi | deleteToolsByUserV2 | DELETE /api/v2/users/{userId}/tools/{id} | UserToolController@destroy |
| ToolsApi | deleteToolsIntegrations | DELETE /api/v1/integrations/tools/{id} | IntegrationToolController@destroy |
| ToolsApi | editTools | PATCH /api/v1/tools/{id} | ToolController@edit |
| ToolsApi | editToolsByTeamidV2 | PATCH /api/v2/teams/{teamId}/tools/{id} | TeamToolController@edit |
| ToolsApi | editToolsByUserV2 | PATCH /api/v2/users/{userId}/tools/{id} | UserToolController@edit |
| ToolsApi | editToolsIntegrations | PATCH /api/v1/integrations/tools/{id} | IntegrationToolController@edit |
| ToolsApi | fetchAllToolByTeamAndStatusV2 | GET /api/v2/teams/{teamId}/tools/status/{status} | TeamToolController@indexStatus |
| ToolsApi | fetchAllToolByUserAndStatusV2 | GET /api/v2/users/{userId}/tools/status/{status} | UserToolController@indexStatus |
| ToolsApi | fetchAllTools | GET /api/v1/tools | Fetch all tools |
| ToolsApi | fetchAllToolsIntegrations | GET /api/v1/integrations/tools | IntegrationToolController@index |
| ToolsApi | fetchAllToolsV2 | GET /api/v2/tools | ToolController@indexActive |
| ToolsApi | fetchTools | GET /api/v1/tools/{id} | ToolController@show |
| ToolsApi | fetchToolsByTeamAndByIdV2 | GET /api/v2/teams/{teamId}/tools/{id} | TeamToolController@show |
| ToolsApi | fetchToolsByUserAndByIdV2 | GET /api/v2/users/{userId}/tools/{id} | UserToolController@show |
| ToolsApi | fetchToolsIntegrations | GET /api/v1/integrations/tools/{id} | IntegrationToolController@show |
| ToolsApi | fetchToolsV2 | GET /api/v2/tools/{id} | ToolController@showActive |
| ToolsApi | updateTools | PUT /api/v1/tools/{id} | ToolController@update |
| ToolsApi | updateToolsByTeamidV2 | PUT /api/v2/teams/{teamId}/tools/{id} | TeamToolController@update |
| ToolsApi | updateToolsByUserV2 | PUT /api/v2/users/{userId}/tools/{id} | UserToolController@update |
| ToolsApi | updateToolsIntegrations | PUT /api/v1/integrations/tools/{id} | IntegrationToolController@update |
| TypeCategoryApi | createTypeCategories | POST /api/v1/type_categories | TypeCategory@store |
| TypeCategoryApi | deleteTypeCategories | DELETE /api/v1/type_categories/{id} | TypeCategory@destroy |
| TypeCategoryApi | editTypeCategories | PATCH /api/v1/type_categories/{id} | TypeCategory@update |
| TypeCategoryApi | fetchAllTypeCategories | GET /api/v1/type_categories | TypeCategory@index |
| TypeCategoryApi | fetchTypeCategories | GET /api/v1/type_categories/{id} | TypeCategory@show |
| TypeCategoryApi | updateTypeCategories | PUT /api/v1/type_categories/{id} | TypeCategory@update |
| UploadApi | createFiles | POST /api/v1/files | Upload@upload |
| UploadApi | deleteFilesProcessed | DELETE /api/v1/files/processed/{id} | Upload@destroy |
| UploadApi | fetchFiles | GET /api/v1/files/{uuid} | Upload@show |
| UploadApi | fetchFilesProcessedContent | GET /api/v1/files/processed/{uuid}/download | Upload@content |
| UserDataAccessApplicationApi | countAllUserDarApplications | GET /api/v1/users/{userId}/dar/applications/count | UserDataAccessApplicationController@allCounts |
| UserDataAccessApplicationApi | countUserDarApplicationsByField | GET /api/v1/users/{userId}/dar/applications/count/{field} | UserDataAccessApplicationController@count |
| UserDataAccessApplicationApi | createUserDarApplicationAnswers | PUT /api/v1/users/{userId}/dar/applications/{id}/answers | UserDataAccessApplication@storeAnswers |
| UserDataAccessApplicationApi | fetchUserDarApplicationAnswers | GET /api/v1/users/{userId}/dar/applications/{id}/answers | UserDataAccessApplicationController@showAnswers |
| UserDataAccessApplicationApi | fetchUserDarApplicationDetails | GET /api/v1/users/{userId}/dar/applications/{id} | UserDataAccessApplicationController@show |
| UserDataAccessApplicationApi | fetchUserDarApplicationHeader | GET /api/v1/users/{userId}/dar/applications/{id}/showHeader | UserDataAccessApplicationController@showHeader |
| UserDataAccessApplicationApi | fetchUserDarApplications | GET /api/v1/users/{userId}/dar/applications | UserDataAccessApplicationController@index |
| UserOrganisationApi | fetchUserOrganisations | GET /api/v1/users/organisations | UserOrganisation@index |
| UserRolesApi | createUserHasRoles | POST /api/v1/users/{userId}/roles | UserRoleController@store |
| UserRolesApi | deleteUserHasRoles | DELETE /api/v1/users/{userId}/roles | UserRoleController@destroy |
| UserRolesApi | updateUserHasRoles | PATCH /api/v1/users/{userId}/roles | UserRoleController@edit |
| UsersApi | createUsers | POST /api/v1/users | UserController@store |
| UsersApi | deleteUsers | DELETE /api/v1/users/{id} | UserController@destroy |
| UsersApi | editUsers | PATCH /api/v1/users/{id} | UserController@edit |
| UsersApi | fetchAllUsers | GET /api/v1/users | UserController@index |
| UsersApi | fetchUsers | GET /api/v1/users/{id} | UserController@show |
| UsersApi | resendSecondaryVerificationEmail | POST /api/v1/users/{id}/resend-secondary-verification | Resend secondary email verification |
| UsersApi | updateUsers | PUT /api/v1/users/{id} | UserController@update |
| UsersApi | verifySecondaryEmail | GET /api/v1/users/verify-secondary-email/{uuid} | Verify user's secondary email using a UUID |
| WidgetsApi | createWidget | POST /api/v1/teams/{teamId}/widgets | Create a new widget |
| WidgetsApi | deleteWidget | DELETE /api/v1/teams/{teamId}/widgets/{id} | Delete a widget |
| WidgetsApi | fetchAllWidgets | GET /api/v1/teams/{teamId}/widgets | WidgetController@index |
| WidgetsApi | fetchWidget | GET /api/v1/teams/{teamId}/widgets/{id} | WidgetController@retrieve |
| WidgetsApi | fetchWidgetDataSources | GET /api/v1/teams/{teamId}/widgets/data | WidgetController@getWidgetData |
| WidgetsApi | retrieveWidgetData | GET /api/v1/teams/{teamId}/widgets/{id}/data | Retrieve data related to a widget |
| WidgetsApi | trackWidgetEvent | POST /api/v1/teams/{teamId}/widgets/{id}/track | Record a widget analytics event |
| WidgetsApi | updateWidget | PATCH /api/v1/teams/{teamId}/widgets/{id} | Update an existing widget |
| WidgetsApi | widgetAnalytics | GET /api/v1/teams/{teamId}/widgets/analytics | Get widget analytics for a team |
| WorkgroupsApi | fetchAllWorkgroups | GET /api/v1/workgroups | WorkgroupController@index |
- Alias
- Authentication200Response
- AuthenticationRequest
- Category
- Collection
- CountUniqueFieldsCollections200Response
- CreateAdminSearchReindexRequest
- CreateAliases200Response
- CreateAliases200ResponseData
- CreateAliases500Response
- CreateAliasesRequest
- CreateApplications200Response
- CreateApplications200ResponseDataInner
- CreateApplicationsRequest
- CreateCategories200Response
- CreateCategoriesRequest
- CreateCollectionsRequest
- CreateCsat422Response
- CreateCsatRequest
- CreateDarApplicationsRequest
- CreateDarSectionRequest
- CreateDarTemplateRequest
- CreateDarTemplateRequestQuestionsInner
- CreateDataProviderCollRequest
- CreateDatasetsLinkageExtraction200Response
- CreateDatasetsLinkageExtractionRequest
- CreateDatasetsRequest
- CreateDatasetsTermExtraction200Response
- CreateDatasetsTermExtraction500Response
- CreateDatasetsTermExtractionRequest
- CreateDatasetsV2Request
- CreateDurIntegrationsRequest
- CreateDurRequest
- CreateDurRequestDatasetsInner
- CreateDurRequestPublicationsInner
- CreateDurRequestTeamInner
- CreateDurRequestUsersInner
- CreateEnquiryThreadsRequest
- CreateFederationTeamRequest
- CreateFiles200Response
- CreateKeywords409Response
- CreateLibrariesRequest
- CreateLicensesRequest
- CreateNotificationsRequest
- CreatePublicationsRequest
- CreatePublicationsRequestDatasetsInner
- CreatePublicationsRequestToolsInner
- CreateQuestionBankQuestionRequest
- CreateQuestionBankQuestionRequestOptionsInner
- CreateQuestionBankQuestionRequestOptionsInnerChildrenInner
- CreateQuestionBankQuestionRequestOptionsInnerChildrenInnerOptionsInner
- CreateReviewsRequest
- CreateSavedSearchesRequest
- CreateSavedSearchesRequestFiltersInner
- CreateTeamCollections401Response
- CreateTeamCollectionsRequest
- CreateTeamCollectionsRequestDatasetsInner
- CreateTeamDarApplicationReviewRequest
- CreateTeamDatasetsV2Request
- CreateToolsIntegrations400Response
- CreateToolsIntegrationsRequest
- CreateToolsIntegrationsRequestDatasetInner
- CreateToolsIntegrationsRequestPublicationsInner
- CreateToolsRequest
- CreateToolsRequestCollectionsInner
- CreateTypeCategoriesRequest
- CreateUserDarApplicationAnswersRequest
- CreateUserHasRolesRequest
- CreateUsersRequest
- CreateWidget201Response
- CreateWidget400Response
- CreateWidgetRequest
- DataAccessApplication
- DataAccessApplicationReview
- DataCustodianNetwork
- Dataset
- DatasetVersion
- DatasetsTestRequest
- DeleteAliases200Response
- DeleteFederation200Response
- DeleteFederation404Response
- Dur
- EditAliasesRequest
- EditApplicationsRequest
- EditCategoriesRequest
- EditCollectionsV2Request
- EditCsat200Response
- EditCsatRequest
- EditDarIntegrationRequest
- EditDataProviderCollRequest
- EditNotificationsRequest
- EditQuestionBankQuestionRequest
- EditSavedSearchesRequest
- EditTeamCollectionsRequest
- ExportDatasetMetadata400Response
- ExportMockDataset404Response
- FetchAliases200Response
- FetchAliases404Response
- FetchAllAliases200Response
- FetchAllApplications200Response
- FetchAllApplications200ResponseDataInner
- FetchAllCategories200Response
- FetchAllCollections200Response
- FetchAllDarIntegrations200Response
- FetchAllDarIntegrations200ResponseDataInner
- FetchAllDatasets200Response
- FetchAllDur200Response
- FetchAllDurIntegrations200Response
- FetchAllDurIntegrations200ResponseDataInner
- FetchAllDurV2200Response
- FetchAllEnquiryThreads200Response
- FetchAllEnquiryThreads200ResponseData
- FetchAllKeywords200Response
- FetchAllLicenses200Response
- FetchAllNotifications200Response
- FetchAllProgrammingLanguages200Response
- FetchAllProgrammingPackages200Response
- FetchAllProjectGrants200Response
- FetchAllPublications200Response
- FetchAllReviews200Response
- FetchAllReviews200ResponseDataInner
- FetchAllReviews200ResponseDataInnerTool
- FetchAllReviews200ResponseDataInnerUser
- FetchAllSavedSearches200Response
- FetchAllSitemap200Response
- FetchAllSitemap200ResponseDataInner
- FetchAllTools200Response
- FetchAllTools500Response
- FetchAllToolsIntegrations200Response
- FetchAllTypeCategories200Response
- FetchAllUsers200Response
- FetchAllWidgets200Response
- FetchAllWorkgroups200Response
- FetchApplications200Response
- FetchApplications200ResponseDataInner
- FetchCollections200Response
- FetchCollectionsViewsV3200Response
- FetchCustomQuestionBankQuestions200Response
- FetchDarSection200Response
- FetchDarSections200Response
- FetchDarSections200ResponseDataInner
- FetchDarTemplate200Response
- FetchDarTemplates200Response
- FetchDarTemplates200ResponseDataInner
- FetchDashboardDownloadCsvV3500Response
- FetchDataCustodianNetwork200Response
- FetchDataCustodianNetworkCustodiansSummary200Response
- FetchDataCustodianNetworkCustodiansSummary200ResponseData
- FetchDataCustodianNetworkDatasetsSummary200Response
- FetchDataCustodianNetworkDatasetsSummary200ResponseData
- FetchDataCustodianNetworkEntitiesSummary200Response
- FetchDataCustodianNetworkEntitiesSummary200ResponseData
- FetchDataCustodianNetworkInfo200Response
- FetchDataCustodianNetworkInfo200ResponseData
- FetchDataCustodianNetworks200Response
- FetchDataProviderColl200Response
- FetchDataProviderCollSummary200Response
- FetchDataProviderCollSummary200ResponseData
- FetchDataProviderColls200Response
- FetchDataProviderColls200ResponseDataInner
- FetchDatasetViews360V3200Response
- FetchDatasetViews360V3200ResponseData
- FetchDatasetViewsTopV3200Response
- FetchDatasetViewsTopV3200ResponseData
- FetchDatasets200Response
- FetchDurById200Response
- FetchDurByIdIntegrations200Response
- FetchDurByIdIntegrations200ResponseDataInner
- FetchEntitiesCountV3200Response
- FetchEntitiesCountV3200ResponseData
- FetchFiles200Response
- FetchFiles200ResponseDataInner
- FetchFilesProcessedContent200Response
- FetchFilesProcessedContent200ResponseDataInner
- FetchKeyMetricsV2200Response
- FetchKeywords200Response
- FetchLibraries200Response
- FetchLibraries200ResponseData
- FetchLibraries200ResponseDataDataset
- FetchLibraries200ResponseDataDatasetTeam
- FetchLicenses200Response
- FetchNotifications200Response
- FetchProgrammingLanguages200Response
- FetchProgrammingPackages200Response
- FetchPublications200Response
- FetchQuestionBankQuestion200Response
- FetchQuestionBankQuestion200ResponseData
- FetchQuestionBankQuestionVersion200Response
- FetchQuestionBankQuestionVersion200ResponseData
- FetchQuestionBankQuestions200Response
- FetchStandardQuestionBankQuestions200Response
- FetchTeamDarApplication200Response
- FetchTeamDarApplicationAnswers200Response
- FetchTeamDarApplicationAnswers200ResponseData
- FetchTeamDarApplicationFiles200Response
- FetchTeamDarApplicationFiles200ResponseData
- FetchTeamDarApplicationHeader200Response
- FetchTeamDarApplicationHeader200ResponseData
- FetchTeamDarApplicationHeader200ResponseDataDatasetsInner
- FetchTeamDarApplicationHeader200ResponseDataDatasetsInnerCustodianInner
- FetchTeamDarApplicationHeader200ResponseDataPrimaryApplicantInner
- FetchTeamDarApplicationHeader200ResponseDataTeamsInner
- FetchTeamDarApplicationReviews200Response
- FetchTeamDarApplicationStatusHistory200Response
- FetchTeamDarApplicationStatusHistory200ResponseData
- FetchTeamDarApplications200Response
- FetchTeamQuestionBankQuestionsBySection200Response
- FetchTeamQuestionBankQuestionsBySection200ResponseDataInner
- FetchToolsIntegrations200Response
- FetchTypeCategories200Response
- FetchUserOrganisations200Response
- FetchUsers200Response
- FetchWidget200Response
- FetchWidgetDataSources200Response
- FetchWidgetDataSources400Response
- GetCancerTypeFilter200Response
- GetCancerTypeFilter404Response
- GetCancerTypeFilters200Response
- GetCancerTypeFilters200ResponseDataInner
- GetFederationByFederationIdAndTeamId200Response
- GetFederationByFederationIdAndTeamId200ResponseData
- GetFederationHistory200Response
- GetFederationHistory200ResponseDataInner
- GetFederationHistory200ResponseDataInnerFailedDatasetsInner
- GetFederationTeamId200Response
- GetFederationTeamId200ResponseDataInner
- Keyword
- License
- ListLibraries200Response
- ListLibraries200ResponseDataInner
- ListLibraries200ResponseLinksInner
- LoginRequest
- Notification
- PatchDarSectionRequest
- PatchDarTemplate200Response
- PatchDarTemplate200ResponseData
- PatchDarTemplateRequest
- PatchDatasetsV2Request
- PatchUserDarApplicationRequest
- ProgrammingLanguage
- ProgrammingPackage
- Publication
- QuestionBank
- Register200Response
- Register200ResponseUser
- RegisterRequest
- ResendSecondaryVerificationEmail200Response
- ResendSecondaryVerificationEmail404Response
- RetrieveWidgetData200Response
- RetrieveWidgetData403Response
- SavedSearch
- SearchCollections200Response
- SearchCollections200ResponseDataInner
- SearchCollections200ResponseDataInnerSourceInner
- SearchCollectionsRequest
- SearchDataCustodianNetworks200Response
- SearchDataCustodianNetworks200ResponseDataInner
- SearchDataCustodianNetworks200ResponseDataInnerSourceInner
- SearchDataCustodianNetworksRequest
- SearchDataCustodians200Response
- SearchDataCustodians200ResponseDataInner
- SearchDataCustodians200ResponseDataInnerSourceInner
- SearchDataCustodiansRequest
- SearchDataUses200Response
- SearchDataUses200ResponseDataInner
- SearchDataUses200ResponseDataInnerHighlightInner
- SearchDataUses200ResponseDataInnerSourceInner
- SearchDataUsesRequest
- SearchDatasets200Response
- SearchDatasets200ResponseDataInner
- SearchDatasets200ResponseDataInnerHighlightInner
- SearchDatasets200ResponseDataInnerSourceInner
- SearchDatasetsRequest
- SearchPublications200Response
- SearchPublications200ResponseDataInner
- SearchPublications200ResponseDataInnerHighlightInner
- SearchPublications200ResponseDataInnerSourceInner
- SearchPublicationsByDoi200Response
- SearchPublicationsByDoiRequest
- SearchPublicationsRequest
- SearchSimilarDatasets200Response
- SearchSimilarDatasets200ResponseDataInner
- SearchSimilarDatasetsRequest
- SearchTools200Response
- SearchTools200ResponseDataInner
- SearchTools200ResponseDataInnerHighlightInner
- SearchTools200ResponseDataInnerSourceInner
- SearchToolsRequest
- Team
- TestFederation200Response
- Tool
- TrackWidgetEventRequest
- TypeCategory
- UpdateAdminSearchFeatureRequest
- UpdateAliases200Response
- UpdateApplications200Response
- UpdateApplications200ResponseData
- UpdateApplicationsRequest
- UpdateCategories200Response
- UpdateCategoriesRequest
- UpdateCollectionsV2Request
- UpdateDarIntegration200Response
- UpdateDarIntegrationRequest
- UpdateDarTemplateRequest
- UpdateDataCustodianNetwork200Response
- UpdateDataProviderColl200Response
- UpdateDataProviderCollRequest
- UpdateDatasetsRequest
- UpdateDur200Response
- UpdateDurIntegrations200Response
- UpdateDurIntegrations200ResponseData
- UpdateFederationTeamRequest
- UpdateKeywords200Response
- UpdateLibraries200Response
- UpdateLibraries200ResponseData
- UpdateLicenses200Response
- UpdateNotifications200Response
- UpdateProgrammingLanguages200Response
- UpdateProgrammingPackages200Response
- UpdatePublicationsRequest
- UpdateQuestionBankQuestion200Response
- UpdateQuestionBankQuestionRequest
- UpdateQuestionBankQuestionStatus200Response
- UpdateReviews200Response
- UpdateReviews200ResponseData
- UpdateSavedSearches200Response
- UpdateSavedSearchesRequest
- UpdateTeamCollectionsRequest
- UpdateTeamDarApplicationQuestionReview200Response
- UpdateTeamDarApplicationRequest
- UpdateToolsIntegrationsRequest
- UpdateToolsRequest
- UpdateTypeCategories200Response
- UpdateTypeCategoriesRequest
- UpdateUserDarApplicationRequest
- UpdateUserDarApplicationRequestAnswersInner
- UpdateUserDarApplicationRequestAnswersInnerAnswer
- UpdateUserHasRolesRequest
- UpdateUserHasRolesRequestRoles
- UpdateUsersRequest
- UpdateWidget200Response
- UpdateWidgetRequest
- UploadDurRequest
- User
- VerifySecondaryEmail200Response
- VerifySecondaryEmail400Response
- VerifySecondaryEmail404Response
- Widget
- WidgetAnalytics200Response
Authentication schemes defined for the API:
- Type: HTTP Bearer Token authentication (JWT)
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.