class LosantRest::Instance
Class containing all the actions for the Instance
Resource
Public Class Methods
# File lib/losant_rest/instance.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Generates a CSV report on instance stats
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.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.generateReport.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{hash} options - Object containing report configuration (api.losant.com/#/definitions/instanceReportOptionsPost)
-
{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 generation of report was successfully started (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance.rb, line 55 def generate_report(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) body = params[:options] if params.has_key?(:options) 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 = "/instances/#{params[:instanceId]}/generateReport" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end
Returns an instance
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.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.get.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{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 - A single instance (api.losant.com/#/definitions/instance)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if instance was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance.rb, line 100 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) 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 = "/instances/#{params[:instanceId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Return historical summary entries for an instance
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.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.historicalSummaries.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} month - Timestamp within the month to report a summary for.
-
{string} sortField - Field to sort the results by. Accepted values are: resourceId, currentPeriodStart
-
{string} sortDirection - Direction to sort the results in. Accepted values are: asc, desc
-
{string} page - Which page of results to return
-
{string} perPage - How many items to return per page
-
{string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: resourceType, resourceId, ownerId, ownerType
-
{string} filter - Filter to apply against the filtered field. Blank or not provided means no filtering.
-
{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 - Collection of historical summaries (api.losant.com/#/definitions/historicalSummaries)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance.rb, line 150 def historical_summaries(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) query_params[:month] = params[:month] if params.has_key?(:month) query_params[:sortField] = params[:sortField] if params.has_key?(:sortField) query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection) query_params[:page] = params[:page] if params.has_key?(:page) query_params[:perPage] = params[:perPage] if params.has_key?(:perPage) query_params[:filterField] = params[:filterField] if params.has_key?(:filterField) query_params[:filter] = params[:filter] if params.has_key?(:filter) 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 = "/instances/#{params[:instanceId]}/historicalSummaries" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates information about an instance
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.Instance, all.User, instance.*, or instance.patch.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{hash} instance - Updated instance information (api.losant.com/#/definitions/instancePatch)
-
{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 - The updated instance object (api.losant.com/#/definitions/instance)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance.rb, line 201 def patch(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("instance is required") unless params.has_key?(:instance) body = params[:instance] if params.has_key?(:instance) 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 = "/instances/#{params[:instanceId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end