class Sensit::Api::Field

.

topic_id - The key for the parent topic id - Username of the user

Public Class Methods

new(topic_id, id, client) click to toggle source
# File lib/sensit/api/field.rb, line 11
def initialize(topic_id, id, client)
  @topic_id = topic_id
  @id = id
  @client = client
end

Public Instance Methods

create(field, options = {}) click to toggle source

Adds a new field that feed data can be added too. Requires authorization of manage_any_data, or manage_application_data ‘/topics/:topic_id/fields’ POST

field - A Hash containing`name`: A descriptive name of the field.‘key`:The name that is used to identify the field in a feed (required).`datatype`:The type of data that is stored in the field. ie. integer, float, string, bool, datetime

# File lib/sensit/api/field.rb, line 43
def create(field, options = {})
  body = options.has_key?(:body) ? options[:body] : {}
  body[:field] = field

  response = @client.post "/topics/#{@topic_id}/fields", body, options

  return response
end
delete(options = {}) click to toggle source

Deletes a field and the feed data in that field. Requires authorization of manage_any_data, or manage_application_data ‘/api/topics/:topic_id/fields/:id’ DELETE

# File lib/sensit/api/field.rb, line 68
def delete(options = {})
  body = options.has_key?(:body) ? options[:body] : {}

  response = @client.delete "/api/topics/#{@topic_id}/fields/#{@id}", body, options

  return response
end
find(options = {}) click to toggle source

Get a Field of the associated a topic and Id. Requires authorization of read_any_data, or read_application_data ‘/topics/:topic_id/fields/:id’ GET

# File lib/sensit/api/field.rb, line 31
def find(options = {})
  body = options.has_key?(:query) ? options[:query] : {}

  response = @client.get "/topics/#{@topic_id}/fields/#{@id}", body, options

  return response
end
list(options = {}) click to toggle source

Get all the fields associated with a topic. Requires authorization of read_any_data, or read_application_data ‘/topics/:topic_id/fields’ GET

# File lib/sensit/api/field.rb, line 20
def list(options = {})
  body = options.has_key?(:query) ? options[:query] : {}

  response = @client.get "/topics/#{@topic_id}/fields", body, options

  return response
end
update(field, options = {}) click to toggle source

Updates the Field data and makes the corresponding changes in the index. Requires authorization of manage_any_data, or manage_application_data ‘/api/topics/:topic_id/fields/:id’ PUT

field - A Hash containing`name`: A descriptive name of the field.‘key`:The name that is used to identify the field in a feed (required).`datatype`:The type of data that is stored in the field. ie. integer, float, string, bool, datetime

# File lib/sensit/api/field.rb, line 56
def update(field, options = {})
  body = options.has_key?(:body) ? options[:body] : {}
  body[:field] = field

  response = @client.put "/api/topics/#{@topic_id}/fields/#{@id}", body, options

  return response
end