class ForemanApi::Resources::Location
Public Class Methods
# File lib/foreman_api/resources/location.rb, line 4 def self.doc @doc ||= ForemanApi.doc['resources']["locations"] end
Public Instance Methods
@param [Hash] params a hash of params to be passed to the service @option params [Hash, nil] location
allowed keys are: * name [String]
@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body
# File lib/foreman_api/resources/location.rb, line 36 def create(params = {}, headers = {}) perform_call(__method__, params, headers) end
@param [Hash] params a hash of params to be passed to the service @option
params [Object] id Part of /api/locations/:id
path
@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body
# File lib/foreman_api/resources/location.rb, line 57 def destroy(params = {}, headers = {}) perform_call(__method__, params, headers) end
@param [Hash] params a hash of params to be passed to the service @option params [String] order sort results @option params [String] page paginate results @option params [String] per_page number of entries per request @option params [String] search filter results
@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body
# File lib/foreman_api/resources/location.rb, line 16 def index(params = {}, headers = {}) perform_call(__method__, params, headers) end
@param [Hash] params a hash of params to be passed to the service @option
params [Object] id Part of /api/locations/:id
path
@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body
# File lib/foreman_api/resources/location.rb, line 25 def show(params = {}, headers = {}) perform_call(__method__, params, headers) end
@param [Hash] params a hash of params to be passed to the service @option
params [Object] id Part of /api/locations/:id
path @option
params [Hash, nil] location
allowed keys are: * name [String]
@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body
# File lib/foreman_api/resources/location.rb, line 48 def update(params = {}, headers = {}) perform_call(__method__, params, headers) end