ModuleReportApi.md

eZmaxApi.Api.ModuleReportApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
ReportGetReportFromCacheV1	GET /1/module/report/getReportFromCache/{sReportgroupCacheID}	Retrieve report from cache

ReportGetReportFromCacheV1

CommonGetReportV1Response ReportGetReportFromCacheV1 (string sReportgroupCacheID)

Retrieve report from cache

Retrieve a report that was previously generated and cached

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class ReportGetReportFromCacheV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");
            // Configure API key authorization: Presigned
            config.AddApiKey("sAuthorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("sAuthorization", "Bearer");

            var apiInstance = new ModuleReportApi(config);
            var sReportgroupCacheID = "sReportgroupCacheID_example";  // string | 

            try
            {
                // Retrieve report from cache
                CommonGetReportV1Response result = apiInstance.ReportGetReportFromCacheV1(sReportgroupCacheID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ModuleReportApi.ReportGetReportFromCacheV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ReportGetReportFromCacheV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve report from cache
    ApiResponse<CommonGetReportV1Response> response = apiInstance.ReportGetReportFromCacheV1WithHttpInfo(sReportgroupCacheID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ModuleReportApi.ReportGetReportFromCacheV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
sReportgroupCacheID	string

Return type

CommonGetReportV1Response

Authorization

Authorization, Presigned

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/zip, text/html

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

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