Skip to main content

getFilesModule

ModuleWrapper getFilesModule()

GET /api/2.0/files/info

Get the Documents module information

Returns the descriptor of the Documents module of this portal: its identifier, display title and description, the address of its start page, the icon and image addresses, the address of its help section, and whether it is the portal's primary module. It is meant for building navigation to the module, not for working with documents: nothing about files, rooms or permissions comes back, and nothing is changed by the call. The values follow the portal's own configuration and branding, so the title and the description arrive already translated for the caller. Any authenticated role down to a guest may read it; an unauthenticated caller is refused. The content is the same for everyone in the portal and changes only when the portal is reconfigured, so it can be fetched once and cached rather than requested per screen. Only the Documents module is described here; this document carries no listing of the other modules of the portal. The file-related configuration a client needs alongside it - the format tables, the editor addresses and the upload limits - comes from GET api/2.0/files/settings.

Parameters​

This endpoint does not need any parameter.

Responses​

Status codeDescriptionTypeResponse headers
200The descriptor of the Documents module: identifier, title, description, icon and start addressesModuleWrapperX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
401UnauthorizedErrorApiResponse-
429Too Many Requests.ErrorApiResponseRetry-After
500Internal Server Error.ErrorApiResponse-
502Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON.--
503Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON.--

Return type​

ModuleWrapper

Authorization​

Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json