Sign in

v4

Swagger 2.02026-08-0343714211.7 MB
bundle_actions
Bundle Actions

List Bundle Actions

List Bundle Actions

get/bundle_actions

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

cursorstring

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_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, created_at or bundle_registration_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are created_at, bundle_id or bundle_registration_id. Valid field combinations are [ bundle_id, created_at ], [ bundle_registration_id, created_at ], [ bundle_id, bundle_registration_id ] or [ bundle_id, bundle_registration_id, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

bundle_idinteger

Bundle ID

bundle_registration_idinteger

Bundle Registration ID

Response

A list of BundleActions objects.

action'create' | 'read' | 'update' | 'destroy' | 'move' | 'copy' | 'registration'

Type of action

created_atstring date-time

Action occurrence date/time

destinationstring

The destination path for this bundle action, if applicable

pathstring

Path

sourcestring

The source path for this bundle action, if applicable

bundle_registration_idinteger

Identifier of the associated bundle registration

workspace_idinteger

Workspace ID. 0 means the default workspace.

bundle_registration_namestring

Name of the registrant who performed the action

bundle_registration_emailstring

Email of the registrant

bundle_registration_ipstring

IP address of the registrant

form_field_set_idinteger

Id of associated form field set

form_field_dataobject

Data for form field set with form field ids as keys and user data as values

Example response

[
  {
    "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,
      "workspace_id": 1,
      "created_at": "2000-01-01T01:00:00Z"
    },
    "created_at": "2000-01-01T01:00:00Z",
    "destination": "/to_path",
    "path": "path",
    "source": "/from_path",
    "bundle_registration_id": 1,
    "workspace_id": 1,
    "bundle_registration_name": "John Doe",
    "bundle_registration_email": "john@example.com",
    "bundle_registration_ip": "127.0.0.1",
    "form_field_set_id": 1,
    "form_field_data": {
      "key": "example value"
    }
  }
]