Go API client for gatewayapisdk

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 2.0.0
• Package version: 2.55.0
• Generator version: 7.24.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Import the package in a go file in your project and run go mod tidy:

import gatewayapisdk "github.com/HDRUK/gateway-api-go-sdk"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value gatewayapisdk.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), gatewayapisdk.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value gatewayapisdk.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), gatewayapisdk.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using gatewayapisdk.ContextOperationServerIndices and gatewayapisdk.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), gatewayapisdk.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), gatewayapisdk.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

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
DatasetLinkCheckResultsAPI	FetchDatasetLinkCheckResultsV2	Get /api/v2/dataset_link_check_results	DatasetLinkCheckResultController@index
DatasetsAPI	CountUniqueFields	Get /api/v1/datasets/count/{field}	DatasetController@count
DatasetsAPI	CreateDatasets	Post /api/v1/datasets	DatasetController@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	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	FetchAllDatasetsV2	Get /api/v2/datasets	DatasetController@index
DatasetsAPI	FetchDatasets	Get /api/v1/datasets/{id}	DatasetController@show
DatasetsAPI	FetchDatasetsV2	Get /api/v2/datasets/{id}	DatasetController@showActive
DatasetsAPI	PatchDatasets	Patch /api/v1/datasets/{id}	DatasetController@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	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
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
NightlyDatasetTestsAPI	FetchNightlyDatasetTestsV2	Get /api/v2/nightly_dataset_tests	NightlyDatasetTestController@index
ProjectGrantAPI	CreateProjectGrant	Post /api/v1/project_grants	ProjectGrantController@store
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	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

