class LosantRest::ApplicationTemplates
Class containing all the actions for the Application
Templates Resource
Public Class Methods
# File lib/losant_rest/application_templates.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Returns the application templates the current user has permission to see
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.User, all.User.read, applicationTemplates.*, or applicationTemplates.get.
Parameters:
-
{string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
-
{string} sortDirection - Direction to sort the results by. 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: name, authorName
-
{string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
-
{array} keywords - List of keywords to filter by. Matches all provided keywords.
-
{string} categoryId - ID of a category to filter by.
-
{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 application templates (api.losant.com/#/definitions/applicationTemplates)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
# File lib/losant_rest/application_templates.rb, line 61 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil 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) query_params[:keywords] = params[:keywords] if params.has_key?(:keywords) query_params[:categoryId] = params[:categoryId] if params.has_key?(:categoryId) 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 = "/applicationTemplates" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Returns a category list, beginning at the specified category
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.User, all.User.read, applicationTemplates.*, or applicationTemplates.getCategories.
Parameters:
-
{string} baseId - ID of the category to begin from
-
{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 application categories (api.losant.com/#/definitions/applicationTemplateCategories)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
# File lib/losant_rest/application_templates.rb, line 111 def get_categories(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil query_params[:baseId] = params[:baseId] if params.has_key?(:baseId) 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 = "/applicationTemplates/categories" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Returns an array of all unique keywords currently in use by templates
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.User, all.User.read, applicationTemplates.*, or applicationTemplates.getUniqueKeywords.
Parameters:
-
{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 - Array of all unique template keywords (api.losant.com/#/definitions/templateKeywords)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
# File lib/losant_rest/application_templates.rb, line 153 def get_unique_keywords(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil 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 = "/applicationTemplates/keywords" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end