settings/documentformats/projects/{pid}/formats

Gets all document format configurations available in a project.

These are either the parsers from the document format profile which is assigned to the project, or the parsers from the default document format profile (the first alphabetically).

This API method is available from May 2025

URL

^{(GET) /api/settings/documentformats/projects/{pid}/formats?enabledOnly=&}

PARAMETERS

The URL parameters are:

pid

A project ID.

int, Mandatory

enabledOnly

Optional filter. Default is true.

true: Only list configurations actually added to the profile.
false: Print all file types even if no configuration is enabled in the profile. This allows to see which file types are disabled.

bool, Optional

extension

An optional extension to filter only the formats that support processing that extension.

Example: .docx, .XLS, ...

string, Optional

RESULTS

The result is a JSON array with the compatible parser configurations:

id	The document format configuration ID. Download the configuration using: settings/documentformats/configs/{id}	int
name	The name of the profile.
domain	The file format code such as "MSWORD" or "XML". See File formats	string
domaint	The file type name such as "Microsoft Word" or "XML".	string
enabled	False if no configuration for the domain above exists in the profile. True otherwise. Disabled rows are only included if parameter enabledOnly is false. Note: A profile can contain multiple configurations (options) for the same file type.	bool
extensions	List of extensions supported by this configuration.

EXAMPLES

Excerpt of profile options:

CODE

[
  {
    "id": 7327,
    "name": "Default",
    "enabled": true,
    "domain": "IMAGES",
    "domaint": "Image files",
    "extensions": [
        ".jpg",
        ".jpeg",
        ".png",
        ".bmp",
        ".gif"
    ]
  },
  {
    "id": 7136,
    "name": "Word Default",
    "enabled": true,
    "domain": "MSWORD",
    "domaint": "Microsoft Word",
    "extensions": [
        ".doc",
        ".docx",
        ".dot",
        ".dotx",
        ".docm",
        ".dotm"
    ]
  }
]