The SEARCH_DOCUMENTS action is used to look for documents within the Perceptive Content repository.
The input parameters for SEARCH_DOCUMENTS are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| category | String | Required | Represents the type of view used within the Perceptive Content Viewer. The following values are possible: DOCUMENT, FOLDER, FOLDER_CONTENT, TASK, WORKFLOW. |
| clientTimeZoneOffset | String | Optional | The client time zone represented as an ISO 8601 offset from UTC, for example "+02:00". |
| query | String | Required | The Visual Scripting Language (VSL) search string, for example
"[name] startswith 'prefix-'". For more information on the VSL syntax, search for Use VSL in the Perceptive Content documentation. |
| viewId | String | Required | The identifier of the view that will be run, for example SysDocumentsAll. |
The output parameters from SEARCH_DOCUMENTS are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| searchDocumentsResult | JSON | Optional | A list of documents that meet the search criteria. |