class LosantRest::Notebook
Class containing all the actions for the Notebook
Resource
Public Class Methods
# File lib/losant_rest/notebook.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes a notebook
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.Organization, all.User, notebook.*, or notebook.delete.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} notebookId - ID associated with the notebook
-
{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 notebook was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if notebook was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/notebook.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("notebookId is required") unless params.has_key?(:notebookId) 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]}/notebooks/#{params[:notebookId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Triggers the execution of a notebook
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.Organization, all.User, notebook.*, or notebook.execute.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} notebookId - ID associated with the notebook
-
{hash} executionOptions - The options for the execution (api.losant.com/#/definitions/notebookExecutionOptions)
-
{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 execution request was accepted and successfully queued (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if notebook was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/notebook.rb, line 103 def execute(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("notebookId is required") unless params.has_key?(:notebookId) raise ArgumentError.new("executionOptions is required") unless params.has_key?(:executionOptions) body = params[:executionOptions] if params.has_key?(:executionOptions) 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]}/notebooks/#{params[:notebookId]}/execute" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on a notebook
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, notebook.*, or notebook.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} notebookId - ID associated with the notebook
-
{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 - notebook information (api.losant.com/#/definitions/notebook)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if notebook was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/notebook.rb, line 151 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("notebookId is required") unless params.has_key?(:notebookId) 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]}/notebooks/#{params[:notebookId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on notebook executions
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, notebook.*, or notebook.logs.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} notebookId - ID associated with the notebook
-
{string} limit - Max log entries to return (ordered by time descending)
-
{string} since - Look for log entries since this time (ms since epoch)
-
{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 - notebook execution information (api.losant.com/#/definitions/notebookExecutionLogs)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if notebook was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/notebook.rb, line 199 def logs(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("notebookId is required") unless params.has_key?(:notebookId) query_params[:limit] = params[:limit] if params.has_key?(:limit) query_params[:since] = params[:since] if params.has_key?(:since) 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]}/notebooks/#{params[:notebookId]}/logs" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates information about a notebook
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.Organization, all.User, notebook.*, or notebook.patch.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} notebookId - ID associated with the notebook
-
{hash} notebook - Object containing new properties of the notebook (api.losant.com/#/definitions/notebookPatch)
-
{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 notebook information (api.losant.com/#/definitions/notebook)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if notebook was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/notebook.rb, line 248 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("notebookId is required") unless params.has_key?(:notebookId) raise ArgumentError.new("notebook is required") unless params.has_key?(:notebook) body = params[:notebook] if params.has_key?(:notebook) 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]}/notebooks/#{params[:notebookId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end
Requests a combined zip file of the potential input data for a notebook execution
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, notebook.*, or notebook.requestInputDataExport.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} notebookId - ID associated with the notebook
-
{hash} exportOptions - The options for the export (api.losant.com/#/definitions/notebookDataExportOptions)
-
{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 export request was accepted and successfully queued (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if notebook was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/notebook.rb, line 297 def request_input_data_export(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("notebookId is required") unless params.has_key?(:notebookId) raise ArgumentError.new("exportOptions is required") unless params.has_key?(:exportOptions) body = params[:exportOptions] if params.has_key?(:exportOptions) 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]}/notebooks/#{params[:notebookId]}/requestInputDataExport" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end