Skip to content

Latest commit

 

History

History
445 lines (282 loc) · 11 KB

ViewDependencyApi.md

File metadata and controls

445 lines (282 loc) · 11 KB
Raw

client\ViewDependencyApi

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

Method HTTP request Description
Create Post /v1/views/{viewId}/dependencies create
Delete Delete /v1/views/{viewId}/dependencies delete
DeleteById Delete /v1/views/{viewId}/dependencies/{dependencyId} deleteById
Get Get /v1/views/{viewId}/dependencies/{dependencyId} get
List Get /v1/views/{viewId}/dependencies list
Update Put /v1/views/{viewId}/dependencies/{dependencyId} update

Create

Dependency Create(ctx, viewId).CreateDependency(createDependency).Execute()

create

Example

package main

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

func main() {
    viewId := "viewId_example" // string | viewId
    createDependency := *gridly.NewCreateDependency("TargetColumnId_example", "SourceColumnId_example") // CreateDependency | 

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewDependencyApi.Create(context.Background(), viewId).CreateDependency(createDependency).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewDependencyApi.Create``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Create`: Dependency
    fmt.Fprintf(os.Stdout, "Response from `ViewDependencyApi.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

createDependency | CreateDependency | |

Return type

Dependency

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, viewId).DeleteDependency(deleteDependency).Execute()

delete

Example

package main

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

func main() {
    viewId := "viewId_example" // string | viewId
    deleteDependency := *gridly.NewDeleteDependency() // DeleteDependency | 

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

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 apiDeleteRequest struct via the builder pattern

Name Type Description Notes

deleteDependency | DeleteDependency | |

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

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

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

DeleteById

DeleteById(ctx, viewId, dependencyId).Execute()

deleteById

Example

package main

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

func main() {
    viewId := "viewId_example" // string | viewId
    dependencyId := "dependencyId_example" // string | dependencyId

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

Path Parameters

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

Other Parameters

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

Dependency Get(ctx, dependencyId, viewId).Execute()

get

Example

package main

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

func main() {
    dependencyId := "dependencyId_example" // string | dependencyId
    viewId := "viewId_example" // string | viewId

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dependencyId string dependencyId
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

Dependency

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]

List

[]Dependency List(ctx, viewId).Execute()

list

Example

package main

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

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

    configuration := gridly.NewConfiguration()
    apiClient := gridly.NewAPIClient(configuration)
    resp, r, err := apiClient.ViewDependencyApi.List(context.Background(), viewId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ViewDependencyApi.List``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `List`: []Dependency
    fmt.Fprintf(os.Stdout, "Response from `ViewDependencyApi.List`: %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 apiListRequest struct via the builder pattern

Name Type Description Notes

Return type

[]Dependency

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]

Update

Dependency Update(ctx, dependencyId, viewId).UpdateDependency(updateDependency).Execute()

update

Example

package main

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

func main() {
    dependencyId := "dependencyId_example" // string | dependencyId
    viewId := "viewId_example" // string | viewId
    updateDependency := *gridly.NewUpdateDependency("TargetColumnId_example", "SourceColumnId_example") // UpdateDependency | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

updateDependency | UpdateDependency | |

Return type

Dependency

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]