Skip to content

DataAccessApplicationAPI.md

Latest commit

 

History

History
530 lines (335 loc) · 15.3 KB

DataAccessApplicationAPI.md

File metadata and controls

530 lines (335 loc) · 15.3 KB
Raw

\DataAccessApplicationAPI

All URIs are relative to http://localhost

Method HTTP request Description
DeleteTeamDarApplicationFile Delete /api/v1/teams/{teamId}/dar/applications/{id}/files/{fileId} DataAccessApplication@destroyFile
FetchTeamDarApplicationAnswers Get /api/v1/teams/{teamId}/dar/applications/{id}/answers DataAccessApplication@showAnswers
FetchTeamDarApplicationDownloadZip Get /api/v1/teams/{teamId}/dar/applications/{id}/download DataAccessApplication@download
FetchTeamDarApplicationFile Get /api/v1/teams/{teamId}/dar/applications/{id}/files/{fileId}/download DataAccessApplication@downloadFile
FetchTeamDarApplicationFiles Get /api/v1/teams/{teamId}/dar/applications/{id}/files DataAccessApplication@showFiles
FetchTeamDarApplicationStatusHistory Get /api/v1/teams/{teamId}/dar/applications/{id}/status DataAccessApplication@status
UpdateTeamDarApplication Patch /api/v1/teams/{teamId}/dar/applications/{id} DataAccessApplication@update

DeleteTeamDarApplicationFile

DeleteApplications200Response DeleteTeamDarApplicationFile(ctx, teamId, id, fileId).Execute()

