getFormsFolder
FolderContentWrapper getFormsFolder(userIdOrGroupId, filterType, count, startIndex, sortBy, sortOrder, filterValue)
GET /api/2.0/files/@forms
Get the Forms section
Returns the Forms section: the flat list of form-filling rooms the caller may read. Such rooms are stored under the Rooms tree but are surfaced only here, so GET api/2.0/files/rooms leaves them out of the active area and lists them when searchArea names the forms area instead. The section is not expanded into room content, so folders carries the rooms while files comes back empty; to read what is inside one of them, call GET api/2.0/files/{folderId} with the room identifier. Nothing is modified, though passing sortBy saves the requested order as the default order for this account. filterType, filterValue, userIdOrGroupId and the sorting parameters narrow and order the room list, count and startIndex page through it, total reports how many rooms match the request in full, and current describes the section folder itself.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| userIdOrGroupId | query | UUID (uuid) | Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read. | [optional] [example: 00000000-0000-0000-0000-000000000000] |
| filterType | query | FilterType | Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds. | [optional] [example: 1] [enum: 0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 17, 20, 22, 23, 24, 25, 26] |
| count | query | Integer (int32) | The size of one page of section content. Pair it with startIndex to walk the listing, and compare the two with total in the response to see when the last page has been read. | [optional] [example: 25] [min: 1] [max: 100] |
| startIndex | query | Integer (int32) | The number of matching entries to skip before the returned page begins; add count to it to ask for the next page. | [optional] [example: 0] |
| sortBy | query | String | The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: DateAndTime, AZ, Size, Author, Type, New, DateAndTimeCreation, RoomType, Tags, Room, CustomOrder, LastOpened and UsedSpace. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place. | [optional] [example: DateAndTime] |
| sortOrder | query | SortOrder | The direction in which the sortBy field is ordered. It is saved together with sortBy as the default order of the account. | [optional] [example: 1] [enum: 0, 1] |
| filterValue | query | String | The search string the section is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the section unfiltered. | [optional] [example: My Document] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The Forms section with one page of the form-filling rooms available to the caller | FolderContentWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | A parameter has the wrong type, the count is outside its allowed range, or the startIndex is negative | - | - |
| 403 | The caller is not allowed to read the Forms section | - | - |
| 404 | The Forms section could not be resolved for this account | - | - |
| 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: Not defined
- Accept: application/json