ReportsAPI.md

\ReportsAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
DeleteReport	Delete /toae/reports/{report_id}	Delete Report
GenerateReport	Post /toae/reports	Generate Report
GetReport	Get /toae/reports/{report_id}	Get Report
ListReports	Get /toae/reports	List Reports

DeleteReport

DeleteReport(ctx, reportId).Execute()

Delete Report

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Sam12121/golang_toae_sdk/client"
)

func main() {
    reportId := "reportId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ReportsAPI.DeleteReport(context.Background(), reportId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportsAPI.DeleteReport``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
reportId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteReportRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

bearer_token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

GenerateReport

ModelGenerateReportResp GenerateReport(ctx).ModelGenerateReportReq(modelGenerateReportReq).Execute()

Generate Report

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Sam12121/golang_toae_sdk/client"
)

func main() {
    modelGenerateReportReq := *openapiclient.NewModelGenerateReportReq("ReportType_example") // ModelGenerateReportReq |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ReportsAPI.GenerateReport(context.Background()).ModelGenerateReportReq(modelGenerateReportReq).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportsAPI.GenerateReport``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GenerateReport`: ModelGenerateReportResp
    fmt.Fprintf(os.Stdout, "Response from `ReportsAPI.GenerateReport`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGenerateReportRequest struct via the builder pattern

Name	Type	Description	Notes
modelGenerateReportReq	ModelGenerateReportReq

Return type

ModelGenerateReportResp

Authorization

bearer_token

HTTP request headers

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

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

GetReport

ModelExportReport GetReport(ctx, reportId).Execute()

Get Report

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Sam12121/golang_toae_sdk/client"
)

func main() {
    reportId := "reportId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ReportsAPI.GetReport(context.Background(), reportId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportsAPI.GetReport``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetReport`: ModelExportReport
    fmt.Fprintf(os.Stdout, "Response from `ReportsAPI.GetReport`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
reportId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetReportRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ModelExportReport

Authorization

bearer_token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

ListReports

[]ModelExportReport ListReports(ctx).Execute()

List Reports

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Sam12121/golang_toae_sdk/client"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ReportsAPI.ListReports(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportsAPI.ListReports``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListReports`: []ModelExportReport
    fmt.Fprintf(os.Stdout, "Response from `ReportsAPI.ListReports`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiListReportsRequest struct via the builder pattern

Return type

[]ModelExportReport

Authorization

bearer_token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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