class LosantRest::DataTableRow
Class containing all the actions for the Data
Table Row Resource
Public Class Methods
# File lib/losant_rest/data_table_row.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes a data table row
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, dataTableRow.*, or dataTableRow.delete.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} dataTableId - ID associated with the data table
-
{string} rowId - ID associated with the data table row
-
{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 data table row was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if data table row was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/data_table_row.rb, line 57 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("dataTableId is required") unless params.has_key?(:dataTableId) raise ArgumentError.new("rowId is required") unless params.has_key?(:rowId) 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]}/data-tables/#{params[:dataTableId]}/rows/#{params[:rowId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Retrieves the data table row
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, dataTableRow.*, or dataTableRow.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} dataTableId - ID associated with the data table
-
{string} rowId - ID associated with the data table row
-
{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 -
Data
table row information (api.losant.com/#/definitions/dataTableRow)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if data table row was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/data_table_row.rb, line 105 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("dataTableId is required") unless params.has_key?(:dataTableId) raise ArgumentError.new("rowId is required") unless params.has_key?(:rowId) 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]}/data-tables/#{params[:dataTableId]}/rows/#{params[:rowId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates the data table row
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, dataTableRow.*, or dataTableRow.patch.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} dataTableId - ID associated with the data table
-
{string} rowId - ID associated with the data table row
-
{hash} dataTableRow - Object containing updated properties for the data table row (api.losant.com/#/definitions/dataTableRowInsertUpdate)
-
{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 data table row information (api.losant.com/#/definitions/dataTableRow)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if data table row was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/data_table_row.rb, line 154 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("dataTableId is required") unless params.has_key?(:dataTableId) raise ArgumentError.new("rowId is required") unless params.has_key?(:rowId) raise ArgumentError.new("dataTableRow is required") unless params.has_key?(:dataTableRow) body = params[:dataTableRow] if params.has_key?(:dataTableRow) 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]}/data-tables/#{params[:dataTableId]}/rows/#{params[:rowId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end