settings/documentformats/profiles/{id}/formats

Gets all the document format configurations added to a profile.

This API method is available from September 2021

URL

(GET) /api/settings/documentformats/profiles/{id}/formats?enabledOnly=

PARAMETERS

The URL parameters are:

id

The profile ID.

See settings/documentformats/profiles/list to enumerate all profiles.

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

RESULTS

The result is a JSON array with the file fomats and configurations in the profile:

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

EXAMPLES

Excerpt of profile options:

[
    {
        "id": 5362,
        "name": "Default",
        "enabled": true,
        "domain": "FRAMEMAKER",
        "domaint": "Adobe FrameMaker"
    },
    {
        "id": 5162,
        "name": "Default - special",
        "enabled": true,
        "domain": "FRAMEMAKER",
        "domaint": "Adobe FrameMaker"
    },
    {
        "id": 5373,
        "name": "Default",
        "enabled": true,
        "domain": "INCOPY",
        "domaint": "Adobe InCopy"
    },
    {
        "id": 5355,
        "name": "Default",
        "enabled": true,
        "domain": "INDESIGN",
        "domaint": "Adobe InDesign"
    },
    {
        "id": 5358,
        "name": "Default",
        "enabled": true,
        "domain": "PHOTOSHOP",
        "domaint": "Adobe Photoshop"
    },
    
    ....
]