class LosantRest::InstanceOrg
Class containing all the actions for the Instance
Org
Resource
Public Class Methods
# File lib/losant_rest/instance_org.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes an organization
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, instanceOrg.*, or instanceOrg.delete.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} orgId - ID associated with the organization
-
{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 organization was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if organization was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_org.rb, line 56 def delete(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("orgId is required") unless params.has_key?(:orgId) 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]}/orgs/#{params[:orgId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on an organization
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, instanceOrg.*, or instanceOrg.get.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} orgId - ID associated with the organization
-
{string} summaryInclude - Comma-separated list of summary fields to include in org summary
-
{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 organization (api.losant.com/#/definitions/instanceOrg)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if organization was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_org.rb, line 103 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) raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId) query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude) 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]}/orgs/#{params[:orgId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates information about an organization
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, instanceOrg.*, or instanceOrg.patch.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} orgId - ID associated with the organization
-
{string} summaryInclude - Comma-separated list of summary fields to include in org summary
-
{hash} organization - Object containing new organization properties (api.losant.com/#/definitions/instanceOrgPatch)
-
{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 - Updated organization information (api.losant.com/#/definitions/instanceOrg)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if organization was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_org.rb, line 152 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("orgId is required") unless params.has_key?(:orgId) raise ArgumentError.new("organization is required") unless params.has_key?(:organization) query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude) body = params[:organization] if params.has_key?(:organization) 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]}/orgs/#{params[:orgId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end