Class: PlatformRest::Dashboard

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_rest/dashboard.rb

Overview

Class containing all the actions for the Dashboard Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Dashboard

Returns a new instance of Dashboard.



30
31
32
 
# File 'lib/platform_rest/dashboard.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#delete(params = {}) ⇒ Object

Deletes a dashboard

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Organization, all.User, dashboard.*, or dashboard.delete.

Parameters:

  • string dashboardId - ID of the associated dashboard

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/platform_rest/dashboard.rb', line 55

def delete(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)

  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/dashboards/#{params[:dashboardId]}"

  @client.request(
    method: :delete,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get(params = {}) ⇒ Object

Retrieves information on a dashboard

Authentication: No api access token is required to call this action.

Parameters:

  • string dashboardId - ID of the associated dashboard

  • string password - Password for password-protected dashboards

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/platform_rest/dashboard.rb', line 97

def get(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)

  query_params[:password] = params[:password] if params.has_key?(:password)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/dashboards/#{params[:dashboardId]}"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#patch(params = {}) ⇒ Object

Updates information about a dashboard

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Organization, all.User, dashboard.*, or dashboard.patch.

Parameters:

  • string dashboardId - ID of the associated dashboard

  • hash dashboard - Object containing new dashboard properties (api.losant.com/#/definitions/dashboardPatch)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/platform_rest/dashboard.rb', line 143

def patch(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)
  raise ArgumentError.new("dashboard is required") unless params.has_key?(:dashboard)

  body = params[:dashboard] if params.has_key?(:dashboard)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/dashboards/#{params[:dashboardId]}"

  @client.request(
    method: :patch,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#send_report(params = {}) ⇒ Object

Sends a snapshot of a dashboard

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Organization, all.User, dashboard.*, or dashboard.sendReport.

Parameters:

  • string dashboardId - ID of the associated dashboard

  • hash reportConfig - Object containing report options (api.losant.com/#/definitions/dashboardSendReport)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/platform_rest/dashboard.rb', line 190

def send_report(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)
  raise ArgumentError.new("reportConfig is required") unless params.has_key?(:reportConfig)

  body = params[:reportConfig] if params.has_key?(:reportConfig)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/dashboards/#{params[:dashboardId]}"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#validate_context(params = {}) ⇒ Object

Validates a context object against the dashboard’s context configuration

Authentication: No api access token is required to call this action.

Parameters:

  • string dashboardId - ID of the associated dashboard

  • hash ctx - The context object to validate (api.losant.com/#/definitions/dashboardContextInstance)

  • string password - Password for password-protected dashboards

  • string duration - Duration of data to fetch in milliseconds

  • string resolution - Resolution in milliseconds

  • string end - End timestamp of the data, in ms since epoch

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/platform_rest/dashboard.rb', line 238

def validate_context(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)
  raise ArgumentError.new("ctx is required") unless params.has_key?(:ctx)

  body = params[:ctx] if params.has_key?(:ctx)
  query_params[:password] = params[:password] if params.has_key?(:password)
  query_params[:duration] = params[:duration] if params.has_key?(:duration)
  query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
  query_params[:end] = params[:end] if params.has_key?(:end)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/dashboards/#{params[:dashboardId]}/validateContext"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end