Sha256: 2f91cda146f64c6a5cb25c76aa6d171246f502974196eb069bd14cc9391f74ca
Contents?: true
Size: 1.53 KB
Versions: 6
Compression:
Stored size: 1.53 KB
Contents
# Export
## Example Export Object
```
{
"id": 1,
"export_status": "example",
"export_type": "example",
"download_uri": "example"
}
```
* `id` (int64): ID for this Export
* `export_status` (string): Status of the Export
* `export_type` (string): Type of data being exported
* `download_uri` (string): Link to download Export file.
---
## List Exports
```
Files::Export.list(
user_id: 1
)
```
### Parameters
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
---
## Show Export
```
Files::Export.find(id)
```
### Parameters
* `id` (int64): Required - Export ID.
Version data entries
6 entries across 6 versions & 1 rubygems