All URIs are relative to http://localhost, except if the operation defines another base path.
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 |
dataSourcesCountDataSourcesAsync($subscription_id): int
Returns a number of data sources in subscription
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$subscription_id = 'subscription_id_example'; // string | subscripiton id
try {
$result = $apiInstance->dataSourcesCountDataSourcesAsync($subscription_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesCountDataSourcesAsync: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
subscription_id | string | subscripiton id |
int
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dataSourcesCreateDataSource($create_data_source_vm): \OpenAPI\Client\cloud\fastreport\model\DataSourceVM
Create new data source
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$create_data_source_vm = new \OpenAPI\Client\cloud\fastreport\model\CreateDataSourceVM(); // \OpenAPI\Client\cloud\fastreport\model\CreateDataSourceVM | create viewmodel
try {
$result = $apiInstance->dataSourcesCreateDataSource($create_data_source_vm);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesCreateDataSource: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
create_data_source_vm | \OpenAPI\Client\cloud\fastreport\model\CreateDataSourceVM | create viewmodel | [optional] |
\OpenAPI\Client\cloud\fastreport\model\DataSourceVM
- 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($id)
Delete data source by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | data source id
try {
$apiInstance->dataSourcesDeleteDataSource($id);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesDeleteDataSource: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | data source id |
void (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($id)
This should connect to a database and set data structure
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | datasource's id
try {
$apiInstance->dataSourcesFetchData($id);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesFetchData: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | datasource's id |
void (empty response body)
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dataSourcesGetAvailableDataSources($subscription_id, $skip, $take, $order_by, $desc): \OpenAPI\Client\cloud\fastreport\model\DataSourcesVM
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.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$subscription_id = 'subscription_id_example'; // string | id of subscription where the datasources are located
$skip = 0; // int | how many data sources will be skipped
$take = 10; // int | how many data sources will be taken
$order_by = new \OpenAPI\Client\cloud\fastreport\model\DataSourceSorting(); // DataSourceSorting | field to order by
$desc = false; // bool | descending sort
try {
$result = $apiInstance->dataSourcesGetAvailableDataSources($subscription_id, $skip, $take, $order_by, $desc);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesGetAvailableDataSources: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
subscription_id | string | id of subscription where the datasources are located | [optional] |
skip | int | how many data sources will be skipped | [optional] [default to 0] |
take | int | how many data sources will be taken | [optional] [default to 10] |
order_by | DataSourceSorting | field to order by | [optional] |
desc | bool | descending sort | [optional] [default to false] |
\OpenAPI\Client\cloud\fastreport\model\DataSourcesVM
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dataSourcesGetDataSource($id): \OpenAPI\Client\cloud\fastreport\model\DataSourceVM
Get data source by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | data source id
try {
$result = $apiInstance->dataSourcesGetDataSource($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesGetDataSource: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | data source id |
\OpenAPI\Client\cloud\fastreport\model\DataSourceVM
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dataSourcesGetParameterTypes($data_source_type): \OpenAPI\Client\cloud\fastreport\model\DataSourceParameterTypesVM
Get data source parameter DataType's
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$data_source_type = new \OpenAPI\Client\cloud\fastreport\model\DataSourceConnectionType(); // DataSourceConnectionType | data source type (MsSql, MySql, etc.)
try {
$result = $apiInstance->dataSourcesGetParameterTypes($data_source_type);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesGetParameterTypes: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
data_source_type | DataSourceConnectionType | data source type (MsSql, MySql, etc.) |
\OpenAPI\Client\cloud\fastreport\model\DataSourceParameterTypesVM
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dataSourcesGetPermissions($id): \OpenAPI\Client\cloud\fastreport\model\DataSourcePermissionsVM
Get all Data source permissions
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | data source id
try {
$result = $apiInstance->dataSourcesGetPermissions($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesGetPermissions: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | data source id |
\OpenAPI\Client\cloud\fastreport\model\DataSourcePermissionsVM
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dataSourcesRenameDataSource($id, $rename_data_source_vm): \OpenAPI\Client\cloud\fastreport\model\DataSourceVM
Rename data source by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | data source id
$rename_data_source_vm = new \OpenAPI\Client\cloud\fastreport\model\RenameDataSourceVM(); // \OpenAPI\Client\cloud\fastreport\model\RenameDataSourceVM | rename viewmodel
try {
$result = $apiInstance->dataSourcesRenameDataSource($id, $rename_data_source_vm);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesRenameDataSource: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | data source id | |
rename_data_source_vm | \OpenAPI\Client\cloud\fastreport\model\RenameDataSourceVM | rename viewmodel | [optional] |
\OpenAPI\Client\cloud\fastreport\model\DataSourceVM
- 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]
dataSourcesUpdateConnectionString($id, $update_data_source_connection_string_vm): \OpenAPI\Client\cloud\fastreport\model\DataSourceVM
Update data source's connection string by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | data source id
$update_data_source_connection_string_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceConnectionStringVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceConnectionStringVM | update viewmodel
try {
$result = $apiInstance->dataSourcesUpdateConnectionString($id, $update_data_source_connection_string_vm);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesUpdateConnectionString: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | data source id | |
update_data_source_connection_string_vm | \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceConnectionStringVM | update viewmodel | [optional] |
\OpenAPI\Client\cloud\fastreport\model\DataSourceVM
- 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($id, $update_data_source_permissions_vm)
Update permissions
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string |
$update_data_source_permissions_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourcePermissionsVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourcePermissionsVM |
try {
$apiInstance->dataSourcesUpdatePermissions($id, $update_data_source_permissions_vm);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesUpdatePermissions: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | ||
update_data_source_permissions_vm | \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourcePermissionsVM | [optional] |
void (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]
dataSourcesUpdateSelectCommands($id, $update_data_source_select_commands_vm): \OpenAPI\Client\cloud\fastreport\model\DataSourceVM
Update data source's select commands by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | data source id
$update_data_source_select_commands_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceSelectCommandsVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceSelectCommandsVM | update viewmodel
try {
$result = $apiInstance->dataSourcesUpdateSelectCommands($id, $update_data_source_select_commands_vm);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesUpdateSelectCommands: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | data source id | |
update_data_source_select_commands_vm | \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceSelectCommandsVM | update viewmodel | [optional] |
\OpenAPI\Client\cloud\fastreport\model\DataSourceVM
- 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($id, $update_data_source_subscription_vm)
Update data source's subscription
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataSourcesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | data source id
$update_data_source_subscription_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceSubscriptionVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceSubscriptionVM | update subscription viewmodel
try {
$apiInstance->dataSourcesUpdateSubscriptionDataSource($id, $update_data_source_subscription_vm);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesApi->dataSourcesUpdateSubscriptionDataSource: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | data source id | |
update_data_source_subscription_vm | \OpenAPI\Client\cloud\fastreport\model\UpdateDataSourceSubscriptionVM | update subscription viewmodel | [optional] |
void (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]