searchFolder
FolderContentWrapper searchFolder(folderId, FolderMetadataSearch)
POST /api/2.0/files/{folderId}/search
Search a folder by metadata
Searches the folder by metadata. The same filter the folder listing takes in the metadataTemplateId and metadataFilters query parameters, here as a typed request body for the clients that build the conditions as objects rather than as a JSON string.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| folderId | path | Integer (int32) | The folder ID. | [required] [example: 1] |
| FolderMetadataSearch | body | FolderMetadataSearch | The search parameters. | [required] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | Folder contents | FolderContentWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | Invalid metadata filter, or a metadata filter on a section that cannot apply it | - | - |
| 403 | You don't have enough permission to view the folder content | - | - |
| 404 | The required folder was not found | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Third-party storage
For a file or folder in a connected third-party storage the identifier is a string such as sbox-42, and the call differs in these parts only:
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| folderId | path | String | The folder ID. | [required] [example: sbox-42] |
Return type: ThirdPartyFolderContentWrapper
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json