Skip to content

TeamFederationsAPI.md

Latest commit

 

History

History
597 lines (380 loc) · 16.9 KB

TeamFederationsAPI.md

File metadata and controls

597 lines (380 loc) · 16.9 KB
Raw

\TeamFederationsAPI

All URIs are relative to http://localhost

Method HTTP request Description
CreateFederationTeam Post /api/v1/teams/{teamId}/federations FederationController@store
DeleteFederation Delete /api/v1/teams/{teamId}/federations/{federationId} FederationController@destroy
GetFederationByFederationIdAndTeamId Get /api/v1/teams/{teamId}/federations/{federationId} FederationController@show
GetFederationHistory Get /api/v1/teams/{teamId}/federations/{federationId}/history FederationController@history
GetFederationTeamId Get /api/v1/teams/{teamId}/federations FederationController@index
RunFederation Get /api/v1/teams/{teamId}/federations/{federationId}/run FederationController@runNow
TestFederation Post /api/v1/teams/{teamId}/federations/test FederationController@testFederation
UpdateFederationTeam Put /api/v1/teams/{teamId}/federations/{federationId} FederationController@update

CreateFederationTeam

CreateDarIntegration201Response CreateFederationTeam(ctx, teamId).CreateFederationTeamRequest(createFederationTeamRequest).Execute()

FederationController@store

Example

package main

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

func main() {
	teamId := int32(1) // int32 | team id
	createFederationTeamRequest := *openapiclient.NewCreateFederationTeamRequest() // CreateFederationTeamRequest | Pass user credentials

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

createFederationTeamRequest | CreateFederationTeamRequest | Pass user credentials |

Return type

CreateDarIntegration201Response

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]

DeleteFederation

DeleteFederation200Response DeleteFederation(ctx, teamId, federationId).Execute()

FederationController@destroy

Example

package main

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

func main() {
	teamId := int32(1) // int32 | team id
	federationId := int32(1) // int32 | federation id

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 team id
federationId int32 federation id

Other Parameters

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

Name Type Description Notes

Return type

DeleteFederation200Response

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]

GetFederationByFederationIdAndTeamId

GetFederationByFederationIdAndTeamId200Response GetFederationByFederationIdAndTeamId(ctx, teamId, federationId).Execute()

FederationController@show

Example

package main

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

func main() {
	teamId := int32(1) // int32 | team id
	federationId := int32(1) // int32 | federation id

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 team id
federationId int32 federation id

Other Parameters

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

Name Type Description Notes

Return type

GetFederationByFederationIdAndTeamId200Response

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]

GetFederationHistory

GetFederationHistory200Response GetFederationHistory(ctx, teamId, federationId).PerPage(perPage).Execute()

FederationController@history

Example

package main

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

func main() {
	teamId := int32(1) // int32 | team id
	federationId := int32(1) // int32 | federation id
	perPage := int32(25) // int32 | per page (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 team id
federationId int32 federation id

Other Parameters

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

Name Type Description Notes

perPage | int32 | per page |

Return type

GetFederationHistory200Response

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]

GetFederationTeamId

GetFederationTeamId200Response GetFederationTeamId(ctx, teamId).Execute()

FederationController@index

Example

package main

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

func main() {
	teamId := int32(1) // int32 | team id

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

GetFederationTeamId200Response

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]

RunFederation

TestFederation200Response RunFederation(ctx, teamId, federationId).Execute()

FederationController@runNow

Example

package main

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

func main() {
	teamId := int32(1) // int32 | team id
	federationId := int32(1) // int32 | federation id

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 team id
federationId int32 federation id

Other Parameters

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

Name Type Description Notes

Return type

TestFederation200Response

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]

TestFederation

TestFederation200Response TestFederation(ctx, teamId).Execute()

FederationController@testFederation

Example

package main

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

func main() {
	teamId := int32(1) // int32 | team id

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

TestFederation200Response

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]

UpdateFederationTeam

CreateDarIntegration201Response UpdateFederationTeam(ctx, teamId, federationId).UpdateFederationTeamRequest(updateFederationTeamRequest).Execute()

FederationController@update

Example

package main

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

func main() {
	teamId := int32(1) // int32 | team id
	federationId := int32(1) // int32 | federation id
	updateFederationTeamRequest := *openapiclient.NewUpdateFederationTeamRequest() // UpdateFederationTeamRequest | Pass user credentials

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamId int32 team id
federationId int32 federation id

Other Parameters

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

Name Type Description Notes

updateFederationTeamRequest | UpdateFederationTeamRequest | Pass user credentials |

Return type

CreateDarIntegration201Response

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]