searchRooms
FolderContentWrapper searchRooms(RoomsMetadataSearchRequestDto)
POST /api/2.0/files/rooms/search
Search the rooms by metadata
Searches the rooms by metadata. The same filter the rooms 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 |
|---|---|---|---|---|
| RoomsMetadataSearchRequestDto | body | RoomsMetadataSearchRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | Returns the matching rooms of the section | FolderContentWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | Invalid metadata filter | - | - |
| 403 | You don't have enough permission to view the room content | - | - |
| 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
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json