DataSourcesApi

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

dataSourcesCountDataSourcesAsync

Long dataSourcesCountDataSourcesAsync(subscriptionId)

Returns a number of data sources in subscription

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | subscripiton id
    try {
      Long result = apiInstance.dataSourcesCountDataSourcesAsync(subscriptionId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesCountDataSourcesAsync");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
subscriptionId	String	subscripiton id

Return type

Long

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	id is not hex24	-
402	Subscription is outdated	-
403	You don't have permisison to get data sources from this subscription (or in your default (1st) subscription)	-
404	there is no subscription with provided id found, or user don't even have a subscription	-

dataSourcesCreateDataSource

DataSourceVM dataSourcesCreateDataSource(createDataSourceVM)

Create new data source

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    CreateDataSourceVM createDataSourceVM = new CreateDataSourceVM(); // CreateDataSourceVM | create viewmodel
    try {
      DataSourceVM result = apiInstance.dataSourcesCreateDataSource(createDataSourceVM);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesCreateDataSource");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
createDataSourceVM	CreateDataSourceVM	create viewmodel	[optional]

Return type

DataSourceVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	VM is not valid	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to create data sources from this subscription (or in your default (1st) subscription)	-
404	There is no subscription with provided id found, or user don't even have a subscription	-
500	Try again, if error still here - text our support	-

dataSourcesDeleteDataSource

dataSourcesDeleteDataSource(id)

Delete data source by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | data source id
    try {
      apiInstance.dataSourcesDeleteDataSource(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesDeleteDataSource");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	data source id

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Everything is all right	-
400	id is not hex24	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to delete data sources from this subscription (or in your default (1st) subscription)	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

dataSourcesFetchData

dataSourcesFetchData(id)

This should connect to a database and set data structure

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | datasource's id
    try {
      apiInstance.dataSourcesFetchData(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesFetchData");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	datasource's id

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Everything is all right	-
400	id is not hex24	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to fetch data sources from this subscription (or in your default (1st) subscription)	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

dataSourcesGetAvailableDataSources

DataSourcesVM dataSourcesGetAvailableDataSources(subscriptionId, skip, take, orderBy, desc)

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.

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | id of subscription where the datasources are located
    Integer skip = 0; // Integer | how many data sources will be skipped
    Integer take = 10; // Integer | how many data sources will be taken
    DataSourceSorting orderBy = DataSourceSorting.fromValue("CreatedTime"); // DataSourceSorting | field to order by
    Boolean desc = false; // Boolean | descending sort
    try {
      DataSourcesVM result = apiInstance.dataSourcesGetAvailableDataSources(subscriptionId, skip, take, orderBy, desc);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesGetAvailableDataSources");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
subscriptionId	String	id of subscription where the datasources are located	[optional]
skip	Integer	how many data sources will be skipped	[optional] [default to 0]
take	Integer	how many data sources will be taken	[optional] [default to 10]
orderBy	DataSourceSorting	field to order by	[optional] [enum: CreatedTime, EditedTime, Name]
desc	Boolean	descending sort	[optional] [default to false]

Return type

DataSourcesVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	One of params is not valid	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to get data sources from this subscription (or in your default (1st) subscription)	-
404	There is no subscription with provided id found	-

dataSourcesGetDataSource

DataSourceVM dataSourcesGetDataSource(id)

Get data source by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | data source id
    try {
      DataSourceVM result = apiInstance.dataSourcesGetDataSource(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesGetDataSource");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	data source id

Return type

DataSourceVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	id is not hex24	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to get data sources from this subscription (or in your default (1st) subscription)	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

dataSourcesGetParameterTypes

DataSourceParameterTypesVM dataSourcesGetParameterTypes(dataSourceType)

Get data source parameter DataType's

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    DataSourceConnectionType dataSourceType = DataSourceConnectionType.fromValue("JSON"); // DataSourceConnectionType | data source type (MsSql, MySql, etc.)
    try {
      DataSourceParameterTypesVM result = apiInstance.dataSourcesGetParameterTypes(dataSourceType);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesGetParameterTypes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
dataSourceType	DataSourceConnectionType	data source type (MsSql, MySql, etc.)	[enum: JSON, MSSQL, CSV, XML, MySQL, Postgres, OracleDB, FirebirdDB, MongoDB, ClickHouse]

Return type

DataSourceParameterTypesVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	Data source doesn't support parameters or wrong data source name	-
500	Try again, if error still here - text our support	-

dataSourcesGetPermissions

DataSourcePermissionsVM dataSourcesGetPermissions(id)

Get all Data source permissions

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | data source id
    try {
      DataSourcePermissionsVM result = apiInstance.dataSourcesGetPermissions(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesGetPermissions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	data source id

Return type

DataSourcePermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	id is not hex24	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to get data sources' permissions from this subscription (or in your default (1st) subscription)	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

dataSourcesRenameDataSource

DataSourceVM dataSourcesRenameDataSource(id, renameDataSourceVM)

Rename data source by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | data source id
    RenameDataSourceVM renameDataSourceVM = new RenameDataSourceVM(); // RenameDataSourceVM | rename viewmodel
    try {
      DataSourceVM result = apiInstance.dataSourcesRenameDataSource(id, renameDataSourceVM);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesRenameDataSource");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	data source id
renameDataSourceVM	RenameDataSourceVM	rename viewmodel	[optional]

Return type

DataSourceVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	id is not hex24 or VM is not valid	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to update data sources' name from this subscription (or in your default (1st) subscription)	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

dataSourcesUpdateConnectionString

DataSourceVM dataSourcesUpdateConnectionString(id, updateDataSourceConnectionStringVM)

Update data source's connection string by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | data source id
    UpdateDataSourceConnectionStringVM updateDataSourceConnectionStringVM = new UpdateDataSourceConnectionStringVM(); // UpdateDataSourceConnectionStringVM | update viewmodel
    try {
      DataSourceVM result = apiInstance.dataSourcesUpdateConnectionString(id, updateDataSourceConnectionStringVM);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesUpdateConnectionString");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	data source id
updateDataSourceConnectionStringVM	UpdateDataSourceConnectionStringVM	update viewmodel	[optional]

Return type

DataSourceVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	id is not hex24 or VM is not valid	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to update data sources' connection string from this subscription (or in your default (1st) subscription)	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

dataSourcesUpdatePermissions

dataSourcesUpdatePermissions(id, updateDataSourcePermissionsVM)

Update permissions

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | 
    UpdateDataSourcePermissionsVM updateDataSourcePermissionsVM = new UpdateDataSourcePermissionsVM(); // UpdateDataSourcePermissionsVM | 
    try {
      apiInstance.dataSourcesUpdatePermissions(id, updateDataSourcePermissionsVM);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesUpdatePermissions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String
updateDataSourcePermissionsVM	UpdateDataSourcePermissionsVM		[optional]

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Everything is all right	-
400	id is not hex24 or VM is not valid	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to update data sources' permissions from this subscription (or in your default (1st) subscription)	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

dataSourcesUpdateSelectCommands

DataSourceVM dataSourcesUpdateSelectCommands(id, updateDataSourceSelectCommandsVM)

Update data source's select commands by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | data source id
    UpdateDataSourceSelectCommandsVM updateDataSourceSelectCommandsVM = new UpdateDataSourceSelectCommandsVM(); // UpdateDataSourceSelectCommandsVM | update viewmodel
    try {
      DataSourceVM result = apiInstance.dataSourcesUpdateSelectCommands(id, updateDataSourceSelectCommandsVM);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesUpdateSelectCommands");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	data source id
updateDataSourceSelectCommandsVM	UpdateDataSourceSelectCommandsVM	update viewmodel	[optional]

Return type

DataSourceVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	id is not hex24 or VM is not valid	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to update data sources' connection string from this subscription (or in your default (1st) subscription)	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

dataSourcesUpdateSubscriptionDataSource

dataSourcesUpdateSubscriptionDataSource(id, updateDataSourceSubscriptionVM)

Update data source's subscription

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DataSourcesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    DataSourcesApi apiInstance = new DataSourcesApi(defaultClient);
    String id = "id_example"; // String | data source id
    UpdateDataSourceSubscriptionVM updateDataSourceSubscriptionVM = new UpdateDataSourceSubscriptionVM(); // UpdateDataSourceSubscriptionVM | update subscription viewmodel
    try {
      apiInstance.dataSourcesUpdateSubscriptionDataSource(id, updateDataSourceSubscriptionVM);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataSourcesApi#dataSourcesUpdateSubscriptionDataSource");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	data source id
updateDataSourceSubscriptionVM	UpdateDataSourceSubscriptionVM	update subscription viewmodel	[optional]

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	id is not hex24 or VM is not valid	-
402	Subscription is outdated or have not enough limits	-
403	You don't have permisison to get data sources or create them in new subscription	-
404	There is no data source or subscription with provided id found	-
500	Try again, if error still here - text our support	-

Files

DataSourcesApi.md

Latest commit

History

DataSourcesApi.md

File metadata and controls

DataSourcesApi

dataSourcesCountDataSourcesAsync

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesCreateDataSource

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesDeleteDataSource

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesFetchData

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesGetAvailableDataSources

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesGetDataSource

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesGetParameterTypes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesGetPermissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesRenameDataSource

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesUpdateConnectionString

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dataSourcesUpdatePermissions

Example

Parameters