Class: BrickFTP::RESTfulAPI::RetrieveUserHistory
- Inherits:
-
Object
- Object
- BrickFTP::RESTfulAPI::RetrieveUserHistory
- Includes:
- Command, RetrieveHistory
- Defined in:
- lib/brick_ftp/restful_api/retrieve_user_history.rb
Overview
Retrieve user history
Params
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
page | integer | Optional page number of items to return in this request. |
per_page | integer | Optional requested number of items returned per request. Default: 1000, maximum: 10000. Leave blank for default (strongly recommended). |
start_at | datetime | Optional date and time in the history to start from. |
Constant Summary
Constants included from RetrieveHistory
BrickFTP::RESTfulAPI::RetrieveHistory::MAX_PER_PAGE
Instance Method Summary collapse
-
#call(id, page: nil, per_page: nil, start_at: nil) ⇒ Array<BrickFTP::Types::History>
Returns user history only.
Methods included from RetrieveHistory
#build_query, #retrieve, #validate_page!, #validate_per_page!, #validate_start_at!
Methods included from Command
Instance Method Details
#call(id, page: nil, per_page: nil, start_at: nil) ⇒ Array<BrickFTP::Types::History>
Returns user history only.
- The history starts with the most recent entries and proceeds back in time.
- There is a maximum number of records that will be returned with a single request (default 1000 or whatever value you provide as the per_page parameter, up to a maximum of 10,000).
35 36 37 |
# File 'lib/brick_ftp/restful_api/retrieve_user_history.rb', line 35 def call(id, page: nil, per_page: nil, start_at: nil) retrieve("/api/rest/v1/history/users/#{id}.json", page, per_page, start_at) end |