Class: ForemanApi::Resources::Bookmark

Inherits:
Base
  • Object
show all
Defined in:
lib/foreman_api/resources/bookmark.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc 



4
5
6
 
# File 'lib/foreman_api/resources/bookmark.rb', line 4

def self.doc
  @doc ||= ForemanApi.doc['resources']["bookmarks"]
end

Instance Method Details

- (Array) create(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • bookmark (Hash) —

    allowed keys are:

    • controller [String]
    • name [String]
    • public [String]
    • query [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



37
38
39
 
# File 'lib/foreman_api/resources/bookmark.rb', line 37

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) destroy(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



61
62
63
 
# File 'lib/foreman_api/resources/bookmark.rb', line 61

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) index(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • page (String) —

    Paginate results

  • per_page (String) —

    Number of entries per request

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



14
15
16
 
# File 'lib/foreman_api/resources/bookmark.rb', line 14

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) show(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



23
24
25
 
# File 'lib/foreman_api/resources/bookmark.rb', line 23

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) update(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String)
  • bookmark (Hash) —

    allowed keys are:

    • controller [String]
    • name [String]
    • public [String]
    • query [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body 



52
53
54
 
# File 'lib/foreman_api/resources/bookmark.rb', line 52

def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end