Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 19.5 KB

File metadata and controls

20 lines (17 loc) · 19.5 KB

DocumentsListFoldersRequest

Fields

Field Type Required Description Example
prefer T.nilable(::String) Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240) heartbeat
fields_ T.nilable(::String) The comma separated list of fields that will be returned in the response (if empty, all fields are returned) id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields
filter T.nilable(Models::Operations::DocumentsListFoldersQueryParamFilter) Documents Folders Filter
folder_id T.nilable(::String) Use to only include Folders within the specified Folder. Required when requesting nested items 1234567890
include T.nilable(::String) The comma separated list of fields that will be included in the response all_parent_folder_ids
nested_items T.nilable(::String) When "true" and used with filter[folder_id], the response includes Folders and their descendant Folders true
next_ T.nilable(::String) The unified cursor
page T.nilable(::String) : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch
page_size T.nilable(::String) The number of results per page (default value is 25)
proxy T::Hash[Symbol, ::Object] Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
raw T.nilable(T::Boolean) Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
updated_after Date : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date
2020-01-01T00:00:00.000Z
x_account_id ::String ✔️ The account identifier