Sha256: 4cb545d586ba000ee58bf7aaa3324b54b39cf5ab2f960d3bf11736367a0b83fc
Contents?: true
Size: 1.98 KB
Versions: 10
Compression:
Stored size: 1.98 KB
Contents
# BundleAction
## Example BundleAction Object
```
{
"action": "create",
"bundle_registration": {
"code": "abc123",
"name": "account",
"company": "Action Verb",
"email": "john.doe@files.com",
"ip": "10.1.1.1",
"inbox_code": "abc123",
"clickwrap_body": "example",
"form_field_set_id": 1,
"form_field_data": {
"key": "example value"
},
"bundle_code": "example",
"bundle_id": 1,
"bundle_recipient_id": 1,
"created_at": "2000-01-01T01:00:00Z"
},
"when": "2000-01-01T01:00:00Z",
"destination": "/to_path",
"path": "",
"source": "/from_path"
}
```
* `action` (string): Type of action
* `bundle_registration` (BundleRegistration): Object that contains bundle registration information
* `when` (date-time): Action occurrence date/time
* `destination` (string): The destination path for this bundle action, if applicable
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
* `source` (string): The source path for this bundle action, if applicable
---
## List Bundle Actions
```
Files::BundleAction.list(
per_page: 1,
bundle_id: 1,
bundle_registration_id: 1
)
```
### Parameters
* `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 (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
* `bundle_id` (int64): Bundle ID
* `bundle_registration_id` (int64): BundleRegistration ID
Version data entries
10 entries across 10 versions & 1 rubygems