Skip to content

Latest commit

 

History

History
191 lines (120 loc) · 7.83 KB

ScheduledReportApi.md

File metadata and controls

191 lines (120 loc) · 7.83 KB

\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, optional) Creates a new scheduled report.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ScheduledReportApiScheduledReportCreateScheduledReportOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ScheduledReportApiScheduledReportCreateScheduledReportOpts struct

Name Type Description Notes
scheduledReport optional.Interface of 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) Delete the specified scheduled report.

Required 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.

Return type

(empty response body)

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]

ScheduledReportGetAllScheduledReports

[]ScheduledReport ScheduledReportGetAllScheduledReports(ctx, ) Returns data for all scheduled reports.

Required Parameters

This endpoint does not need any parameter.

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]

ScheduledReportGetSpecifiedScheduledReport

ScheduledReport ScheduledReportGetSpecifiedScheduledReport(ctx, scheduledReportGuid) Returns data for the specified scheduled report.

Required 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.

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]

ScheduledReportPartiallyUpdateScheduledReport

ScheduledReport ScheduledReportPartiallyUpdateScheduledReport(ctx, scheduledReportGuid, optional) Partially update the specified scheduled report.

Required 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.
optional *ScheduledReportApiScheduledReportPartiallyUpdateScheduledReportOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ScheduledReportApiScheduledReportPartiallyUpdateScheduledReportOpts struct

Name Type Description Notes

scheduledReport | optional.Interface of 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, optional) Update the specified scheduled report.

Required 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.
optional *ScheduledReportApiScheduledReportUpdateScheduledReportOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ScheduledReportApiScheduledReportUpdateScheduledReportOpts struct

Name Type Description Notes

scheduledReport | optional.Interface of 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]