kloudio.ReportsApi

All URIs are relative to http://localhost:8089

Method	HTTP request	Description
create_report	POST /v1/reports	Create a report
delete_report	DELETE /v1/reports/{report_id}	Delete a report
execute_report	POST /v1/reports/{report_id}/execute	Execute a report
get_report	GET /v1/reports/{report_id}	Get a report
get_reports	GET /v1/reports	Get all report
share_report	POST /v1/reports/share/{report_id}	Share a report
update_report	PUT /v1/reports/{report_id}	Update a report

create_report

ReportsResponse create_report(new_report)

Create a report

Use this method to create a new report. On successful creation, it returns the report object

Example

Api Key Authentication (bearer):

from __future__ import print_function
import time
import kloudio
from kloudio.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8089
# See configuration.py for a list of all supported configuration parameters.
configuration = kloudio.Configuration(
    host = "http://localhost:8089"
)

# 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 API key authorization: bearer
configuration = kloudio.Configuration(
    host = "http://localhost:8089",
    api_key = {
        'bearer': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with kloudio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kloudio.ReportsApi(api_client)
    new_report = kloudio.NewReport() # NewReport | To create a new report, send the following properties

    try:
        # Create a report
        api_response = api_instance.create_report(new_report)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ReportsApi->create_report: %s\n" % e)

Parameters

Name	Type	Description	Notes
new_report	NewReport	To create a new report, send the following properties

Return type

ReportsResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	-
400	Bad request, check message for more information on the error	-
401	Unauthorized, check your API key	-
403	Forbidden, possible CORS error	-

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

delete_report

ReportDelResponse delete_report(report_id)

Delete a report

Use this method to delete a report.

Example

Api Key Authentication (bearer):

from __future__ import print_function
import time
import kloudio
from kloudio.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8089
# See configuration.py for a list of all supported configuration parameters.
configuration = kloudio.Configuration(
    host = "http://localhost:8089"
)

# 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 API key authorization: bearer
configuration = kloudio.Configuration(
    host = "http://localhost:8089",
    api_key = {
        'bearer': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with kloudio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kloudio.ReportsApi(api_client)
    report_id = 'report_id_example' # str | 

    try:
        # Delete a report
        api_response = api_instance.delete_report(report_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ReportsApi->delete_report: %s\n" % e)

Parameters

Name	Type	Description	Notes
report_id	str

Return type

ReportDelResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad request, check message for more information on the error	-
401	Unauthorized, check your API key	-
403	Forbidden, possible CORS error	-

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

execute_report

object execute_report(report_id, run_report)

Execute a report

Use this method to execute a report.

Example

Api Key Authentication (bearer):

from __future__ import print_function
import time
import kloudio
from kloudio.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8089
# See configuration.py for a list of all supported configuration parameters.
configuration = kloudio.Configuration(
    host = "http://localhost:8089"
)

# 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 API key authorization: bearer
configuration = kloudio.Configuration(
    host = "http://localhost:8089",
    api_key = {
        'bearer': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with kloudio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kloudio.ReportsApi(api_client)
    report_id = 'report_id_example' # str | 
run_report = kloudio.RunReport() # RunReport | 

    try:
        # Execute a report
        api_response = api_instance.execute_report(report_id, run_report)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ReportsApi->execute_report: %s\n" % e)

Parameters

Name	Type	Description	Notes
report_id	str
run_report	RunReport

Return type

object

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	-
400	Bad request, check message for more information on the error	-
401	Unauthorized, check your API key	-
403	Forbidden, possible CORS error	-

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

get_report

ReportsResponse get_report(report_id)

Get a report

Use this method to get a report. On successful fetch, it returns the report object

Example

Api Key Authentication (bearer):

from __future__ import print_function
import time
import kloudio
from kloudio.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8089
# See configuration.py for a list of all supported configuration parameters.
configuration = kloudio.Configuration(
    host = "http://localhost:8089"
)

# 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 API key authorization: bearer
configuration = kloudio.Configuration(
    host = "http://localhost:8089",
    api_key = {
        'bearer': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with kloudio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kloudio.ReportsApi(api_client)
    report_id = 'report_id_example' # str | 

    try:
        # Get a report
        api_response = api_instance.get_report(report_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ReportsApi->get_report: %s\n" % e)

Parameters

Name	Type	Description	Notes
report_id	str

Return type

ReportsResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad request, check message for more information on the error	-
401	Unauthorized, check your API key	-
403	Forbidden, possible CORS error	-

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

get_reports

list[ReportsResponse] get_reports()

Get all report

Use this method to get all report. On successful fetch, it returns the report object

Example

Api Key Authentication (bearer):

from __future__ import print_function
import time
import kloudio
from kloudio.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8089
# See configuration.py for a list of all supported configuration parameters.
configuration = kloudio.Configuration(
    host = "http://localhost:8089"
)

# 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 API key authorization: bearer
configuration = kloudio.Configuration(
    host = "http://localhost:8089",
    api_key = {
        'bearer': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with kloudio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kloudio.ReportsApi(api_client)
    
    try:
        # Get all report
        api_response = api_instance.get_reports()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ReportsApi->get_reports: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[ReportsResponse]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized, check your API key	-
403	Forbidden, possible CORS error	-

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

share_report

ReportShareResponse share_report(report_id, share_report)

Share a report

Use this method to share a report.

Example

Api Key Authentication (bearer):

from __future__ import print_function
import time
import kloudio
from kloudio.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8089
# See configuration.py for a list of all supported configuration parameters.
configuration = kloudio.Configuration(
    host = "http://localhost:8089"
)

# 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 API key authorization: bearer
configuration = kloudio.Configuration(
    host = "http://localhost:8089",
    api_key = {
        'bearer': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with kloudio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kloudio.ReportsApi(api_client)
    report_id = 'report_id_example' # str | 
share_report = [kloudio.ShareReport()] # list[ShareReport] | 

    try:
        # Share a report
        api_response = api_instance.share_report(report_id, share_report)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ReportsApi->share_report: %s\n" % e)

Parameters

Name	Type	Description	Notes
report_id	str
share_report	list[ShareReport]

Return type

ReportShareResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad request, check message for more information on the error	-
401	Unauthorized, check your API key	-
403	Forbidden, possible CORS error	-

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

update_report

ReportsResponse update_report(report_id, new_report)

Update a report

Use this method to update an existing report. On successful creation, it returns the updated report object

Example

Api Key Authentication (bearer):

from __future__ import print_function
import time
import kloudio
from kloudio.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8089
# See configuration.py for a list of all supported configuration parameters.
configuration = kloudio.Configuration(
    host = "http://localhost:8089"
)

# 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 API key authorization: bearer
configuration = kloudio.Configuration(
    host = "http://localhost:8089",
    api_key = {
        'bearer': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with kloudio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kloudio.ReportsApi(api_client)
    report_id = 'report_id_example' # str | 
new_report = kloudio.NewReport() # NewReport | To update an existing report, send the following properties

    try:
        # Update a report
        api_response = api_instance.update_report(report_id, new_report)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ReportsApi->update_report: %s\n" % e)

Parameters

Name	Type	Description	Notes
report_id	str
new_report	NewReport	To update an existing report, send the following properties

Return type

ReportsResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	-
400	Bad request, check message for more information on the error	-
401	Unauthorized, check your API key	-
403	Forbidden, possible CORS error	-

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

Uh oh!

FilesExpand file tree

ReportsApi.md

Latest commit

History

ReportsApi.md

File metadata and controls

kloudio.ReportsApi

create_report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

execute_report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_reports

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

share_report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details