Skip to content
BranchesTags

Repository files navigation

gateway-api-sdk

HDRUK Gateway API

  • API version: 2.0.0
    • Build date: 2026-08-05T08:39:33.604456851Z[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

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>uk.ac.hdruk.gatewayapi</groupId>
  <artifactId>gateway-api-sdk</artifactId>
  <version>0.0.0-test6</version>
  <scope>compile</scope>
</dependency>

Gradle users

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-test6"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/gateway-api-sdk-0.0.0-test6.jar
  • target/lib/*.jar

Getting Started

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.auth.*;
import uk.ac.hdruk.gatewayapi.model.*;
import uk.ac.hdruk.gatewayapi.api.ApplicationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ApplicationApi apiInstance = new ApplicationApi(defaultClient);
    CreateApplicationsRequest createApplicationsRequest = new CreateApplicationsRequest(); // CreateApplicationsRequest | Application definition
    try {
      CreateApplications200Response result = apiInstance.createApplications(createApplicationsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationApi#createApplications");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
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 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
CollectionsApi countUniqueFieldsCollections GET /api/v1/collections/count/{field} CollectionController@count
CollectionsApi countUniqueFieldsCollectionsV2 GET /api/v2/collections/count/{field} CollectionController@count
CollectionsApi createCollections POST /api/v2/collections CollectionController@store
CollectionsApi deleteCollectionsV2 DELETE /api/v2/collections/{id} Delete a collection
CollectionsApi editCollectionsV2 PATCH /api/v2/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 updateCollectionsV2 PUT /api/v2/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 deleteTeamDarApplicationFile DELETE /api/v1/teams/{teamId}/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 updateTeamDarApplication PATCH /api/v1/teams/{teamId}/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 deleteTeamDarApplicationReviewFile DELETE /api/v1/teams/{teamId}/dar/applications/{id}/reviews/{reviewId}/files/{fileId} DataAccessApplicationReview@destroyFile
DataAccessApplicationReviewApi fetchTeamDarApplicationReviewFile GET /api/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 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
DataAccessSectionApi createDarSection POST /api/v1/dar/sections DataAccessSection@store
DataAccessSectionApi deleteDarSection DELETE /api/v1/dar/sections/{id} DataAccessSection@destroy
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 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 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
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
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 fetchDurById GET /api/v1/dur/{id} DurController@show
DataUseRegistersApi fetchDurByIdV2 GET /api/v2/dur/{id} DurController@showActive
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 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 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 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
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
LicenseApi fetchAllLicenses GET /api/v1/licenses License@index
LicenseApi fetchLicenses GET /api/v1/licenses/{id} License@show
MetricsApi fetchKeyMetricsV2 GET /api/v2/metrics KeyMetricController@index
ProjectGrantApi fetchAllProjectGrants GET /api/v1/project_grants ProjectGrantController@index
ProjectGrantApi fetchProjectGrant GET /api/v1/project_grants/{id} ProjectGrantController@show
PublicationApi countUniqueFieldsPublications GET /api/v1/publication/count/{field} PublicationController@count
PublicationApi createPublications POST /api/v1/publications PublicationController@store
PublicationApi deletePublications DELETE /api/v1/publications/{id} PublicationController@destroy
PublicationApi editPublications PATCH /api/v1/publications/{id} PublicationController@edit
PublicationApi fetchAllPublications GET /api/v1/publications PublicationController@index
PublicationApi fetchAllPublicationsV2 GET /api/v2/publications PublicationController@indexActive
PublicationApi fetchPublications GET /api/v1/publications/{id} PublicationController@show
PublicationApi fetchPublicationsV2 GET /api/v2/publications/{id} PublicationController@showActive
PublicationApi updatePublications PUT /api/v1/publications/{id} PublicationController@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
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
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 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 countUniqueFieldsTools GET /api/v1/tools/count/{field} ToolController@count
ToolsApi createTools POST /api/v1/tools ToolController@store
ToolsApi createToolsByTeamV2 POST /api/v2/teams/{teamId}/tools ToolController@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 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 editToolsIntegrations PATCH /api/v1/integrations/tools/{id} IntegrationToolController@edit
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 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 updateToolsIntegrations PUT /api/v1/integrations/tools/{id} IntegrationToolController@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

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP Bearer Token authentication (JWT)

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

About

No description or website provided.

Topics

enhanced-gatewayhdruk-sdk

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Used by

Contributors

Languages