All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
DataSourcesCountDataSourcesAsync | Get /api/data/v1/DataSources/{subscriptionId}/count | Returns a number of data sources in subscription |
DataSourcesCreateDataSource | Post /api/data/v1/DataSources | Create new data source |
DataSourcesDeleteDataSource | Delete /api/data/v1/DataSources/{id} | Delete data source by id |
DataSourcesFetchData | Get /api/data/v1/DataSources/{id}/fetch | This should connect to a database and set data structure |
DataSourcesGetAvailableDataSources | Get /api/data/v1/DataSources | Returns all of the data sources, that current user have permission for in a subscription <br /> The method will return minimal infomration about the datasources: <br /> id, name, editedTime, status. |
DataSourcesGetDataSource | Get /api/data/v1/DataSources/{id} | Get data source by id |
DataSourcesGetParameterTypes | Get /api/data/v1/DataSources/parameterTypes/{dataSourceType} | Get data source parameter DataType's |
DataSourcesGetPermissions | Get /api/data/v1/DataSources/{id}/permissions | Get all Data source permissions |
DataSourcesRenameDataSource | Put /api/data/v1/DataSources/{id}/rename | Rename data source by id |
DataSourcesUpdateConnectionString | Put /api/data/v1/DataSources/{id}/connectionString | Update data source's connection string by id |
DataSourcesUpdatePermissions | Post /api/data/v1/DataSources/{id}/permissions | Update permissions |
DataSourcesUpdateSelectCommands | Put /api/data/v1/DataSources/{id}/selectCommands | Update data source's select commands by id |
DataSourcesUpdateSubscriptionDataSource | Put /api/data/v1/DataSources/{id}/updateSubscription | Update data source's subscription |
int64 DataSourcesCountDataSourcesAsync(ctx, subscriptionId).Execute()
Returns a number of data sources in subscription
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | subscripiton id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesCountDataSourcesAsync(context.Background(), subscriptionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesCountDataSourcesAsync``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesCountDataSourcesAsync`: int64
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesCountDataSourcesAsync`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | subscripiton id |
Other parameters are passed through a pointer to a apiDataSourcesCountDataSourcesAsyncRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
int64
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourceVM DataSourcesCreateDataSource(ctx).CreateDataSourceVM(createDataSourceVM).Execute()
Create new data source
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
createDataSourceVM := *openapiclient.NewCreateDataSourceVM("ConnectionString_example", "SubscriptionId_example", "T_example") // CreateDataSourceVM | create viewmodel (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesCreateDataSource(context.Background()).CreateDataSourceVM(createDataSourceVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesCreateDataSource``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesCreateDataSource`: DataSourceVM
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesCreateDataSource`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiDataSourcesCreateDataSourceRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
createDataSourceVM | CreateDataSourceVM | create viewmodel |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourcesDeleteDataSource(ctx, id).Execute()
Delete data source by id
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | data source id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.DataSourcesAPI.DataSourcesDeleteDataSource(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesDeleteDataSource``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | data source id |
Other parameters are passed through a pointer to a apiDataSourcesDeleteDataSourceRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourcesFetchData(ctx, id).Execute()
This should connect to a database and set data structure
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | datasource's id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.DataSourcesAPI.DataSourcesFetchData(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesFetchData``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | datasource's id |
Other parameters are passed through a pointer to a apiDataSourcesFetchDataRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourcesVM DataSourcesGetAvailableDataSources(ctx).SubscriptionId(subscriptionId).Skip(skip).Take(take).OrderBy(orderBy).Desc(desc).Execute()
Returns all of the data sources, that current user have permission for in a subscription
The method will return minimal infomration about the datasources:
id, name, editedTime, status.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | id of subscription where the datasources are located (optional)
skip := int32(56) // int32 | how many data sources will be skipped (optional) (default to 0)
take := int32(56) // int32 | how many data sources will be taken (optional) (default to 10)
orderBy := openapiclient.DataSourceSorting("CreatedTime") // DataSourceSorting | field to order by (optional)
desc := true // bool | descending sort (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesGetAvailableDataSources(context.Background()).SubscriptionId(subscriptionId).Skip(skip).Take(take).OrderBy(orderBy).Desc(desc).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesGetAvailableDataSources``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesGetAvailableDataSources`: DataSourcesVM
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesGetAvailableDataSources`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiDataSourcesGetAvailableDataSourcesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
subscriptionId | string | id of subscription where the datasources are located | |
skip | int32 | how many data sources will be skipped | [default to 0] |
take | int32 | how many data sources will be taken | [default to 10] |
orderBy | DataSourceSorting | field to order by | |
desc | bool | descending sort | [default to false] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourceVM DataSourcesGetDataSource(ctx, id).Execute()
Get data source by id
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | data source id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesGetDataSource(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesGetDataSource``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesGetDataSource`: DataSourceVM
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesGetDataSource`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | data source id |
Other parameters are passed through a pointer to a apiDataSourcesGetDataSourceRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourceParameterTypesVM DataSourcesGetParameterTypes(ctx, dataSourceType).Execute()
Get data source parameter DataType's
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
dataSourceType := openapiclient.DataSourceConnectionType("JSON") // DataSourceConnectionType | data source type (MsSql, MySql, etc.)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesGetParameterTypes(context.Background(), dataSourceType).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesGetParameterTypes``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesGetParameterTypes`: DataSourceParameterTypesVM
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesGetParameterTypes`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dataSourceType | DataSourceConnectionType | data source type (MsSql, MySql, etc.) |
Other parameters are passed through a pointer to a apiDataSourcesGetParameterTypesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourcePermissionsVM DataSourcesGetPermissions(ctx, id).Execute()
Get all Data source permissions
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | data source id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesGetPermissions(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesGetPermissions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesGetPermissions`: DataSourcePermissionsVM
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesGetPermissions`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | data source id |
Other parameters are passed through a pointer to a apiDataSourcesGetPermissionsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourceVM DataSourcesRenameDataSource(ctx, id).RenameDataSourceVM(renameDataSourceVM).Execute()
Rename data source by id
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | data source id
renameDataSourceVM := *openapiclient.NewRenameDataSourceVM("Name_example", "T_example") // RenameDataSourceVM | rename viewmodel (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesRenameDataSource(context.Background(), id).RenameDataSourceVM(renameDataSourceVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesRenameDataSource``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesRenameDataSource`: DataSourceVM
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesRenameDataSource`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | data source id |
Other parameters are passed through a pointer to a apiDataSourcesRenameDataSourceRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
renameDataSourceVM | RenameDataSourceVM | rename viewmodel |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourceVM DataSourcesUpdateConnectionString(ctx, id).UpdateDataSourceConnectionStringVM(updateDataSourceConnectionStringVM).Execute()
Update data source's connection string by id
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | data source id
updateDataSourceConnectionStringVM := *openapiclient.NewUpdateDataSourceConnectionStringVM("ConnectionString_example", "T_example") // UpdateDataSourceConnectionStringVM | update viewmodel (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesUpdateConnectionString(context.Background(), id).UpdateDataSourceConnectionStringVM(updateDataSourceConnectionStringVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesUpdateConnectionString``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesUpdateConnectionString`: DataSourceVM
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesUpdateConnectionString`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | data source id |
Other parameters are passed through a pointer to a apiDataSourcesUpdateConnectionStringRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateDataSourceConnectionStringVM | UpdateDataSourceConnectionStringVM | update viewmodel |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourcesUpdatePermissions(ctx, id).UpdateDataSourcePermissionsVM(updateDataSourcePermissionsVM).Execute()
Update permissions
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
updateDataSourcePermissionsVM := *openapiclient.NewUpdateDataSourcePermissionsVM(*openapiclient.NewDataSourcePermissionsCRUDVM("T_example"), openapiclient.DataSourceAdministrate(0), "T_example") // UpdateDataSourcePermissionsVM | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.DataSourcesAPI.DataSourcesUpdatePermissions(context.Background(), id).UpdateDataSourcePermissionsVM(updateDataSourcePermissionsVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesUpdatePermissions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiDataSourcesUpdatePermissionsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateDataSourcePermissionsVM | UpdateDataSourcePermissionsVM | |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourceVM DataSourcesUpdateSelectCommands(ctx, id).UpdateDataSourceSelectCommandsVM(updateDataSourceSelectCommandsVM).Execute()
Update data source's select commands by id
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | data source id
updateDataSourceSelectCommandsVM := *openapiclient.NewUpdateDataSourceSelectCommandsVM([]openapiclient.DataSourceSelectCommandVM{*openapiclient.NewDataSourceSelectCommandVM("Name_example", "Command_example", "T_example")}, "T_example") // UpdateDataSourceSelectCommandsVM | update viewmodel (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DataSourcesAPI.DataSourcesUpdateSelectCommands(context.Background(), id).UpdateDataSourceSelectCommandsVM(updateDataSourceSelectCommandsVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesUpdateSelectCommands``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DataSourcesUpdateSelectCommands`: DataSourceVM
fmt.Fprintf(os.Stdout, "Response from `DataSourcesAPI.DataSourcesUpdateSelectCommands`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | data source id |
Other parameters are passed through a pointer to a apiDataSourcesUpdateSelectCommandsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateDataSourceSelectCommandsVM | UpdateDataSourceSelectCommandsVM | update viewmodel |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataSourcesUpdateSubscriptionDataSource(ctx, id).UpdateDataSourceSubscriptionVM(updateDataSourceSubscriptionVM).Execute()
Update data source's subscription
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | data source id
updateDataSourceSubscriptionVM := *openapiclient.NewUpdateDataSourceSubscriptionVM("SubscriptionId_example", "T_example") // UpdateDataSourceSubscriptionVM | update subscription viewmodel (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.DataSourcesAPI.DataSourcesUpdateSubscriptionDataSource(context.Background(), id).UpdateDataSourceSubscriptionVM(updateDataSourceSubscriptionVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DataSourcesAPI.DataSourcesUpdateSubscriptionDataSource``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | data source id |
Other parameters are passed through a pointer to a apiDataSourcesUpdateSubscriptionDataSourceRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateDataSourceSubscriptionVM | UpdateDataSourceSubscriptionVM | update subscription viewmodel |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]