client\ViewColumnApi

All URIs are relative to https://api.gridly.com

Method	HTTP request	Description
Add	Post /v1/views/{viewId}/columns/{columnId}/add	add
BulkCreate	Post /v1/views/{viewId}/columns/bulk	bulkCreate
Create	Post /v1/views/{viewId}/columns	create
Delete	Delete /v1/views/{viewId}/columns/{columnId}	delete
Get	Get /v1/views/{viewId}/columns/{columnId}	get
Remove	Post /v1/views/{viewId}/columns/{columnId}/remove	remove
Update	Patch /v1/views/{viewId}/columns/{columnId}	update

Add

ViewColumn Add(ctx, columnId, viewId).Execute()

add

Example

package main

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

func main() {
    columnId := "columnId_example" // string | columnId
    viewId := "viewId_example" // string | viewId

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewColumnApi.Add(context.Background(), columnId, viewId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewColumnApi.Add``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Add`: ViewColumn
    fmt.Fprintf(os.Stdout, "Response from `ViewColumnApi.Add`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
columnId	string	columnId
viewId	string	viewId

Other Parameters

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

Name	Type	Description	Notes

Return type

ViewColumn

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

BulkCreate

[]ViewColumn BulkCreate(ctx, viewId).CreateColumn(createColumn).Execute()

bulkCreate

Example

package main

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

func main() {
    viewId := "viewId_example" // string | viewId
    createColumn := []gridly.CreateColumn{*gridly.NewCreateColumn("Name_example", "Type_example")} // []CreateColumn | 

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewColumnApi.BulkCreate(context.Background(), viewId).CreateColumn(createColumn).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewColumnApi.BulkCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BulkCreate`: []ViewColumn
    fmt.Fprintf(os.Stdout, "Response from `ViewColumnApi.BulkCreate`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

createColumn | []CreateColumn | |

Return type

[]ViewColumn

Authorization

ApiKey

HTTP request headers

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

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

Create

ViewColumn Create(ctx, viewId).CreateColumn(createColumn).Execute()

create

Example

package main

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

func main() {
    viewId := "viewId_example" // string | viewId
    createColumn := *gridly.NewCreateColumn("Name_example", "Type_example") // CreateColumn | 

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewColumnApi.Create(context.Background(), viewId).CreateColumn(createColumn).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewColumnApi.Create``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Create`: ViewColumn
    fmt.Fprintf(os.Stdout, "Response from `ViewColumnApi.Create`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

createColumn | CreateColumn | |

Return type

ViewColumn

Authorization

ApiKey

HTTP request headers

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

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

Delete

Delete(ctx, columnId, viewId).Execute()

delete

Example

package main

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

func main() {
    columnId := "columnId_example" // string | columnId
    viewId := "viewId_example" // string | viewId

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewColumnApi.Delete(context.Background(), columnId, viewId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewColumnApi.Delete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
columnId	string	columnId
viewId	string	viewId

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Get

ViewColumn Get(ctx, columnId, viewId).Execute()

get

Example

package main

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

func main() {
    columnId := "columnId_example" // string | columnId
    viewId := "viewId_example" // string | viewId

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewColumnApi.Get(context.Background(), columnId, viewId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewColumnApi.Get``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Get`: ViewColumn
    fmt.Fprintf(os.Stdout, "Response from `ViewColumnApi.Get`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
columnId	string	columnId
viewId	string	viewId

Other Parameters

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

Name	Type	Description	Notes

Return type

ViewColumn

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Remove

Remove(ctx, columnId, viewId).Execute()

remove

Example

package main

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

func main() {
    columnId := "columnId_example" // string | columnId
    viewId := "viewId_example" // string | viewId

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewColumnApi.Remove(context.Background(), columnId, viewId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewColumnApi.Remove``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
columnId	string	columnId
viewId	string	viewId

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Update

ViewColumn Update(ctx, columnId, viewId).UpdateColumn(updateColumn).Execute()

update

Example

package main

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

func main() {
    columnId := "columnId_example" // string | columnId
    viewId := "viewId_example" // string | viewId
    updateColumn := *gridly.NewUpdateColumn() // UpdateColumn | 

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewColumnApi.Update(context.Background(), columnId, viewId).UpdateColumn(updateColumn).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewColumnApi.Update``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Update`: ViewColumn
    fmt.Fprintf(os.Stdout, "Response from `ViewColumnApi.Update`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
columnId	string	columnId
viewId	string	viewId

Other Parameters

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

Name	Type	Description	Notes

updateColumn | UpdateColumn | |

Return type

ViewColumn

Authorization

ApiKey

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

ViewColumnApi.md

Latest commit

History

ViewColumnApi.md

File metadata and controls

client\ViewColumnApi

Add

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

BulkCreate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Create

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Delete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Get

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Remove

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Update

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers