Folder Search

Title

Search folder

URL Path

vault_rest/folder_search/{id}/{start}/{count}

Method

GET

CORS support

Yes

Summary

Retrieve a list of the user's folders and files starting from a specified folder and filtered by a search string.

HTTP header parameters

Authorization

The API key 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: name, size, datecreated

sort_direction

Sorting direction

OPTIONAL

Possible values: asc, desc

find

Free text search string

REQUIRED/OPTIONAL*

Free text search string (Use only with English characters)

findB64

Free text search string (Base64 encoded)

REQUIRED/OPTIONAL*

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

* the request needs to contain one of the following fields: find or findB64

Method: GET

id

Unique identifier of folder; this is the starting place for the search

REQUIRED

start

Zero based position in list from where to start returning data

REQUIRED

count

Maximum number of list entries to return

REQUIRED

Request Error

400

Bad Request

Invalid HTTP request

401

Invalid parameter

One or more parameters are invalid

403

Forbidden

API key is incorrect

500

Internal Server Error

Server is temporarily unavailable

Response

Example of a successful folder search request:

{
"message": null,
"ui_message_key": null,
"files": [{
"administrator_approval_state": "ApprovalDisabled",
"availability_state": "Available",
"can_be_deleted": true,
"can_be_downloaded": true,
"can_be_rescanned": false,
"current_approval_count": 0,
"file_id": "30829e19edb84bcf968cf943480bd1e4",
"is_locked": false,
"is_sanitized": false,
"name": "Document.docx",
"processing_state": "Available",
"required_approval_count": 1,
"scan_result": {
"actions_failed": null,
"blocked_reason": null,
"workflow_result": null
},
"supervisor_approval_state": "ApprovalDisabled",
"unlock_eta": null,
"can_retry_processing": false,
"creation_date": "2021-02-12T15:25:04.0000000",
"expires": "2022-02-12T15:25:05.0000000",
"is_false_positive": false,
"owner": "admin admin",
"owner_id": 1,
"size": 853198,
"can_update_sharing": true
}],
"folders": [{
"availability_state": "Available",
"can_update_sharing": true,
"folder_id": "ca7b663ebec2434b9939cbdc76a12002",
"name": "Documents",
"owner": "admin admin",
"owner_id": 1,
"path": "My Folder\\Documents",
"folder_path_list": [{
"availability_state": "Available",
"can_update_sharing": true,
"folder_id": "630dc4ece05b4ffa912592e74ebec5fe",
"name": "",
"owner": "admin admin",
"owner_id": 1,
"path": ""
},
{
"availability_state": "Available",
"can_update_sharing": true,
"folder_id": "d46c1253c5f4475fa6da78b6f0add72f",
"name": "My Folder",
"owner": "admin admin",
"owner_id": 1,
"path": "My Folder"
},
{
"availability_state": "Available",
"can_update_sharing": true,
"folder_id": "ef1e68421725406d8f3212d57afc4464",
"name": "Documents",
"owner": "admin admin",
"owner_id": 1,
"path": "My Folder\\Documents"
}
]
}],
"total_count": 2
}

Descriptions of response:

total_count

Total entries count

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

files

Array of entries

An array containing files in the folder with information about each of them

folders

Array of entries

An array containing folders in the folder with information about each of them

Each folder contains a folder_path_list object - a flat list that contains all the folders from previous levels (up to Vault root folder) to the current folder