class LosantRest::ExperienceView
Class containing all the actions for the Experience
View Resource
Public Class Methods
# File lib/losant_rest/experience_view.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes an experience view
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.cli, all.Organization, all.User, all.User.cli, experienceView.*, or experienceView.delete.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} experienceViewId - ID associated with the experience view
-
{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 experience view was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if experience view was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/experience_view.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("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("experienceViewId is required") unless params.has_key?(:experienceViewId) 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]}/experience/views/#{params[:experienceViewId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on an experience view
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.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceView.*, or experienceView.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} experienceViewId - ID associated with the experience view
-
{string} version - Version of this experience view to return
-
{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 -
Experience
view information (api.losant.com/#/definitions/experienceView)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if experience view was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/experience_view.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("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("experienceViewId is required") unless params.has_key?(:experienceViewId) query_params[:version] = params[:version] if params.has_key?(:version) 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]}/experience/views/#{params[:experienceViewId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on resources linked to an experience view
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.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceView.*, or experienceView.linkedResources.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} experienceViewId - ID associated with the experience view
-
{string} version - Version of this experience view to query
-
{string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by returned workflows
-
{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 - Linked resource information (api.losant.com/#/definitions/experienceLinkedResources)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if experience view was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/experience_view.rb, line 152 def linked_resources(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("experienceViewId is required") unless params.has_key?(:experienceViewId) query_params[:version] = params[:version] if params.has_key?(:version) query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes) 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]}/experience/views/#{params[:experienceViewId]}/linkedResources" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates information about an experience view
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.cli, all.Organization, all.User, all.User.cli, experienceView.*, or experienceView.patch.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} experienceViewId - ID associated with the experience view
-
{hash} experienceView - Object containing new properties of the experience view (api.losant.com/#/definitions/experienceViewPatch)
-
{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 experience view information (api.losant.com/#/definitions/experienceView)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if experience view was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/experience_view.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("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("experienceViewId is required") unless params.has_key?(:experienceViewId) raise ArgumentError.new("experienceView is required") unless params.has_key?(:experienceView) body = params[:experienceView] if params.has_key?(:experienceView) 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]}/experience/views/#{params[:experienceViewId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end