\ScheduledReportApi

All URIs are relative to https://api.uptrends.com/v4

Method	HTTP request	Description
ScheduledReportCreateScheduledReport	Post /ScheduledReport	Creates a new scheduled report.
ScheduledReportDeleteSpecifiedScheduledReport	Delete /ScheduledReport/{scheduledReportGuid}	Delete the specified scheduled report.
ScheduledReportGetAllScheduledReports	Get /ScheduledReport	Returns data for all scheduled reports.
ScheduledReportGetSpecifiedScheduledReport	Get /ScheduledReport/{scheduledReportGuid}	Returns data for the specified scheduled report.
ScheduledReportPartiallyUpdateScheduledReport	Patch /ScheduledReport/{scheduledReportGuid}	Partially update the specified scheduled report.
ScheduledReportUpdateScheduledReport	Put /ScheduledReport/{scheduledReportGuid}	Update the specified scheduled report.

ScheduledReportCreateScheduledReport

ScheduledReport ScheduledReportCreateScheduledReport(ctx).ScheduledReport(scheduledReport).Execute()

Creates a new scheduled report.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    scheduledReport := *openapiclient.NewScheduledReport() // ScheduledReport | The details for the scheduled report. (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
scheduledReport	ScheduledReport	The details for the scheduled report.

Return type

ScheduledReport

Authorization

basicauth

HTTP request headers

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

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

ScheduledReportDeleteSpecifiedScheduledReport

ScheduledReportDeleteSpecifiedScheduledReport(ctx, scheduledReportGuid).Execute()

Delete the specified scheduled report.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    scheduledReportGuid := "scheduledReportGuid_example" // string | The guid of the specified scheduled report.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ScheduledReportApi.ScheduledReportDeleteSpecifiedScheduledReport(context.Background(), scheduledReportGuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ScheduledReportApi.ScheduledReportDeleteSpecifiedScheduledReport``: %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.
scheduledReportGuid	string	The guid of the specified scheduled report.

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

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

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

ScheduledReportGetAllScheduledReports

[]ScheduledReport ScheduledReportGetAllScheduledReports(ctx).Execute()

Returns data for all scheduled reports.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]ScheduledReport

Authorization

basicauth

HTTP request headers

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

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

ScheduledReportGetSpecifiedScheduledReport

ScheduledReport ScheduledReportGetSpecifiedScheduledReport(ctx, scheduledReportGuid).Execute()

Returns data for the specified scheduled report.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    scheduledReportGuid := "scheduledReportGuid_example" // string | The guid of the specified scheduled report.

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
scheduledReportGuid	string	The guid of the specified scheduled report.

Other Parameters

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

Name	Type	Description	Notes

Return type

ScheduledReport

Authorization

basicauth

HTTP request headers

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

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

ScheduledReportPartiallyUpdateScheduledReport

ScheduledReport ScheduledReportPartiallyUpdateScheduledReport(ctx, scheduledReportGuid).ScheduledReport(scheduledReport).Execute()

Partially update the specified scheduled report.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    scheduledReportGuid := "scheduledReportGuid_example" // string | The guid of the specified scheduled report.
    scheduledReport := *openapiclient.NewScheduledReport() // ScheduledReport | The details for the scheduled report. (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
scheduledReportGuid	string	The guid of the specified scheduled report.

Other Parameters

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

Name	Type	Description	Notes

scheduledReport | ScheduledReport | The details for the scheduled report. |

Return type

ScheduledReport

Authorization

basicauth

HTTP request headers

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

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

ScheduledReportUpdateScheduledReport

ScheduledReport ScheduledReportUpdateScheduledReport(ctx, scheduledReportGuid).ScheduledReport(scheduledReport).Execute()

Update the specified scheduled report.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    scheduledReportGuid := "scheduledReportGuid_example" // string | The guid of the specified scheduled report.
    scheduledReport := *openapiclient.NewScheduledReport() // ScheduledReport | The details for the scheduled report. (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
scheduledReportGuid	string	The guid of the specified scheduled report.

Other Parameters

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

Name	Type	Description	Notes

scheduledReport | ScheduledReport | The details for the scheduled report. |

Return type

ScheduledReport

Authorization

basicauth

HTTP request headers

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

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

Files

ScheduledReportApi.md

Latest commit

History

ScheduledReportApi.md

File metadata and controls

\ScheduledReportApi

ScheduledReportCreateScheduledReport

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ScheduledReportDeleteSpecifiedScheduledReport

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ScheduledReportGetAllScheduledReports

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ScheduledReportGetSpecifiedScheduledReport

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ScheduledReportPartiallyUpdateScheduledReport

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ScheduledReportUpdateScheduledReport

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers