CommandsAPI.md

\CommandsAPI

All URIs are relative to https://dashboard.quantcdn.io

Method	HTTP request	Description
CreateCommand	Post /api/v3/organizations/{organisation}/environments/{environment}/commands	Create a command for an environment
GetCommand	Get /api/v3/organizations/{organisation}/environments/{environment}/commands/{command}	Get a command
ListCommands	Get /api/v3/organizations/{organisation}/environments/{environment}/commands	Get all commands for an environment

CreateCommand

Command CreateCommand(ctx, organisation, environment).CreateCommandRequest(createCommandRequest).Execute()

Create a command for an environment

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "test-org" // string | The organisation ID
	environment := "test-env" // string | The environment ID
	createCommandRequest := *openapiclient.NewCreateCommandRequest() // CreateCommandRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CommandsAPI.CreateCommand(context.Background(), organisation, environment).CreateCommandRequest(createCommandRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CommandsAPI.CreateCommand``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateCommand`: Command
	fmt.Fprintf(os.Stdout, "Response from `CommandsAPI.CreateCommand`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
environment	string	The environment ID

Other Parameters

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

Name	Type	Description	Notes

createCommandRequest | CreateCommandRequest | |

Return type

Command

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]

GetCommand

Command GetCommand(ctx, organisation, environment, command).Execute()

Get a command

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "test-org" // string | The organisation ID
	environment := "test-env" // string | The environment ID
	command := "test-cmd" // string | The command ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
environment	string	The environment ID
command	string	The command ID

Other Parameters

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

Name	Type	Description	Notes

Return type

Command

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]

ListCommands

Command ListCommands(ctx, organisation, environment).Execute()

Get all commands for an environment

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "test-org" // string | The organisation ID
	environment := "test-env" // string | The environment ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
environment	string	The environment ID

Other Parameters

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

Name	Type	Description	Notes

Return type

Command

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]