\OrgWorkspaceModVariables

All URIs are relative to https://pipes.turbot.com/api/v0

Method	HTTP request	Description
CreateSetting	Post /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable	Create a setting for a mod variable in an organization workspace
DeleteSetting	Delete /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name}	Delete setting for a mod variable in an organization workspace
GetSetting	Get /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name}	Get setting for a mod variable in an organization workspace
List	Get /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable	List variables in an organization workspace mod
UpdateSetting	Patch /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name}	Update setting for a mod variable in an organization workspace

CreateSetting

WorkspaceModVariable CreateSetting(ctx, orgHandle, workspaceHandle, modAlias).Request(request).Execute()

Create a setting for a mod variable in an organization workspace

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    orgHandle := "orgHandle_example" // string | The handle of the organization that owns the workspace.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace where the mod was installed.
    modAlias := "modAlias_example" // string | The mod alias or mod ID for which the variable setting is to be created.
    request := *openapiclient.NewCreateWorkspaceModVariableSettingRequest("Name_example", interface{}(123)) // CreateWorkspaceModVariableSettingRequest | The request body to create setting for mod variable in the organization workspace.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.OrgWorkspaceModVariables.CreateSetting(context.Background(), orgHandle, workspaceHandle, modAlias).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OrgWorkspaceModVariables.CreateSetting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateSetting`: WorkspaceModVariable
    fmt.Fprintf(os.Stdout, "Response from `OrgWorkspaceModVariables.CreateSetting`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgHandle	string	The handle of the organization that owns the workspace.
workspaceHandle	string	The handle of the workspace where the mod was installed.
modAlias	string	The mod alias or mod ID for which the variable setting is to be created.

Other Parameters

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

Name	Type	Description	Notes

request | CreateWorkspaceModVariableSettingRequest | The request body to create setting for mod variable in the organization workspace. |

Return type

WorkspaceModVariable

Authorization

No authorization required

HTTP request headers

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

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

DeleteSetting

WorkspaceModVariable DeleteSetting(ctx, orgHandle, workspaceHandle, modAlias, variableName).Execute()

Delete setting for a mod variable in an organization workspace

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    orgHandle := "orgHandle_example" // string | The handle of the organization that owns the workspace.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace where the mod was installed.
    modAlias := "modAlias_example" // string | The mod alias or mod ID which contains the variable.
    variableName := "variableName_example" // string | The name of the variable to delete the setting for.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.OrgWorkspaceModVariables.DeleteSetting(context.Background(), orgHandle, workspaceHandle, modAlias, variableName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OrgWorkspaceModVariables.DeleteSetting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteSetting`: WorkspaceModVariable
    fmt.Fprintf(os.Stdout, "Response from `OrgWorkspaceModVariables.DeleteSetting`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgHandle	string	The handle of the organization that owns the workspace.
workspaceHandle	string	The handle of the workspace where the mod was installed.
modAlias	string	The mod alias or mod ID which contains the variable.
variableName	string	The name of the variable to delete the setting for.

Other Parameters

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

Name	Type	Description	Notes

Return type

WorkspaceModVariable

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetSetting

WorkspaceModVariable GetSetting(ctx, orgHandle, workspaceHandle, modAlias, variableName).Execute()

Get setting for a mod variable in an organization workspace

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    orgHandle := "orgHandle_example" // string | The handle of the organization that owns the workspace.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace where the mod was installed.
    modAlias := "modAlias_example" // string | The mod alias or mod ID for which the variable setting belongs to.
    variableName := "variableName_example" // string | The name of the variable to get the setting for.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.OrgWorkspaceModVariables.GetSetting(context.Background(), orgHandle, workspaceHandle, modAlias, variableName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OrgWorkspaceModVariables.GetSetting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSetting`: WorkspaceModVariable
    fmt.Fprintf(os.Stdout, "Response from `OrgWorkspaceModVariables.GetSetting`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgHandle	string	The handle of the organization that owns the workspace.
workspaceHandle	string	The handle of the workspace where the mod was installed.
modAlias	string	The mod alias or mod ID for which the variable setting belongs to.
variableName	string	The name of the variable to get the setting for.

Other Parameters

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

Name	Type	Description	Notes

Return type

WorkspaceModVariable

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

List

ListWorkspaceModVariablesResponse List(ctx, orgHandle, workspaceHandle, modAlias).Limit(limit).NextToken(nextToken).Execute()

List variables in an organization workspace mod

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    orgHandle := "orgHandle_example" // string | The handle of the organization that owns the workspace.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace where the mod was installed.
    modAlias := "modAlias_example" // string | The mod alias or mod ID for which we want the variables to be listed.
    limit := int32(56) // int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. (optional) (default to 25)
    nextToken := "nextToken_example" // string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.OrgWorkspaceModVariables.List(context.Background(), orgHandle, workspaceHandle, modAlias).Limit(limit).NextToken(nextToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OrgWorkspaceModVariables.List``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `List`: ListWorkspaceModVariablesResponse
    fmt.Fprintf(os.Stdout, "Response from `OrgWorkspaceModVariables.List`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgHandle	string	The handle of the organization that owns the workspace.
workspaceHandle	string	The handle of the workspace where the mod was installed.
modAlias	string	The mod alias or mod ID for which we want the variables to be listed.

Other Parameters

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

Name	Type	Description	Notes

limit | int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | [default to 25] nextToken | string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. |

Return type

ListWorkspaceModVariablesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UpdateSetting

WorkspaceModVariable UpdateSetting(ctx, orgHandle, workspaceHandle, modAlias, variableName).Request(request).Execute()

Update setting for a mod variable in an organization workspace

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    orgHandle := "orgHandle_example" // string | The handle of the organization that owns the workspace.
    workspaceHandle := "workspaceHandle_example" // string | The handle of the workspace where the mod was installed.
    modAlias := "modAlias_example" // string | The mod alias or mod ID which contains the variable.
    variableName := "variableName_example" // string | The name of the variable for which setting is to be updated.
    request := *openapiclient.NewUpdateWorkspaceModVariableSettingRequest(interface{}(123)) // UpdateWorkspaceModVariableSettingRequest | The request body to update setting for mod variable in the organization workspace.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.OrgWorkspaceModVariables.UpdateSetting(context.Background(), orgHandle, workspaceHandle, modAlias, variableName).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OrgWorkspaceModVariables.UpdateSetting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateSetting`: WorkspaceModVariable
    fmt.Fprintf(os.Stdout, "Response from `OrgWorkspaceModVariables.UpdateSetting`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgHandle	string	The handle of the organization that owns the workspace.
workspaceHandle	string	The handle of the workspace where the mod was installed.
modAlias	string	The mod alias or mod ID which contains the variable.
variableName	string	The name of the variable for which setting is to be updated.

Other Parameters

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

Name	Type	Description	Notes

request | UpdateWorkspaceModVariableSettingRequest | The request body to update setting for mod variable in the organization workspace. |

Return type

WorkspaceModVariable

Authorization

No authorization required

HTTP request headers

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

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

Files

OrgWorkspaceModVariables.md

Latest commit

History

OrgWorkspaceModVariables.md

File metadata and controls

\OrgWorkspaceModVariables

CreateSetting

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteSetting

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetSetting

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

List

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateSetting

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers