Skip to content

Latest commit

 

History

History
184 lines (115 loc) · 6.61 KB

DashboardApi.md

File metadata and controls

184 lines (115 loc) · 6.61 KB

\DashboardApi

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

Method HTTP request Description
DashboardCloneDashboard Post /Dashboard/{dashboardGuid}/Clone Clone the specified dashboard.
DashboardDeleteDashboard Delete /Dashboard/{dashboardGuid} Delete the specified dashboard.
DashboardGetAllDashboards Get /Dashboard Returns data for all dashboards.
DashboardGetOneDashboard Get /Dashboard/{dashboardGuid} Returns data for the specified dashboard.
DashboardPartiallyUpdateDashboard Patch /Dashboard/{dashboardGuid} Partially update the specified dashboard.
DashboardUpdateDashboard Put /Dashboard/{dashboardGuid} Update the specified dashboard.

DashboardCloneDashboard

Dashboard DashboardCloneDashboard(ctx, dashboardGuid) Clone the specified dashboard.

Required Parameters

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

Return type

Dashboard

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]

DashboardDeleteDashboard

DashboardDeleteDashboard(ctx, dashboardGuid) Delete the specified dashboard.

Required Parameters

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

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]

DashboardGetAllDashboards

[]Dashboard DashboardGetAllDashboards(ctx, ) Returns data for all dashboards.

Required Parameters

This endpoint does not need any parameter.

Return type

[]Dashboard

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]

DashboardGetOneDashboard

Dashboard DashboardGetOneDashboard(ctx, dashboardGuid) Returns data for the specified dashboard.

Required Parameters

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

Return type

Dashboard

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]

DashboardPartiallyUpdateDashboard

DashboardPartiallyUpdateDashboard(ctx, dashboardGuid, optional) Partially update the specified dashboard.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dashboardGuid string The guid of the specified dashboard.
optional *DashboardApiDashboardPartiallyUpdateDashboardOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DashboardApiDashboardPartiallyUpdateDashboardOpts struct

Name Type Description Notes

dashboard | optional.Interface of Dashboard| The details for the dashboard. |

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]

DashboardUpdateDashboard

DashboardUpdateDashboard(ctx, dashboardGuid, optional) Update the specified dashboard.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dashboardGuid string The guid of the specified dashboard.
optional *DashboardApiDashboardUpdateDashboardOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DashboardApiDashboardUpdateDashboardOpts struct

Name Type Description Notes

dashboard | optional.Interface of Dashboard| The details for the dashboard. |

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]