Enumerate files

Title

Enumerate files

URL Path

vault_rest/files/{type}/{start}/{count}

Method

GET

CORS support

Yes

Http return

200, 400, 401, 403, 500

Table of Contents

Last Updated

02 Nov 2018

Summary

Retrieve a list of the user's files.

HTTP header parameters

Authorization

The authentication token of the caller

REQUIRED

This header should have the following format: Bearer [

Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

sort_column

Name of column to use when sorting data

OPTIONAL

Possible values: expires, name, size

sort_direction

Sorting direction

OPTIONAL

Possible values: asc, desc

find

Free text search string

OPTIONAL

Free text search string (Use only with English characters)

findB64

Free text search string (Base64 encoded)

OPTIONAL

Free text search string (Base64 encoded to support all charsets). Will override any value specified in 'find' header.

columns

Columns to search

OPTIONAL

Possible values: SearchId, FileTransferId, Subject, Body, Sender, Recepiet, FileName

AvailabilityState

Select one or more availability states

OPTIONAL

By default Files of all availability states are returned. To return files of certain states, specify them in the header (separate multiple states with a , (comma))
Possible states:

Composing
QueuedForProcessing
BeingProcessed
Available
Expired
Deleted
Blocked
BlockedNoSanitization
ProcessingFailed

Method: GET

type

Return entries of this specific type. Possible values: my, all*

REQUIRED

start

Zero based position in list from where to start returning data

REQUIRED

count

Maximum number of list entries to return

REQUIRED

* Requires compliance officer permissions

Request Error

400

Bad Request

Invalid HTTP request

401

Invalid parameter

One or more parameters are invalid

403

Forbidden

Authentication token is incorrect

Enumerating All files and Bearer is not Compliance Officer

500

Internal Server Error

Server is temporarily unavailable

Response

Example of a successful scan request:

{
"filter_count": 2,
"items": [
{
"message": null,
"ui_message_key": null,
"access_mode": 1,
"administrator_approval_state": "ApprovalDisabled",
"availability_state": "Available",
"can_be_approved": false,
"can_be_denied_access": false,
"can_be_downloaded": true,
"can_be_overridden": false,
"can_update_sharing": true,
"date_created": "2018-11-02T13:09:32.0000000Z",
"expires": "2019-11-02T13:09:34.0000000",
"file_id": "8817fa59adb84c5fb1abb75cfec7aaf3",
"is_false_positive": false,
"is_file_owned": true,
"is_locked": false,
"is_sanitized": false,
"processing_state": "Available",
"scan_result": {
"actions_failed": "",
"blocked_reason": "",
"workflow_result": "Allowed"
},
"supervisor_approval_state": "ApprovalDisabled",
"unlock_eta": null,
"file_transfer_id": "a6f332b8b71948d8a943a52eaf33ba21",
"is_archive": false,
"name": "file_is_processing.svg",
"owner": "admin admin",
"owner_id": 1,
"size": 1136
},
{
"message": null,
"ui_message_key": null,
"access_mode": 1,
"administrator_approval_state": "ApprovalDisabled",
"availability_state": "Available",
"can_be_approved": false,
"can_be_denied_access": false,
"can_be_downloaded": true,
"can_be_overridden": false,
"can_update_sharing": true,
"date_created": "2018-11-02T13:08:50.0000000Z",
"expires": "2019-11-02T13:08:52.0000000",
"file_id": "11acc82a43ae4a4bbfd2298058da964a",
"is_false_positive": false,
"is_file_owned": true,
"is_locked": false,
"is_sanitized": false,
"processing_state": "Available",
"scan_result": {
"actions_failed": "",
"blocked_reason": "",
"workflow_result": "Allowed"
},
"supervisor_approval_state": "ApprovalDisabled",
"unlock_eta": null,
"file_transfer_id": "fce96bf709624527a1515456c9354567",
"is_archive": false,
"name": "done.gif",
"owner": "admin admin",
"owner_id": 1,
"size": 1024
}
],
"total_count": 2
}

Descriptions of response:

filter_count

Filtered entries count

Total number of entries in the database when a filter has been applied (via the find parameter). If no filter is specified this value is always equal to total_count.

total_count

Total entries count

Total number of entries of the specific type in the database.

items

Array of entries

An array containing the enumerated files with information about each of them