Get the Documents information

GET /api/2.0/files/info

Request

Returns the information about the Documents module.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Examples

GET /api/2.0/files/info HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/files/info \
  --header 'Accept: application/json'

Responses

200

Module information: ID, product class name, title, description, icon URL, large icon URL, start URL, primary or nor, help URL

idstringformat: uuid

ID

appNamestring

Product class name

titlestring

Title

linkstring

Start link

iconUrlstring

Icon URL

imageUrlstring

Large image URL

helpUrlstring

Help URL

descriptionstring

Description

isPrimaryboolean

Specifies if the module is primary or not

401

Unauthorized