class LosantRest::Dashboard
Class containing all the actions for the Dashboard
Resource
Public Class Methods
# File lib/losant_rest/dashboard.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
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:
-
200 - If dashboard was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if dashboard was not found (api.losant.com/#/definitions/error)
# File lib/losant_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
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:
-
200 -
Dashboard
information (api.losant.com/#/definitions/dashboard)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if dashboard was not found (api.losant.com/#/definitions/error)
# File lib/losant_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
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:
-
200 - Update dashboard information (api.losant.com/#/definitions/dashboard)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if dashboard was not found (api.losant.com/#/definitions/error)
# File lib/losant_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
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:
-
200 - Send dashboard report (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if dashboard was not found (api.losant.com/#/definitions/error)
# File lib/losant_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
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} 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:
-
200 - If context is valid (api.losant.com/#/definitions/validateContextSuccess)
Errors:
-
400 - Error if context is invalid (api.losant.com/#/definitions/validateContextError)
-
404 - Error if dashboard or application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/dashboard.rb, line 235 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) 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