Skip to content

Latest commit

 

History

History
21 lines (18 loc) · 23 KB

File metadata and controls

21 lines (18 loc) · 23 KB

DocumentsListFilesRequest

Fields

Field Type Required Description Example
xAccountId String ✔️ The account identifier
xStackoneApiSessionToken Optional<String> The session token
raw JsonNullable<Boolean> Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
proxy Map<String, Object> Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
fields JsonNullable<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,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields
filter JsonNullable<DocumentsListFilesQueryParamFilter> Documents Files Filter
page JsonNullable<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
pageSize JsonNullable<String> The number of results per page (default value is 25)
next JsonNullable<String> The unified cursor
updatedAfter OffsetDateTime : 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
folderId JsonNullable<String> Use to only include Files within the specified Folder. Required when requesting nested items 1234567890
nestedItems JsonNullable<String> When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders true
include JsonNullable<String> The comma separated list of fields that will be included in the response all_parent_folder_ids
prefer Optional<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