portal/openapi/docs/GroupAPI.md

\GroupAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
CreateGroupApiV1GroupsPost	Post /api/v1/groups/	Create Group
DeleteGroupApiV1GroupsGroupIdDelete	Delete /api/v1/groups/{group_id}	Delete Group
GetGroupsApiV1GroupsGet	Get /api/v1/groups/	Get Groups

CreateGroupApiV1GroupsPost

GroupResponse CreateGroupApiV1GroupsPost(ctx).GroupCreate(groupCreate).Execute()

Create Group

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	groupCreate := *openapiclient.NewGroupCreate("Name_example") // GroupCreate | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
groupCreate	GroupCreate

Return type

GroupResponse

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

DeleteGroupApiV1GroupsGroupIdDelete

interface{} DeleteGroupApiV1GroupsGroupIdDelete(ctx, groupId).Execute()

Delete Group

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	groupId := int32(56) // int32 | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

interface{}

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

GetGroupsApiV1GroupsGet

[]GroupResponse GetGroupsApiV1GroupsGet(ctx).Execute()

Get Groups

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]GroupResponse

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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