portal/openapi/docs/GroupAPI.md

\GroupAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
CreateGroupGroupsPost	Post /groups/	Create Group
DeleteGroupGroupsGroupIdDelete	Delete /groups/{group_id}	Delete Group
GetGroupsGroupsGet	Get /groups/	Get Groups

CreateGroupGroupsPost

GroupResponse CreateGroupGroupsPost(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.CreateGroupGroupsPost(context.Background()).GroupCreate(groupCreate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GroupAPI.CreateGroupGroupsPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateGroupGroupsPost`: GroupResponse
	fmt.Fprintf(os.Stdout, "Response from `GroupAPI.CreateGroupGroupsPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateGroupGroupsPostRequest 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]

DeleteGroupGroupsGroupIdDelete

interface{} DeleteGroupGroupsGroupIdDelete(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.DeleteGroupGroupsGroupIdDelete(context.Background(), groupId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GroupAPI.DeleteGroupGroupsGroupIdDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteGroupGroupsGroupIdDelete`: interface{}
	fmt.Fprintf(os.Stdout, "Response from `GroupAPI.DeleteGroupGroupsGroupIdDelete`: %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 apiDeleteGroupGroupsGroupIdDeleteRequest 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]

GetGroupsGroupsGet

[]GroupResponse GetGroupsGroupsGet(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.GetGroupsGroupsGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GroupAPI.GetGroupsGroupsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetGroupsGroupsGet`: []GroupResponse
	fmt.Fprintf(os.Stdout, "Response from `GroupAPI.GetGroupsGroupsGet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetGroupsGroupsGetRequest 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]