• Alias
• Authentication200Response
• AuthenticationRequest
• Category
• Collection
• CountUniqueFieldsCollections200Response
• CreateApplications200Response
• CreateApplications200ResponseDataInner
• CreateApplications500Response
• CreateApplicationsRequest
• CreateCollectionsIntegrationsRequest
• CreateCollectionsIntegrationsRequestDatasetsInner
• CreateCollectionsRequest
• CreateCsat422Response
• CreateCsatRequest
• CreateDarIntegration201Response
• CreateDarSectionRequest
• CreateDarTemplateRequest
• CreateDarTemplateRequestQuestionsInner
• CreateDatasetsRequest
• CreateDurIntegrationsRequest
• CreateDurRequest
• CreateDurRequestDatasetsInner
• CreateDurRequestPublicationsInner
• CreateDurRequestTeamInner
• CreateDurRequestUsersInner
• CreateFederationTeamRequest
• CreateProjectGrant201Response
• CreatePublicationsRequest
• CreatePublicationsRequestDatasetsInner
• CreatePublicationsRequestToolsInner
• CreateQuestionBankQuestionRequest
• CreateQuestionBankQuestionRequestOptionsInner
• CreateQuestionBankQuestionRequestOptionsInnerChildrenInner
• CreateQuestionBankQuestionRequestOptionsInnerChildrenInnerOptionsInner
• CreateTeamDarApplicationReviewRequest
• CreateToolsIntegrations400Response
• CreateToolsIntegrationsRequest
• CreateToolsIntegrationsRequestDatasetInner
• CreateToolsIntegrationsRequestPublicationsInner
• CreateToolsRequest
• CreateToolsRequestCollectionsInner
• CreateWidget201Response
• CreateWidget400Response
• CreateWidgetRequest
• DataAccessApplication
• DataAccessApplicationReview
• DataCustodianNetwork
• Dataset
• DatasetVersion
• DatasetsTestRequest
• DeleteApplications200Response
• DeleteFederation200Response
• DeleteFederation404Response
• Dur
• EditApplicationsRequest
• EditCollectionsV2Request
• EditCsat200Response
• EditCsatRequest
• EditDarIntegrationRequest
• EditQuestionBankQuestionRequest
• ExportDatasetMetadata400Response
• ExportMockDataset404Response
• FetchAllApplications200Response
• FetchAllApplications200ResponseDataInner
• FetchAllCollections200Response
• FetchAllDarIntegrations200Response
• FetchAllDarIntegrations200ResponseDataInner
• FetchAllDarIntegrations401Response
• FetchAllDatasets200Response
• FetchAllDur200Response
• FetchAllDurIntegrations200Response
• FetchAllDurIntegrations200ResponseDataInner
• FetchAllDurV2200Response
• FetchAllLicenses200Response
• FetchAllProjectGrants200Response
• FetchAllPublications200Response
• FetchAllSitemap200Response
• FetchAllSitemap200ResponseDataInner
• FetchAllTools200Response
• FetchAllTools500Response
• FetchAllToolsIntegrations200Response
• FetchAllWidgets200Response
• FetchApplications200Response
• FetchApplications200ResponseDataInner
• FetchCollections200Response
• FetchCustomQuestionBankQuestions200Response
• FetchDarTemplate200Response
• FetchDarTemplates200Response
• FetchDarTemplates200ResponseDataInner
• FetchDataCustodianNetwork200Response
• FetchDataCustodianNetworkCustodiansSummary200Response
• FetchDataCustodianNetworkCustodiansSummary200ResponseData
• FetchDataCustodianNetworkDatasetsSummary200Response
• FetchDataCustodianNetworkDatasetsSummary200ResponseData
• FetchDataCustodianNetworkEntitiesSummary200Response
• FetchDataCustodianNetworkEntitiesSummary200ResponseData
• FetchDataCustodianNetworkInfo200Response
• FetchDataCustodianNetworkInfo200ResponseData
• FetchDataCustodianNetworks200Response
• FetchDataProviderColl200Response
• FetchDataProviderCollSummary200Response
• FetchDataProviderCollSummary200ResponseData
• FetchDataProviderColls200Response
• FetchDataProviderColls200ResponseDataInner
• FetchDatasetLinkCheckResultsV2200Response
• FetchDatasets200Response
• FetchDurById200Response
• FetchDurByIdIntegrations200Response
• FetchDurByIdIntegrations200ResponseDataInner
• FetchLicenses200Response
• FetchPublications200Response
• FetchQuestionBankQuestion200Response
• FetchQuestionBankQuestion200ResponseData
• FetchQuestionBankQuestionVersion200Response
• FetchQuestionBankQuestionVersion200ResponseData
• FetchQuestionBankQuestions200Response
• FetchStandardQuestionBankQuestions200Response
• FetchTeamDarApplication200Response
• FetchTeamDarApplicationAnswers200Response
• FetchTeamDarApplicationAnswers200ResponseData
• FetchTeamDarApplicationFiles200Response
• FetchTeamDarApplicationFiles200ResponseData
• FetchTeamDarApplicationReviews200Response
• FetchTeamDarApplicationStatusHistory200Response
• FetchTeamDarApplicationStatusHistory200ResponseData
• FetchTeamDarApplications200Response
• FetchTeamQuestionBankQuestionsBySection200Response
• FetchTeamQuestionBankQuestionsBySection200ResponseDataInner
• FetchToolsIntegrations200Response
• FetchWidget200Response
• FetchWidgetDataSources200Response
• FetchWidgetDataSources400Response
• GetCancerTypeFilter200Response
• GetCancerTypeFilter404Response
• GetCancerTypeFilters200Response
• GetCancerTypeFilters200ResponseDataInner
• GetFederationByFederationIdAndTeamId200Response
• GetFederationByFederationIdAndTeamId200ResponseData
• GetFederationHistory200Response
• GetFederationHistory200ResponseDataInner
• GetFederationHistory200ResponseDataInnerFailedDatasetsInner
• GetFederationTeamId200Response
• GetFederationTeamId200ResponseDataInner
• GetFederationTeamId200ResponseDataInnerProgress
• Keyword
• License
• LoginRequest
• Notification
• PatchDarSectionRequest
• PatchDarTemplate200Response
• PatchDarTemplate200ResponseData
• PatchDarTemplateRequest
• PatchDatasetsV2Request
• ProgrammingLanguage
• ProgrammingPackage
• Publication
• QuestionBank
• Register200Response
• Register200ResponseUser
• RegisterRequest
• RetrieveWidgetData200Response
• RetrieveWidgetData403Response
• RunFederation404Response
• RunFederation409Response
• 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
• UpdateApplications200Response
• UpdateApplications200ResponseData
• UpdateApplications404Response
• UpdateApplicationsRequest
• UpdateCollectionsV2Request
• UpdateDarIntegration200Response
• UpdateDarIntegrationRequest
• UpdateDarSection200Response
• UpdateDarSection200ResponseData
• UpdateDarTemplateRequest
• UpdateDatasetsRequest
• UpdateDur200Response
• UpdateDurIntegrations200Response
• UpdateDurIntegrations200ResponseData
• UpdateFederationTeamRequest
• UpdatePublicationsRequest
• UpdateQuestionBankQuestion200Response
• UpdateQuestionBankQuestionRequest
• UpdateQuestionBankQuestionStatus200Response
• UpdateTeamDarApplicationQuestionReview200Response
• UpdateTeamDarApplicationRequest
• UpdateToolsIntegrationsRequest
• UpdateToolsRequest
• UpdateWidget200Response
• UpdateWidgetRequest
• UploadDurRequest
• User
• VerifySecondaryEmail200Response
• VerifySecondaryEmail400Response
• VerifySecondaryEmail404Response
• Widget
• WidgetAnalytics200Response

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), gatewayapisdk.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author