\GridViewAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
GridViewAddContext	Post /api/v{version}/GridView/context	Adds new context
GridViewChangeData	Post /api/v{version}/GridView/contexts/{context}/change	Saves grid view row changes and returns change results
GridViewDeleteContext	Delete /api/v{version}/GridView/context/{name}	Deletes specific context
GridViewEditContext	Put /api/v{version}/GridView/context/{name}	Edits specific context
GridViewGetData	Get /api/v{version}/GridView/contexts/{context}/data	Returns grid view data for specific context
GridViewGetGridViewContext	Get /api/v{version}/GridView/context/{name}	Returns a single context in full
GridViewGetGridViewContexts	Get /api/v{version}/GridView/contexts	Returns a list of contexts for grid view.
GridViewGetSchema	Get /api/v{version}/GridView/contexts/{context}/schema	Returns grid view schema for specific context

GridViewAddContext

GridViewAddContext(ctx, version).AddContextRequest(addContextRequest).Execute()

Adds new context

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/max-bytes/omnikeeper-client-go"
)

func main() {
	version := "version_example" // string | 
	addContextRequest := *openapiclient.NewAddContextRequest() // AddContextRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GridViewAPI.GridViewAddContext(context.Background(), version).AddContextRequest(addContextRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GridViewAPI.GridViewAddContext``: %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.
version	string

Other Parameters

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

Name	Type	Description	Notes

addContextRequest | AddContextRequest | |

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: application/json, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/xml, text/plain, text/json, application/*+json
Accept: application/json, application/xml, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, text/plain, application/octet-stream, text/json

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

GridViewChangeData

GridViewChangeData(ctx, context, version).ChangeDataRequest(changeDataRequest).Execute()

Saves grid view row changes and returns change results

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/max-bytes/omnikeeper-client-go"
)

func main() {
	context := "context_example" // string | 
	version := "version_example" // string | 
	changeDataRequest := *openapiclient.NewChangeDataRequest() // ChangeDataRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GridViewAPI.GridViewChangeData(context.Background(), context, version).ChangeDataRequest(changeDataRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GridViewAPI.GridViewChangeData``: %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.
context	string
version	string

Other Parameters

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

Name	Type	Description	Notes

changeDataRequest | ChangeDataRequest | |

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: application/json, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/xml, text/plain, text/json, application/*+json
Accept: application/json, application/xml, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, text/plain, application/octet-stream, text/json

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

GridViewDeleteContext

GridViewDeleteContext(ctx, name, version).Execute()

Deletes specific context

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/max-bytes/omnikeeper-client-go"
)

func main() {
	name := "name_example" // string | 
	version := "version_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GridViewAPI.GridViewDeleteContext(context.Background(), name, version).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GridViewAPI.GridViewDeleteContext``: %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.
name	string
version	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, text/plain, application/octet-stream, text/json

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

GridViewEditContext

GridViewEditContext(ctx, name, version).EditContextRequest(editContextRequest).Execute()

Edits specific context

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/max-bytes/omnikeeper-client-go"
)

func main() {
	name := "name_example" // string | 
	version := "version_example" // string | 
	editContextRequest := *openapiclient.NewEditContextRequest() // EditContextRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GridViewAPI.GridViewEditContext(context.Background(), name, version).EditContextRequest(editContextRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GridViewAPI.GridViewEditContext``: %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.
name	string
version	string

Other Parameters

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

Name	Type	Description	Notes

editContextRequest | EditContextRequest | |

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: application/json, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/xml, text/plain, text/json, application/*+json
Accept: application/json, application/xml, application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, text/plain, application/octet-stream, text/json

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

GridViewGetData

GridViewGetData(ctx, context, version).Execute()

Returns grid view data for specific context

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/max-bytes/omnikeeper-client-go"
)

func main() {
	context := "context_example" // string | 
	version := "version_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GridViewAPI.GridViewGetData(context.Background(), context, version).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GridViewAPI.GridViewGetData``: %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.
context	string
version	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

GridViewGetGridViewContext

GridViewGetGridViewContext(ctx, name, version).Execute()

Returns a single context in full

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/max-bytes/omnikeeper-client-go"
)

func main() {
	name := "name_example" // string | 
	version := "version_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GridViewAPI.GridViewGetGridViewContext(context.Background(), name, version).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GridViewAPI.GridViewGetGridViewContext``: %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.
name	string
version	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

GridViewGetGridViewContexts

GridViewGetGridViewContexts(ctx, version).Execute()

Returns a list of contexts for grid view.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/max-bytes/omnikeeper-client-go"
)

func main() {
	version := "version_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GridViewAPI.GridViewGetGridViewContexts(context.Background(), version).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GridViewAPI.GridViewGetGridViewContexts``: %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.
version	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

GridViewGetSchema

GridViewGetSchema(ctx, context, version).Execute()

Returns grid view schema for specific context

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/max-bytes/omnikeeper-client-go"
)

func main() {
	context := "context_example" // string | 
	version := "version_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.GridViewAPI.GridViewGetSchema(context.Background(), context, version).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `GridViewAPI.GridViewGetSchema``: %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.
context	string
version	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

FilesExpand file tree

GridViewAPI.md

Latest commit

History

GridViewAPI.md

File metadata and controls

\GridViewAPI

GridViewAddContext

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GridViewChangeData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GridViewDeleteContext

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GridViewEditContext

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GridViewGetData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GridViewGetGridViewContext

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GridViewGetGridViewContexts

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GridViewGetSchema

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers