SubscriptionsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
subscriptionsGetDefaultPermissions	GET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions	Get subscription's default permissions for new entities
subscriptionsGetMyPermissions	GET /api/manage/v1/Subscriptions/{subId}/mypermissions	Get user's permissions for a subscription by id
subscriptionsGetPermissions	GET /api/manage/v1/Subscriptions/{id}/permissions	Get permissions for a subscription by id
subscriptionsGetSubscription	GET /api/manage/v1/Subscriptions/{id}	Returns the subscription by id
subscriptionsGetSubscriptions	GET /api/manage/v1/Subscriptions	Returns a list of all subscriptions of current user
subscriptionsRenameSubscription	PUT /api/manage/v1/Subscriptions/{subscriptionId}/rename	Rename subscription
subscriptionsUpdateDefaultPermissions	PUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions	Change subscription's default permissions for new entities
subscriptionsUpdateLocale	PUT /api/manage/v1/Subscriptions/{subscriptionId}/Locale	Update subscription's default locale
subscriptionsUpdatePermissions	POST /api/manage/v1/Subscriptions/{id}/permissions	Update permissions

subscriptionsGetDefaultPermissions

DefaultPermissionsVM subscriptionsGetDefaultPermissions(subscriptionId)

Get subscription's default permissions for new entities

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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | id
    try {
      DefaultPermissionsVM result = apiInstance.subscriptionsGetDefaultPermissions(subscriptionId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsGetDefaultPermissions");
      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

Return type

DefaultPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned	-
400	Request is wrong	-
402	Subscription is outdated	-
403	Not enough permissions	-
404	There is no subscription with such id	-

subscriptionsGetMyPermissions

MyPermissionsVM subscriptionsGetMyPermissions(subId)

Get user's permissions for a subscription 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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    String subId = "subId_example"; // String | subscription id
    try {
      MyPermissionsVM result = apiInstance.subscriptionsGetMyPermissions(subId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsGetMyPermissions");
      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
subId	String	subscription id

Return type

MyPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Succesfully returned	-

subscriptionsGetPermissions

SubscriptionPermissionsVM subscriptionsGetPermissions(id)

Get permissions for a subscription 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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      SubscriptionPermissionsVM result = apiInstance.subscriptionsGetPermissions(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsGetPermissions");
      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

Return type

SubscriptionPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Succesfully returned	-
400	Request is wrong	-
402	Subscription is outdated	-
403	Not enough permissions	-
404	There is no subscription with such id	-
500	Try again, if error still here - text our support	-

subscriptionsGetSubscription

SubscriptionVM subscriptionsGetSubscription(id)

Returns the subscription 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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    String id = "id_example"; // String | Identifier of subscription
    try {
      SubscriptionVM result = apiInstance.subscriptionsGetSubscription(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsGetSubscription");
      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	Identifier of subscription

Return type

SubscriptionVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Succesfully returned	-
400	The reqeust is wrong	-
403	You don't have rights for the operation	-
404	Subscription is not found	-
500	Try again, if error still here - text our support	-

subscriptionsGetSubscriptions

SubscriptionsVM subscriptionsGetSubscriptions(skip, take)

Returns a list of all subscriptions of current user

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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    Integer skip = 0; // Integer | Variable for pagination, defautl value is 0
    Integer take = 10; // Integer | Variable for pagination, default value is 10
    try {
      SubscriptionsVM result = apiInstance.subscriptionsGetSubscriptions(skip, take);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsGetSubscriptions");
      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
skip	Integer	Variable for pagination, defautl value is 0	[optional] [default to 0]
take	Integer	Variable for pagination, default value is 10	[optional] [default to 10]

Return type

SubscriptionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Succesfully returned	-
400	unrealistic skip 'n take provided	-

subscriptionsRenameSubscription

SubscriptionVM subscriptionsRenameSubscription(subscriptionId, renameSubscriptionVM)

Rename 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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | id
    RenameSubscriptionVM renameSubscriptionVM = new RenameSubscriptionVM(); // RenameSubscriptionVM | rename VM
    try {
      SubscriptionVM result = apiInstance.subscriptionsRenameSubscription(subscriptionId, renameSubscriptionVM);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsRenameSubscription");
      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
renameSubscriptionVM	RenameSubscriptionVM	rename VM

Return type

SubscriptionVM

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	Successfully renamed	-
400	Request is wrong	-
402	Subscription is outdated	-
403	Not enough permissions	-
404	There is no subscription with such id (or user have no permission)	-

subscriptionsUpdateDefaultPermissions

DefaultPermissionsVM subscriptionsUpdateDefaultPermissions(subscriptionId, updateDefaultPermissionsVM)

Change subscription's default permissions for new entities

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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | id
    UpdateDefaultPermissionsVM updateDefaultPermissionsVM = new UpdateDefaultPermissionsVM(); // UpdateDefaultPermissionsVM | update default permissions VM
    try {
      DefaultPermissionsVM result = apiInstance.subscriptionsUpdateDefaultPermissions(subscriptionId, updateDefaultPermissionsVM);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsUpdateDefaultPermissions");
      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
updateDefaultPermissionsVM	UpdateDefaultPermissionsVM	update default permissions VM

Return type

DefaultPermissionsVM

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	Successfully changed	-
400	Request is wrong	-
402	Subscription is outdated	-
403	Not enough permissions	-
404	There is no subscription with such id	-

subscriptionsUpdateLocale

SubscriptionVM subscriptionsUpdateLocale(subscriptionId, updateSubscriptionLocaleVM)

Update subscription's default locale

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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | id
    UpdateSubscriptionLocaleVM updateSubscriptionLocaleVM = new UpdateSubscriptionLocaleVM(); // UpdateSubscriptionLocaleVM | update VM
    try {
      SubscriptionVM result = apiInstance.subscriptionsUpdateLocale(subscriptionId, updateSubscriptionLocaleVM);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsUpdateLocale");
      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
updateSubscriptionLocaleVM	UpdateSubscriptionLocaleVM	update VM

Return type

SubscriptionVM

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	Successfully renamed	-
400	Request is wrong	-
402	Subscription is outdated	-
403	Not enough permissions	-
404	There is no subscription with such id (or user have no permission)	-

subscriptionsUpdatePermissions

subscriptionsUpdatePermissions(id, updateSubscriptionPermissionsVM)

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.SubscriptionsApi;

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");

    SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
    String id = "id_example"; // String | 
    UpdateSubscriptionPermissionsVM updateSubscriptionPermissionsVM = new UpdateSubscriptionPermissionsVM(); // UpdateSubscriptionPermissionsVM | 
    try {
      apiInstance.subscriptionsUpdatePermissions(id, updateSubscriptionPermissionsVM);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionsApi#subscriptionsUpdatePermissions");
      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
updateSubscriptionPermissionsVM	UpdateSubscriptionPermissionsVM		[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	Succesfully updated	-
400	Request is wrong	-
402	Subscription is outdated	-
403	Not enough permissions	-
404	There is no subscription with such id	-
500	Try again, if error still here - text our support	-

Files

SubscriptionsApi.md

Latest commit

History

SubscriptionsApi.md

File metadata and controls

SubscriptionsApi

subscriptionsGetDefaultPermissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

subscriptionsGetMyPermissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

subscriptionsGetPermissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

subscriptionsGetSubscription

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

subscriptionsGetSubscriptions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

subscriptionsRenameSubscription

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

subscriptionsUpdateDefaultPermissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

subscriptionsUpdateLocale

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

subscriptionsUpdatePermissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details