DataAccessApplication@destroyFile

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	teamId := int32(1) // int32 | Team id
	id := int32(1) // int32 | DAR application id
	fileId := int32(1) // int32 | File id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DataAccessApplicationAPI.DeleteTeamDarApplicationFile(context.Background(), teamId, id, fileId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DataAccessApplicationAPI.DeleteTeamDarApplicationFile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteTeamDarApplicationFile`: DeleteApplications200Response
	fmt.Fprintf(os.Stdout, "Response from `DataAccessApplicationAPI.DeleteTeamDarApplicationFile`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 Team id
id int32 DAR application id
fileId int32 File id

Other Parameters

Other parameters are passed through a pointer to a apiDeleteTeamDarApplicationFileRequest struct via the builder pattern

Name Type Description Notes

Return type

DeleteApplications200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchTeamDarApplicationAnswers

FetchTeamDarApplicationAnswers200Response FetchTeamDarApplicationAnswers(ctx, teamId, id).Execute()

DataAccessApplication@showAnswers

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	teamId := int32(1) // int32 | Team id
	id := int32(1) // int32 | DAR application id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DataAccessApplicationAPI.FetchTeamDarApplicationAnswers(context.Background(), teamId, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DataAccessApplicationAPI.FetchTeamDarApplicationAnswers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `FetchTeamDarApplicationAnswers`: FetchTeamDarApplicationAnswers200Response
	fmt.Fprintf(os.Stdout, "Response from `DataAccessApplicationAPI.FetchTeamDarApplicationAnswers`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 Team id
id int32 DAR application id

Other Parameters

Other parameters are passed through a pointer to a apiFetchTeamDarApplicationAnswersRequest struct via the builder pattern

Name Type Description Notes

Return type

FetchTeamDarApplicationAnswers200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchTeamDarApplicationDownloadZip

FetchTeamDarApplicationDownloadZip(ctx, teamId, id).Execute()

DataAccessApplication@download

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	teamId := int32(1) // int32 | Team id
	id := int32(1) // int32 | DAR application id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.DataAccessApplicationAPI.FetchTeamDarApplicationDownloadZip(context.Background(), teamId, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DataAccessApplicationAPI.FetchTeamDarApplicationDownloadZip``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 Team id
id int32 DAR application id

Other Parameters

Other parameters are passed through a pointer to a apiFetchTeamDarApplicationDownloadZipRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: file, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchTeamDarApplicationFile

FetchTeamDarApplicationFile(ctx, teamId, id, fileId).Execute()

DataAccessApplication@downloadFile

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	teamId := int32(1) // int32 | Team id
	id := int32(1) // int32 | DAR application id
	fileId := "1" // string | File uuid

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.DataAccessApplicationAPI.FetchTeamDarApplicationFile(context.Background(), teamId, id, fileId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DataAccessApplicationAPI.FetchTeamDarApplicationFile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 Team id
id int32 DAR application id
fileId string File uuid

Other Parameters

Other parameters are passed through a pointer to a apiFetchTeamDarApplicationFileRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: file, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchTeamDarApplicationFiles

FetchTeamDarApplicationFiles200Response FetchTeamDarApplicationFiles(ctx, teamId, id).Execute()

DataAccessApplication@showFiles

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	teamId := int32(1) // int32 | Team id
	id := int32(1) // int32 | DAR application id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DataAccessApplicationAPI.FetchTeamDarApplicationFiles(context.Background(), teamId, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DataAccessApplicationAPI.FetchTeamDarApplicationFiles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `FetchTeamDarApplicationFiles`: FetchTeamDarApplicationFiles200Response
	fmt.Fprintf(os.Stdout, "Response from `DataAccessApplicationAPI.FetchTeamDarApplicationFiles`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 Team id
id int32 DAR application id

Other Parameters

Other parameters are passed through a pointer to a apiFetchTeamDarApplicationFilesRequest struct via the builder pattern

Name Type Description Notes

Return type

FetchTeamDarApplicationFiles200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchTeamDarApplicationStatusHistory

FetchTeamDarApplicationStatusHistory200Response FetchTeamDarApplicationStatusHistory(ctx, teamId, id).Execute()

DataAccessApplication@status

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	teamId := int32(1) // int32 | Team id
	id := int32(1) // int32 | DAR application id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DataAccessApplicationAPI.FetchTeamDarApplicationStatusHistory(context.Background(), teamId, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DataAccessApplicationAPI.FetchTeamDarApplicationStatusHistory``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `FetchTeamDarApplicationStatusHistory`: FetchTeamDarApplicationStatusHistory200Response
	fmt.Fprintf(os.Stdout, "Response from `DataAccessApplicationAPI.FetchTeamDarApplicationStatusHistory`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 Team id
id int32 DAR application id

Other Parameters

Other parameters are passed through a pointer to a apiFetchTeamDarApplicationStatusHistoryRequest struct via the builder pattern

Name Type Description Notes

Return type

FetchTeamDarApplicationStatusHistory200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTeamDarApplication

FetchTeamDarApplication200Response UpdateTeamDarApplication(ctx, teamId, id).UpdateTeamDarApplicationRequest(updateTeamDarApplicationRequest).Execute()

DataAccessApplication@update

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	teamId := int32(1) // int32 | Team id
	id := int32(1) // int32 | DAR application id
	updateTeamDarApplicationRequest := *openapiclient.NewUpdateTeamDarApplicationRequest() // UpdateTeamDarApplicationRequest | DataAccessApplication definition

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DataAccessApplicationAPI.UpdateTeamDarApplication(context.Background(), teamId, id).UpdateTeamDarApplicationRequest(updateTeamDarApplicationRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DataAccessApplicationAPI.UpdateTeamDarApplication``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateTeamDarApplication`: FetchTeamDarApplication200Response
	fmt.Fprintf(os.Stdout, "Response from `DataAccessApplicationAPI.UpdateTeamDarApplication`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 Team id
id int32 DAR application id

Other Parameters

Other parameters are passed through a pointer to a apiUpdateTeamDarApplicationRequest struct via the builder pattern

Name Type Description Notes

updateTeamDarApplicationRequest | UpdateTeamDarApplicationRequest | DataAccessApplication definition |

Return type

FetchTeamDarApplication200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]