cyperf.ReportsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
download_pdf	GET /api/v2/results/{resultId}/download-pdf/{pdfId}
get_result_download_csv_by_id	GET /api/v2/results/{resultId}/download-csv/{downloadCsvId}
poll_result_generate_csv	GET /api/v2/results/{resultId}/operations/generate-csv/{id}
poll_result_generate_pdf	GET /api/v2/results/{resultId}/operations/generate-pdf/{id}
start_result_generate_csv	POST /api/v2/results/{resultId}/operations/generate-csv
start_result_generate_pdf	POST /api/v2/results/{resultId}/operations/generate-pdf

download_pdf

bytearray download_pdf(result_id, pdf_id)

Download the generated PDF report for the current result.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.ReportsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    pdf_id = 56 # int | The ID of the download PDF operation.

    try:
        api_response = api_instance.download_pdf(result_id, pdf_id)
        print("The response of ReportsApi->download_pdf:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->download_pdf: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
pdf_id	int	The ID of the download PDF operation.

Return type

bytearray

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/json

HTTP response details

Status code	Description	Response headers
200	The content of the PDF report.	-
404	The requested PDF report was not found.	-

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

get_result_download_csv_by_id

get_result_download_csv_by_id(result_id, download_csv_id)

Download the generated CSV reports for the current result as a zip file.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.ReportsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    download_csv_id = 'download_csv_id_example' # str | The ID of the download csv.

    try:
        api_instance.get_result_download_csv_by_id(result_id, download_csv_id)
    except Exception as e:
        print("Exception when calling ReportsApi->get_result_download_csv_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
download_csv_id	str	The ID of the download csv.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The content of the zip file	-
404	The requested CSV reports were not found.	-
500	Unexpected error	-

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

poll_result_generate_csv

AsyncContext poll_result_generate_csv(result_id, id)

Get the state of an ongoing operation.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.ReportsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_result_generate_csv(result_id, id)
        print("The response of ReportsApi->poll_result_generate_csv:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->poll_result_generate_csv: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

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

poll_result_generate_pdf

AsyncContext poll_result_generate_pdf(result_id, id)

Get the state of an ongoing operation.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.ReportsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_result_generate_pdf(result_id, id)
        print("The response of ReportsApi->poll_result_generate_pdf:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->poll_result_generate_pdf: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

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

start_result_generate_csv

AsyncContext start_result_generate_csv(result_id, generate_csv_reports_operation=generate_csv_reports_operation)

Generate CSV reports for the current result.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.generate_csv_reports_operation import GenerateCSVReportsOperation
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.ReportsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    generate_csv_reports_operation = cyperf.GenerateCSVReportsOperation() # GenerateCSVReportsOperation |  (optional)

    try:
        api_response = api_instance.start_result_generate_csv(result_id, generate_csv_reports_operation=generate_csv_reports_operation)
        print("The response of ReportsApi->start_result_generate_csv:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->start_result_generate_csv: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
generate_csv_reports_operation	GenerateCSVReportsOperation		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_result_generate_pdf

AsyncContext start_result_generate_pdf(result_id, generate_pdf_report_operation=generate_pdf_report_operation)

Generate a PDF report for the current result.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.generate_pdf_report_operation import GeneratePDFReportOperation
from cyperf.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 = cyperf.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.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.ReportsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    generate_pdf_report_operation = cyperf.GeneratePDFReportOperation() # GeneratePDFReportOperation |  (optional)

    try:
        api_response = api_instance.start_result_generate_pdf(result_id, generate_pdf_report_operation=generate_pdf_report_operation)
        print("The response of ReportsApi->start_result_generate_pdf:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->start_result_generate_pdf: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
generate_pdf_report_operation	GeneratePDFReportOperation		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

FilesExpand file tree

ReportsApi.md

Latest commit

History

ReportsApi.md

File metadata and controls

cyperf.ReportsApi

download_pdf

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_result_download_csv_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

poll_result_generate_csv

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

poll_result_generate_pdf

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_result_generate_csv

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_result_generate_pdf

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details