class LosantRest::EdgeDeployment
Class containing all the actions for the Edge Deployment Resource
Public Class Methods
# File lib/losant_rest/edge_deployment.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Retrieves information on an edge deployment
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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, edgeDeployment.*, or edgeDeployment.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} edgeDeploymentId - ID associated with the edge deployment
-
{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 - Edge deployment information (api.losant.com/#/definitions/edgeDeployment)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if edge deployment was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/edge_deployment.rb, line 56 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("edgeDeploymentId is required") unless params.has_key?(:edgeDeploymentId) 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 = "/applications/#{params[:applicationId]}/edge/deployments/#{params[:edgeDeploymentId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end