fastreport_cloud_sdk.GroupsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
groups_create_group	POST /api/manage/v1/Groups	Create a new user group
groups_delete_group	DELETE /api/manage/v1/Groups/{id}	Delete group by identifier
groups_get_group	GET /api/manage/v1/Groups/{id}	Gets group by identifier
groups_get_group_list	GET /api/manage/v1/Groups	Returns a list of current user's groups<br /> This method will return following data about groups : <br /> Id, Name, Created time (UTC), Edited time (UTC), creator id, <br /> editor id, subscription id
groups_get_my_permissions	GET /api/manage/v1/Groups/{id}/mypermissions	Get current user's permissions to group
groups_get_permissions	GET /api/manage/v1/Groups/{id}/permissions	Gets group permissions by identifier
groups_rename_group	PUT /api/manage/v1/Groups/{id}/rename	Rename group by identifier
groups_update_permissions	POST /api/manage/v1/Groups/{id}/permissions	Update permissions

groups_create_group

GroupVM groups_create_group(create_group_vm=create_group_vm)

Create a new user group

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.create_group_vm import CreateGroupVM
from fastreport_cloud_sdk.models.group_vm import GroupVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.GroupsApi(api_client)
    create_group_vm = fastreport_cloud_sdk.CreateGroupVM() # CreateGroupVM | Model for creating (optional)

    try:
        # Create a new user group
        api_response = api_instance.groups_create_group(create_group_vm=create_group_vm)
        print("The response of GroupsApi->groups_create_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->groups_create_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_group_vm	CreateGroupVM	Model for creating	[optional]

Return type

GroupVM

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	Succesfully created	-
400	The request is wrong	-
402	subscription is outdated	-
403	You don't have permissions for the operation	-
404	Information from view model is not found	-

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

groups_delete_group

groups_delete_group(id)

Delete group by identifier

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.GroupsApi(api_client)
    id = 'id_example' # str | Identifier of group

    try:
        # Delete group by identifier
        api_instance.groups_delete_group(id)
    except Exception as e:
        print("Exception when calling GroupsApi->groups_delete_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of group

Return type

void (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	Succesfully delete	-
400	The request is wrong	-
402	Subscripiton is outdated	-
403	You don't have permissions for the operation	-
404	Group with this identifier or subscription is not found	-

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

groups_get_group

GroupVM groups_get_group(id)

Gets group by identifier

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.group_vm import GroupVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.GroupsApi(api_client)
    id = 'id_example' # str | Identifier of group

    try:
        # Gets group by identifier
        api_response = api_instance.groups_get_group(id)
        print("The response of GroupsApi->groups_get_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->groups_get_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of group

Return type

GroupVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Succesfully retured	-
400	The request is wrong	-
403	You don't have permissions for the operation	-
404	Group with this identifier or subscription is not found	-

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

groups_get_group_list

GroupsVM groups_get_group_list(skip=skip, take=take)

Returns a list of current user's groups
This method will return following data about groups :
Id, Name, Created time (UTC), Edited time (UTC), creator id,
editor id, subscription id

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.groups_vm import GroupsVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.GroupsApi(api_client)
    skip = 0 # int | How many groups need to skip (optional) (default to 0)
    take = 10 # int | How many groups need to take (optional) (default to 10)

    try:
        # Returns a list of current user's groups<br />  This method will return following data about groups : <br />  Id, Name, Created time (UTC), Edited time (UTC), creator id, <br />  editor id, subscription id
        api_response = api_instance.groups_get_group_list(skip=skip, take=take)
        print("The response of GroupsApi->groups_get_group_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->groups_get_group_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
skip	int	How many groups need to skip	[optional] [default to 0]
take	int	How many groups need to take	[optional] [default to 10]

Return type

GroupsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Succesfully retured	-
400	The request is wrong	-
401	User is unauthorized	-

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

groups_get_my_permissions

GroupPermissionCRUDVM groups_get_my_permissions(id)

Get current user's permissions to group

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.group_permission_crudvm import GroupPermissionCRUDVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.GroupsApi(api_client)
    id = 'id_example' # str | Identifier of group

    try:
        # Get current user's permissions to group
        api_response = api_instance.groups_get_my_permissions(id)
        print("The response of GroupsApi->groups_get_my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->groups_get_my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of group

Return type

GroupPermissionCRUDVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Succesfully retured	-
400	The request is wrong	-
404	Group with this identifier or subscription is not found	-
500	Server Error	-

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

groups_get_permissions

GroupPermissionsVM groups_get_permissions(id)

Gets group permissions by identifier

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.group_permissions_vm import GroupPermissionsVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.GroupsApi(api_client)
    id = 'id_example' # str | Identifier of group

    try:
        # Gets group permissions by identifier
        api_response = api_instance.groups_get_permissions(id)
        print("The response of GroupsApi->groups_get_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->groups_get_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of group

Return type

GroupPermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Succesfully retured	-
400	The request is wrong	-
403	You don't have permissions for the operation	-
404	Group with this identifier or subscription is not found	-

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

groups_rename_group

GroupVM groups_rename_group(id, rename_group_vm)

Rename group by identifier

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.group_vm import GroupVM
from fastreport_cloud_sdk.models.rename_group_vm import RenameGroupVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.GroupsApi(api_client)
    id = 'id_example' # str | Identifier of group
    rename_group_vm = fastreport_cloud_sdk.RenameGroupVM() # RenameGroupVM | Model for renaming

    try:
        # Rename group by identifier
        api_response = api_instance.groups_rename_group(id, rename_group_vm)
        print("The response of GroupsApi->groups_rename_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupsApi->groups_rename_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of group
rename_group_vm	RenameGroupVM	Model for renaming

Return type

GroupVM

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	Succesfully renamed	-
400	The request is wrong	-
402	subscription is outdated	-
403	You don't have permissions for the operation	-
404	Group with this identifier or subscription is not found	-

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

groups_update_permissions

groups_update_permissions(id, update_group_permissions_vm=update_group_permissions_vm)

Update permissions

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.update_group_permissions_vm import UpdateGroupPermissionsVM
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.GroupsApi(api_client)
    id = 'id_example' # str | 
    update_group_permissions_vm = fastreport_cloud_sdk.UpdateGroupPermissionsVM() # UpdateGroupPermissionsVM |  (optional)

    try:
        # Update permissions
        api_instance.groups_update_permissions(id, update_group_permissions_vm=update_group_permissions_vm)
    except Exception as e:
        print("Exception when calling GroupsApi->groups_update_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
update_group_permissions_vm	UpdateGroupPermissionsVM		[optional]

Return type

void (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	Permissions are updated	-
400	id or VM is not valid	-
402	Subscription is outdated	-
403	You have no permissions to work with groups	-
404	Group or subscription is not found	-

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

FilesExpand file tree

GroupsApi.md

Latest commit

History

GroupsApi.md

File metadata and controls

fastreport_cloud_sdk.GroupsApi

groups_create_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

groups_delete_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

groups_get_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

groups_get_group_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

groups_get_my_permissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

groups_get_permissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

groups_rename_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

groups_update_permissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details