Class: PlatformRest::DataTableRows

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_rest/data_table_rows.rb

Overview

Class containing all the actions for the Data Table Rows Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DataTableRows

Returns a new instance of DataTableRows.



30
31
32
 
# File 'lib/platform_rest/data_table_rows.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#delete(params = {}) ⇒ Object

Delete rows from a data table

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, dataTableRows.*, or dataTableRows.delete.

Parameters:

  • string applicationId - ID associated with the application

  • string dataTableId - ID associated with the data table

  • hash query - Query to apply to filter the data table (api.losant.com/#/definitions/advancedQuery)

  • string limit - Limit number of rows to delete from data table

  • 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:

Errors:

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/platform_rest/data_table_rows.rb', line 58

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)

  body = params[:query] if params.has_key?(:query)
  query_params[:limit] = params[:limit] if params.has_key?(:limit)
  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/delete"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#export(params = {}) ⇒ Object

Request an export of the data table’s data

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, dataTableRows.*, or dataTableRows.export.

Parameters:

  • string applicationId - ID associated with the application

  • string dataTableId - ID associated with the data table

  • hash exportData - Object containing export specifications (api.losant.com/#/definitions/dataTableRowsExport)

  • 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:

Errors:

Raises:

  • (ArgumentError) 


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/platform_rest/data_table_rows.rb', line 107

def 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("dataTableId is required") unless params.has_key?(:dataTableId)
  raise ArgumentError.new("exportData is required") unless params.has_key?(:exportData)

  body = params[:exportData] if params.has_key?(:exportData)
  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/export"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get(params = {}) ⇒ Object

Returns the rows for a data table

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, dataTableRows.*, or dataTableRows.get.

Parameters:

  • string applicationId - ID associated with the application

  • string dataTableId - ID associated with the data table

  • string sortColumn - Column to sort the rows by

  • string sortDirection - Direction to sort the rows by. Accepted values are: asc, desc

  • string limit - How many rows to return

  • string offset - How many rows to skip

  • string includeFields - Comma-separated list of fields to include in resulting rows. When not provided, returns all fields.

  • 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:

Errors:

Raises:

  • (ArgumentError) 


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/platform_rest/data_table_rows.rb', line 160

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)

  query_params[:sortColumn] = params[:sortColumn] if params.has_key?(:sortColumn)
  query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
  query_params[:limit] = params[:limit] if params.has_key?(:limit)
  query_params[:offset] = params[:offset] if params.has_key?(:offset)
  query_params[:includeFields] = params[:includeFields] if params.has_key?(:includeFields)
  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"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#post(params = {}) ⇒ Object

Inserts a new row(s) into a data table

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, dataTableRows.*, or dataTableRows.post.

Parameters:

  • string applicationId - ID associated with the application

  • string dataTableId - ID associated with the data table

  • hash dataTableRow - The row(s) to insert (api.losant.com/#/definitions/dataTableRowInsert)

  • 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:

Errors:

Raises:

  • (ArgumentError) 


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/platform_rest/data_table_rows.rb', line 212

def post(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("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"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#query(params = {}) ⇒ Object

Queries for rows from a data table

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, dataTableRows.*, or dataTableRows.query.

Parameters:

  • string applicationId - ID associated with the application

  • string dataTableId - ID associated with the data table

  • string sortColumn - Column to sort the rows by

  • string sortDirection - Direction to sort the rows by. Accepted values are: asc, desc

  • string limit - How many rows to return

  • string offset - How many rows to skip

  • string includeFields - Comma-separated list of fields to include in resulting rows. When not provided, returns all fields.

  • hash query - Query to apply to filter the data table (api.losant.com/#/definitions/advancedQuery)

  • 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:

Errors:

Raises:

  • (ArgumentError) 


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/platform_rest/data_table_rows.rb', line 266

def query(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)

  query_params[:sortColumn] = params[:sortColumn] if params.has_key?(:sortColumn)
  query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
  query_params[:limit] = params[:limit] if params.has_key?(:limit)
  query_params[:offset] = params[:offset] if params.has_key?(:offset)
  query_params[:includeFields] = params[:includeFields] if params.has_key?(:includeFields)
  body = params[:query] if params.has_key?(:query)
  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/query"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#truncate(params = {}) ⇒ Object

Delete all data in the data table

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, dataTableRows.*, or dataTableRows.truncate.

Parameters:

  • string applicationId - ID associated with the application

  • string dataTableId - ID associated with the data table

  • 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:

Errors:

Raises:

  • (ArgumentError) 


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/platform_rest/data_table_rows.rb', line 318

def truncate(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)

  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/truncate"

  @client.request(
    method: :post,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end